Main Page Class Hierarchy Compound List File List Compound Members

csPixelFormat Struct Reference

Structure describing the pixel format. More...

#include <graph2d.h>

List of all members.

Public Methods

void complete ()

Little helper function to complete a csPixelFormat structure given that the masks are correctly filled in.

Public Attributes

uint32 RedMask

The masks to extract the color information from a pixel (truecolor mode only). More...

uint32 GreenMask

The masks to extract the color information from a pixel (truecolor mode only). More...

uint32 BlueMask

The masks to extract the color information from a pixel (truecolor mode only). More...

int RedShift

The shifts to extract the color information from a pixel (truecolor mode only).

int GreenShift

The shifts to extract the color information from a pixel (truecolor mode only).

int BlueShift

The shifts to extract the color information from a pixel (truecolor mode only).

int RedBits

The number of significant bits for every color.

int GreenBits

The number of significant bits for every color.

int BlueBits

The number of significant bits for every color.

int PalEntries

Number of palette entries. More...

int PixelBytes

Number of bytes for every pixel. More...

Detailed Description

Structure describing the pixel format.

Member Data Documentation

uint32 csPixelFormat::BlueMask

The masks to extract the color information from a pixel (truecolor mode only).
Currently only masks for 16-bit/15-bit colors are supported. Ignore the Mask and Shift fields of this structure if PalEntries != 0.

uint32 csPixelFormat::GreenMask

The masks to extract the color information from a pixel (truecolor mode only).
Currently only masks for 16-bit/15-bit colors are supported. Ignore the Mask and Shift fields of this structure if PalEntries != 0.

int csPixelFormat::PalEntries

Number of palette entries.
0 for truecolor, else the number of palette entries (this number should be equal to 256 even if not all of these 256 colors can be modified (like is the case in Windows)). Currently only 0 and 256 are supported here.

int csPixelFormat::PixelBytes

Number of bytes for every pixel.
The only supported values currently are:

1: for palette mode (256 palette entries)
2: for truecolor 15/16-bit mode (no palette entries)
4: for truecolor 32-bit mode (no palette entries)

uint32 csPixelFormat::RedMask

The masks to extract the color information from a pixel (truecolor mode only).
Currently only masks for 16-bit/15-bit colors are supported. Ignore the Mask and Shift fields of this structure if PalEntries != 0.

The documentation for this struct was generated from the following file:

graph2d.h