pixel_format.h

Go to the documentation of this file.

/*
**  ClanLib SDK
**  Copyright (c) 1997-2009 The ClanLib Team
**
**  This software is provided 'as-is', without any express or implied
**  warranty.  In no event will the authors be held liable for any damages
**  arising from the use of this software.
**
**  Permission is granted to anyone to use this software for any purpose,
**  including commercial applications, and to alter it and redistribute it
**  freely, subject to the following restrictions:
**
**  1. The origin of this software must not be misrepresented; you must not
**     claim that you wrote the original software. If you use this software
**     in a product, an acknowledgment in the product documentation would be
**     appreciated but is not required.
**  2. Altered source versions must be plainly marked as such, and must not be
**     misrepresented as being the original software.
**  3. This notice may not be removed or altered from any source distribution.
**
**  Note: Some of the libraries ClanLib may link to may have additional
**  requirements or restrictions.
**
**  File Author(s):
**
**    Magnus Norddahl
*/


#pragma once

#include "../api_display.h"
#include "pixel_format_type.h"

class CL_API_DISPLAY CL_PixelFormat
{

public:
        CL_PixelFormat();

        CL_PixelFormat(const CL_PixelFormat &copy);

        CL_PixelFormat(
                int depth,
                unsigned int red_mask,
                unsigned int green_mask,
                unsigned int blue_mask,
                unsigned int alpha_mask = 0,
                bool use_colorkey = false,
                unsigned int colorkey = 0,
                CL_PixelFormatType type = pixelformat_rgba);


public:
        bool operator ==(const CL_PixelFormat &other) const;

        bool operator !=(const CL_PixelFormat &other) const;

        CL_PixelFormatType get_type() const { return type; }

        bool has_colorkey() const { return colorkey_enabled; }

        int get_depth() const { return depth; }

        unsigned int get_colorkey() const { return colorkey; }

        unsigned int get_red_mask() const { return red_mask; }

        unsigned int get_green_mask() const { return green_mask; }

        unsigned int get_blue_mask() const { return blue_mask; }

        unsigned int get_alpha_mask() const { return alpha_mask; }


public:

        static CL_PixelFormat rgba8888;


        static CL_PixelFormat argb8888;


        static CL_PixelFormat rgb888;


        static CL_PixelFormat rgba4444;


        static CL_PixelFormat rgb555;


        static CL_PixelFormat rgb565;


        static CL_PixelFormat abgr8888;


        static CL_PixelFormat bgr888;


        static CL_PixelFormat abgr4444;


        static CL_PixelFormat bgr555;


        static CL_PixelFormat bgr565;

        static int get_mask_shift(unsigned int mask);

        static int get_mask_bits(unsigned int mask);

        static unsigned int get_bitmask(int bits, int shift);


public:
        void set_type(CL_PixelFormatType new_type) { type = new_type; }

        void enable_colorkey(bool enable = true) { colorkey_enabled = enable; }

        void set_colorkey(unsigned int i) { colorkey = i; }

        void set_depth(int i) { depth = i; }

        void set_red_mask(unsigned int i) { red_mask = i; }

        void set_green_mask(unsigned int i) { green_mask = i; }

        void set_blue_mask(unsigned int i) { blue_mask = i; }

        void set_alpha_mask(unsigned int i) { alpha_mask = i; }


private:
        CL_PixelFormatType type;

        bool colorkey_enabled;

        unsigned int colorkey;

        unsigned int red_mask;

        unsigned int green_mask;

        unsigned int blue_mask;

        unsigned int alpha_mask;

        int depth;
};

---