/*
** ClanLib SDK
** Copyright (c) 1997-2005 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
** (if your name is missing here, please add it)
*/
//! clanDisplay="Display 2D"
//! header=display.h
#ifndef header_pixelformat
#define header_pixelformat
#ifdef CL_API_DLL
#ifdef CL_DISPLAY_EXPORT
#define CL_API_DISPLAY __declspec(dllexport)
#else
#define CL_API_DISPLAY __declspec(dllimport)
#endif
#else
#define CL_API_DISPLAY
#endif
#if _MSC_VER > 1000
#pragma once
#endif
#include "pixel_format_type.h"
//: Pixel data format description.
//- !group=Display/Display 2D!
//- !header=display.h!
class CL_API_DISPLAY CL_PixelFormat
{
//! Construction:
public:
//: Constructs a pixel format description.
//param depth: Bits per pixel.
//param red_mask: Red color mask.
//param green_mask: Green color mask.
//param blue_mask: Blue color mask.
//param alpha_mask: Alpha transparency mask.
//param use_colorkey: True if source color key transparency is used (single color transparency).
//param colorkey: Source color key (pixel value that means transparent).
CL_PixelFormat();
CL_PixelFormat(const CL_PixelFormat ©);
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);
//! Attributes:
public:
//: Returns true if this pixel format is the same as the other one.
bool operator ==(const CL_PixelFormat &other) const;
//: Returns true if this pixel format is not the same as the other one.
bool operator !=(const CL_PixelFormat &other) const;
//: Returns the pixel format type (RGB or Indexed).
CL_PixelFormatType get_type() const { return type; }
//: Returns true if format uses a source color key.
bool has_colorkey() const { return colorkey_enabled; }
//: Returns the depth of the pixel format.
int get_depth() const { return depth; }
//: Returns the source color key.
unsigned int get_colorkey() const { return colorkey; }
//: Returns the red component color mask.
unsigned int get_red_mask() const { return red_mask; }
//: Returns the green component color mask.
unsigned int get_green_mask() const { return green_mask; }
//: Returns the blue component color mask.
unsigned int get_blue_mask() const { return blue_mask; }
//: Returns the alpha component color mask.
unsigned int get_alpha_mask() const { return alpha_mask; }
//! Statics:
public:
//: Pixel format with 32 bit depth, 8 bits per color mask.
//-
//- | red mask | = | 0xff000000 |
//- | green mask | = | 0x00ff0000 |
//- | blue mask | = | 0x0000ff00 |
//- | alpha mask | = | 0x000000ff |
//-
static CL_PixelFormat rgba8888;
//: Pixel format with 24 bit depth, 8 bits per color mask, no alpha.
//-
//- | red mask | = | 0xff0000 |
//- | green mask | = | 0x00ff00 |
//- | blue mask | = | 0x0000ff |
//-
static CL_PixelFormat rgb888;
//: Pixel format with 16 bit depth, 4 bits per color mask.
//-
//- | red mask | = | 0xf000 |
//- | green mask | = | 0x0f00 |
//- | blue mask | = | 0x00f0 |
//- | alpha mask | = | 0x000f |
//-
static CL_PixelFormat rgba4444;
//: Pixel format with 16 bit depth, 5 bits per color mask, one bit unused.
//-
//- | red mask | = | 0x7c00 |
//- | green mask | = | 0x03e0 |
//- | blue mask | = | 0x001f |
//- | alpha mask | = | 0x0000 |
//-
static CL_PixelFormat rgb555;
//: Pixel format with 16 bit depth, 5 bits for red and blue, 6 bits for green.
//-
//- | red mask | = | 0xf800 |
//- | green mask | = | 0x07e0 |
//- | blue mask | = | 0x001f |
//- | alpha mask | = | 0x0000 |
//-
static CL_PixelFormat rgb565;
//: Pixel format with 32 bit depth, 8 bits per color mask.
//-
//- | red mask | = | 0x000000ff |
//- | green mask | = | 0x0000ff00 |
//- | blue mask | = | 0x00ff0000 |
//- | alpha mask | = | 0xff000000 |
//-
static CL_PixelFormat abgr8888;
//: Pixel format with 24 bit depth, 8 bits per color mask, no alpha.
//-
//- | red mask | = | 0x0000ff |
//- | green mask | = | 0x00ff00 |
//- | blue mask | = | 0xff0000 |
//-
static CL_PixelFormat bgr888;
//: Pixel format with 16 bit depth, 4 bits per color mask.
//-
//- | red mask | = | 0x000f |
//- | green mask | = | 0x00f0 |
//- | blue mask | = | 0x0f00 |
//- | alpha mask | = | 0xf000 |
//-
static CL_PixelFormat abgr4444;
//: Pixel format with 16 bit depth, 5 bits per color mask, one bit unused.
//-
//- | red mask | = | 0x001f |
//- | green mask | = | 0x03e0 |
//- | blue mask | = | 0x7c00 |
//- | alpha mask | = | 0x0000 |
//-
static CL_PixelFormat bgr555;
//: Pixel format with 16 bit depth, 5 bits for red and blue, 6 bits for green.
//-
//- | red mask | = | 0x001f |
//- | green mask | = | 0x07e0 |
//- | blue mask | = | 0xf800 |
//- | alpha mask | = | 0x0000 |
//-
static CL_PixelFormat bgr565;
//: Returns the shift of a color mask.
static int get_mask_shift(unsigned int mask);
//: Returns the bit count of a color mask.
static int get_mask_bits(unsigned int mask);
//: Returns the color mask based on bit count and shift.
static unsigned int get_bitmask(int bits, int shift);
//! Operations:
public:
//: Sets the pixel format type (RGB or Indexed).
void set_type(CL_PixelFormatType new_type) { type = new_type; }
//: Enable/disable color key.
void enable_colorkey(bool enable = true) { colorkey_enabled = enable; }
//: Sets the color key.
void set_colorkey(unsigned int i) { colorkey = i; }
//: Sets the depth of the pixel format.
void set_depth(int i) { depth = i; }
//: Sets the red component color mask.
void set_red_mask(unsigned int i) { red_mask = i; }
//: Sets the green component color mask.
void set_green_mask(unsigned int i) { green_mask = i; }
//: Sets the blue component color mask.
void set_blue_mask(unsigned int i) { blue_mask = i; }
//: Sets the alpha component color mask.
void set_alpha_mask(unsigned int i) { alpha_mask = i; }
//! Implementation:
private:
//: Pixel format type.
CL_PixelFormatType type;
//: True if colorkeying is enabled in the pixel format.
bool colorkey_enabled;
//: Colorkey value, if enabled.
unsigned int colorkey;
//: Bitmask marking the red component in a pixel.
unsigned int red_mask;
//: Bitmask marking the green component in a pixel.
unsigned int green_mask;
//: Bitmask marking the blue component in a pixel.
unsigned int blue_mask;
//: Bitmask marking the alpha component in a pixel.
unsigned int alpha_mask;
//: Bitdepth of a pixel.
int depth;
};
#endif