---

pixelformat.h

Go to the documentation of this file.

/*
        $Id: pixelformat.h,v 1.1 2001/03/06 15:09:10 mbn Exp $

        ------------------------------------------------------------------------
        ClanLib, the platform independent game SDK.

        This library is distributed under the GNU LIBRARY GENERAL PUBLIC LICENSE
        version 2. See COPYING for details.

        For a total list of contributers see CREDITS.

        ------------------------------------------------------------------------
*/


#ifndef header_pixelformat
#define header_pixelformat

class CL_Target;

enum EPixelFormat
//: Pixelformat types available.
{
        PAL8,
//: Palettelized 8 bpp mode.
        
        RGB565,
//: Red-green-blue, using depth 565, 16 bpp.
        
        RGBA4444,
//: Red-green-blue-alpha, using depth 4444, 16 bpp.

        RGBA5551,
//: Red-green-blue-alpha, using depth 5551, 16 bpp.

        RGB888,
//: Red-green-blue, using depth 888, 24 bpp.

        RGBA8888,
//: Red-green-blue-alpha, using depth 8888, 32 bpp.
};

class CL_Color
//: This class provides methods that deal with colors, 
// including the ability to find color-component bit
// masks for particular pixel formats. Also you can 
// use this class to get colors, in any of the
// different pixel formats,  from the color components 
// (Red, Blue, Green and Alpha).<p>
// Often you can specify color components as either
// integers or floating points (the component value 
// divided by it's maximum possible value.)
{
public:
        static unsigned int get_red_mask(EPixelFormat pixelformat);
        //: Returns the bit mask for red using the given pixel format.

        static unsigned int get_green_mask(EPixelFormat pixelformat);
        //: Returns the bit mask for green using the given pixel format.

        static unsigned int get_blue_mask(EPixelFormat pixelformat);
        //: Returns the bit mask for blue using the given pixel format.

        static unsigned int get_alpha_mask(EPixelFormat pixelformat);
        //: Returns the bit mask for alpha using the given pixel format.

        static unsigned int get_color(EPixelFormat fmt, int r, int g, int b, int a=255);
        //: Converts separate red, blue, green and alpha  integer values into a color value

        static unsigned int get_color(EPixelFormat fmt, float r, float g, float b, float a=1.0);
        //: Converts separate red, blue, green and alpha floating
        //: point values into a single color value

        static unsigned int get_color(unsigned int rmask, 
                                      unsigned int gmask, 
                                      unsigned int bmask, 
                                      unsigned int amask, 
                                      int r, int g, int b, int a=255);
        //: Returns the color value in a format you specify
        //: by giving the red, green, blue and alpha
        //: masks, along with the corresponding red, blue,
        //: green and alpha values.

        static unsigned int get_color(unsigned int rmask, 
                                      unsigned int gmask, 
                                      unsigned int bmask, 
                                      unsigned int amask, 
                                      float r, float g, float b, float a=1.0);
        //: Returns the color value in a format you specify
        //: by giving the red, green, blue and alpha
        //: masks, along with the corresponding red, blue,
        //: green and alpha values.
        


        static unsigned int get_color(CL_Target* target,
                                      int r, int g, int b, int a=255);
        //: Returns the color value for the specified
        //: red, blue and green integer components,
        //: in the  same pixel format as the target.

        static unsigned int get_color(CL_Target* target,
                                      float r, float g, float b, float a=1.0);
        //: Returns the color value for the specified 
        //: red, blue and green floating point components
        //: in the same pixel format as the target.

        static float get_color(unsigned int cmask, int color);
        //: Takes a color, extracts the color component 
        // (red, green, blue or alpha) specified by cmask, and
        // returns it as a floating point. (The floating point
        // value is the amount of the color component divided by
        // that color component's maximum value.)  
        // <p> For example:
        // <p> If the red component has a maximum value of 255,
        // and the red component of your color was 200, the floating
        // point returned would be  200/255 or 0.7843

};

#endif

---