OSDL::Video::Pixels

OSDL::Video::Pixels Namespace Reference

Detailed Description

Allows to handle the various pixel colors and formats.

Various conversion functions are provided, when no canonic operator can be used.

For example, comparing two PixelColor instances can be done directly thanks to the '==' operator, provided they respect the same pixel format.


Typedefs

typedef SDL_PixelFormat PixelFormat
 Describes a pixel format.
typedef SDL_Color ColorDefinition
 Format-independent color description.
typedef Ceylan::Uint32 PixelColor
 Corresponds to an actual pixel color, i.e.
typedef Ceylan::Uint32 ColorMask
 Corresponds to a bit mask which allows to define how to get color coordinates from a PixelColor, for example depending on the endianness of the system.
typedef Ceylan::Uint8 ColorElement
 Describes a coordinate used in color space, including alpha.
typedef Ceylan::Float32 GammaFactor
 Gamma controls the brightness/contrast of colors displayed on the screen.
typedef Ceylan::Uint16 GammaRampElement
 A color element of a gamma ramp.

Functions

bool setGamma (GammaFactor red, GammaFactor green, GammaFactor blue) throw ()
 Sets the "gamma function" for the display of each color component.
OSDL_DLL bool setGammaRamp (GammaRampElement *redRamp, GammaRampElement *greenRamp, GammaRampElement *blueRamp) throw ()
 Sets the gamma lookup tables for the display for each color component.
OSDL_DLL bool getGammaRamp (GammaRampElement *redRamp, GammaRampElement *greenRamp, GammaRampElement *blueRamp) throw ()
 Gets the color gamma lookup tables for the display.
OSDL_DLL void getRecommendedColorMasks (ColorMask &redMask, ColorMask &greenMask, ColorMask &blueMask, ColorMask &alphaMask) throw ()
 Returns the RBGA masks which are recommended on this platform : the endianness is taken into account, regardless of any specific pixel format.
OSDL_DLL void getRecommendedColorMasks (ColorMask &redMask, ColorMask &greenMask, ColorMask &blueMask) throw ()
 Returns the RBG masks which are recommended on this platform : the endianness is taken into account, regardless of any specific pixel format.
OSDL_DLL void getCurrentColorMasks (const PixelFormat &format, ColorMask &redMask, ColorMask &greenMask, ColorMask &blueMask, ColorMask &alphaMask) throw ()
 Reads from specified pixel format the RBGA masks, and returns them by updating specified color mask references.
OSDL_DLL ColorDefinition convertRGBAToColorDefinition (ColorElement red, ColorElement green, ColorElement blue, ColorElement alpha=AlphaOpaque) throw ()
 Converts a set of four coordinates in RGBA color space to the equivalent ColorDefinition.
OSDL_DLL void convertColorDefinitionToRGBA (ColorDefinition color, ColorElement &red, ColorElement &green, ColorElement &blue, ColorElement &alpha) throw ()
 Updates provided RGBA quadruplet from the specified color definition.
OSDL_DLL PixelColor convertRGBAToPixelColor (const PixelFormat &format, ColorElement red, ColorElement green, ColorElement blue, ColorElement alpha=AlphaOpaque) throw ()
 Converts a set of four coordinates in RGBA color space to a PixelColor, using specified format.
OSDL_DLL ColorDefinition convertPixelColorToColorDefinition (const PixelFormat &format, PixelColor pixel) throw ()
 Returns RGBA quadruplet corresponding to specified pixel, encoded according to specified pixel format.
OSDL_DLL PixelColor convertColorDefinitionToPixelColor (const PixelFormat &format, ColorDefinition colorDef) throw ()
 Converts a set of four coordinates in RGBA color space, expressed as a color definition, to a PixelColor, using specified surface format.
OSDL_DLL PixelColor convertColorDefinitionToRawPixelColor (ColorDefinition colorDef) throw ()
 Converts a color definition to a raw PixelColor, regardless of any pixel format.
OSDL_DLL PixelColor convertRGBAToRawPixelColor (ColorElement red, ColorElement green, ColorElement blue, ColorElement alpha=AlphaOpaque) throw ()
 Converts a RGBA raw color into a raw PixelColor, with no pixel format mapping.
OSDL_DLL bool areEqual (ColorDefinition first, ColorDefinition second, bool useAlpha=true) throw ()
 Returns whether the two color definitions describe the exact same color.
OSDL_DLL bool isLess (ColorDefinition value, ColorDefinition comparison) throw ()
 Returns whether value is strictly less than comparison, by defining an arbitrary order in color coordinates.
OSDL_DLL bool areEqual (PixelColor first, PixelColor second) throw ()
 Returns whether the two pixel colors describe the exact same color, supposing that the two pixel colors are defined according to the same pixel format.
OSDL_DLL ColorDefinition selectColorDifferentFrom (ColorDefinition first, ColorDefinition second) throw ()
 Returns a color definition which is chosen different from the specified ones.
OSDL_DLL ColorDefinition selectColorDifferentFrom (ColorDefinition first, ColorDefinition second, ColorDefinition third) throw ()
 Returns a color definition which is different from the specified ones.
OSDL_DLL PixelColor getPixelColor (const Surface &fromSurface, Coordinate x, Coordinate y) throw ( VideoException )
 Returns the pixel color at [x;y].
OSDL_DLL ColorDefinition getColorDefinition (const Surface &fromSurface, Coordinate x, Coordinate y) throw ( VideoException )
 Returns the color definition of pixel at [x;y].
OSDL_DLL void putRGBAPixel (Surface &targetSurface, Coordinate x, Coordinate y, ColorElement red, ColorElement green, ColorElement blue, ColorElement alpha=AlphaOpaque, bool blending=true, bool clipping=true, bool locking=false) throw ( VideoException )
 Puts specified pixel at [x;y] with the given color, specified as separate RGBA coordinates.
OSDL_DLL void putColorDefinition (Surface &targetSurface, Coordinate x, Coordinate y, ColorDefinition colorDef, bool blending=true, bool clipping=true, bool locking=false) throw ( VideoException )
 Puts the specified pixel at [x;y] with the given color, specified as a RGBA color definition, not as a pixel color already encoded according to the pixel format of target surface.
OSDL_DLL void putPixelColor (Surface &targetSurface, Coordinate x, Coordinate y, PixelColor convertedColor, ColorElement alpha, bool blending=true, bool clipping=true, bool locking=false) throw ( VideoException )
 Puts the pixel at [x;y] with the given color, specified as a 32-bit RGBA pixel color, already encoded according to Surface's pixel format.
OSDL_DLL void alternativePutPixelColor (Surface &targetSurface, Coordinate x, Coordinate y, PixelColor color, bool mapToSurfaceFormat=false) throw ()
 Alternative method to set the pixel at [x;y] to the given pixel color.
OSDL_DLL std::string toString (const PixelFormat &format) throw ()
 Returns a textual representation of the specified pixel format.
OSDL_DLL std::string toString (PixelColor pixel, const PixelFormat &format) throw ()
 Returns a textual representation of the specified color, according to the specified pixel format.
OSDL_DLL std::string toString (ColorDefinition color) throw ()
 Returns a textual representation of the specified color definition.

Variables

const ColorElement AlphaTransparent = 0
 The alpha coordinate which corresponds to transparent pixels.
const ColorElement AlphaOpaque = 255
 The alpha coordinate which corresponds to opaque (solid) pixels.
OSDL_DLL const ColorDefinition Transparent
 Transparent color (alpha set to not opaque at all).
OSDL_DLL const ColorDefinition Black
 Shades of Grey :.
OSDL_DLL const ColorDefinition Grey
OSDL_DLL const ColorDefinition DimGrey
OSDL_DLL const ColorDefinition LightGrey
OSDL_DLL const ColorDefinition SlateGrey
OSDL_DLL const ColorDefinition Silver
OSDL_DLL const ColorDefinition AliceBlue
 Shades of Blue :.
OSDL_DLL const ColorDefinition BlueViolet
OSDL_DLL const ColorDefinition CadetBlue
OSDL_DLL const ColorDefinition DarkSlateBlue
OSDL_DLL const ColorDefinition DarkTurquoise
OSDL_DLL const ColorDefinition DeepSkyBlue
OSDL_DLL const ColorDefinition DodgerBlue
OSDL_DLL const ColorDefinition LightBlue
OSDL_DLL const ColorDefinition LightCyan
OSDL_DLL const ColorDefinition MediumBlue
OSDL_DLL const ColorDefinition NavyBlue
OSDL_DLL const ColorDefinition RoyalBlue
OSDL_DLL const ColorDefinition SkyBlue
OSDL_DLL const ColorDefinition SlateBlue
OSDL_DLL const ColorDefinition SteelBlue
OSDL_DLL const ColorDefinition Aquamarine
OSDL_DLL const ColorDefinition Azure
OSDL_DLL const ColorDefinition Blue
OSDL_DLL const ColorDefinition Cyan
OSDL_DLL const ColorDefinition Turquoise
OSDL_DLL const ColorDefinition MidnightBlue
OSDL_DLL const ColorDefinition Brown
 Shades of Brown :.
OSDL_DLL const ColorDefinition RosyBrown
OSDL_DLL const ColorDefinition SaddleBrown
OSDL_DLL const ColorDefinition Beige
OSDL_DLL const ColorDefinition Burlywood
OSDL_DLL const ColorDefinition Chocolate
OSDL_DLL const ColorDefinition Peru
OSDL_DLL const ColorDefinition Tan
OSDL_DLL const ColorDefinition Copper
OSDL_DLL const ColorDefinition DarkGreen
 Shades of Green :.
OSDL_DLL const ColorDefinition DarkOliveGreen
OSDL_DLL const ColorDefinition ForestGreen
OSDL_DLL const ColorDefinition GreenYellow
OSDL_DLL const ColorDefinition LawnGreen
OSDL_DLL const ColorDefinition LimeGreen
OSDL_DLL const ColorDefinition MintCream
OSDL_DLL const ColorDefinition OliveDrab
OSDL_DLL const ColorDefinition PaleGreen
OSDL_DLL const ColorDefinition SeaGreen
OSDL_DLL const ColorDefinition SpringGreen
OSDL_DLL const ColorDefinition YellowGreen
OSDL_DLL const ColorDefinition Chartreuse
OSDL_DLL const ColorDefinition Green
OSDL_DLL const ColorDefinition Khaki
OSDL_DLL const ColorDefinition DarkOrange
 Shades of Orange :.
OSDL_DLL const ColorDefinition DarkSalmon
OSDL_DLL const ColorDefinition LightCoral
OSDL_DLL const ColorDefinition LightSalmon
OSDL_DLL const ColorDefinition PeachPuff
OSDL_DLL const ColorDefinition Bisque
OSDL_DLL const ColorDefinition Coral
OSDL_DLL const ColorDefinition Honeydew
OSDL_DLL const ColorDefinition Orange
OSDL_DLL const ColorDefinition Salmon
OSDL_DLL const ColorDefinition Sienna
OSDL_DLL const ColorDefinition DeepPink
 Shades of Red :.
OSDL_DLL const ColorDefinition HotPink
OSDL_DLL const ColorDefinition IndianRed
OSDL_DLL const ColorDefinition LightPink
OSDL_DLL const ColorDefinition MediumVioletRed
OSDL_DLL const ColorDefinition MistyRose
OSDL_DLL const ColorDefinition OrangeRed
OSDL_DLL const ColorDefinition VioletRed
OSDL_DLL const ColorDefinition Firebrick
OSDL_DLL const ColorDefinition Pink
OSDL_DLL const ColorDefinition Red
OSDL_DLL const ColorDefinition Tomato
OSDL_DLL const ColorDefinition DarkOrchid
 Shades of Violet :.
OSDL_DLL const ColorDefinition DarkViolet
OSDL_DLL const ColorDefinition LavenderBlush
OSDL_DLL const ColorDefinition MediumOrchid
OSDL_DLL const ColorDefinition MediumPurple
OSDL_DLL const ColorDefinition Lavender
OSDL_DLL const ColorDefinition Magenta
OSDL_DLL const ColorDefinition Maroon
OSDL_DLL const ColorDefinition Orchid
OSDL_DLL const ColorDefinition Plum
OSDL_DLL const ColorDefinition Purple
OSDL_DLL const ColorDefinition Thistle
OSDL_DLL const ColorDefinition Violet
OSDL_DLL const ColorDefinition AntiqueWhite
 Shades of White :.
OSDL_DLL const ColorDefinition FloralWhite
OSDL_DLL const ColorDefinition GhostWhite
OSDL_DLL const ColorDefinition NavajoWhite
OSDL_DLL const ColorDefinition OldLace
OSDL_DLL const ColorDefinition WhiteSmoke
OSDL_DLL const ColorDefinition Gainsboro
OSDL_DLL const ColorDefinition Ivory
OSDL_DLL const ColorDefinition Linen
OSDL_DLL const ColorDefinition Seashell
OSDL_DLL const ColorDefinition Snow
OSDL_DLL const ColorDefinition Wheat
OSDL_DLL const ColorDefinition White
OSDL_DLL const ColorDefinition BlanchedAlmond
 Shades of Yellow :.
OSDL_DLL const ColorDefinition DarkGoldenrod
OSDL_DLL const ColorDefinition LemonChiffon
OSDL_DLL const ColorDefinition LightGoldenrod
OSDL_DLL const ColorDefinition LightYellow
OSDL_DLL const ColorDefinition PaleGoldenrod
OSDL_DLL const ColorDefinition PapayaWhip
OSDL_DLL const ColorDefinition Cornsilk
OSDL_DLL const ColorDefinition Gold
OSDL_DLL const ColorDefinition Goldenrod
OSDL_DLL const ColorDefinition Moccasin
OSDL_DLL const ColorDefinition Yellow

Typedef Documentation

typedef SDL_Color OSDL::Video::Pixels::ColorDefinition

Format-independent color description.

Corresponds to the RBGA information describing a color defined in 32-bit color space, in this order : the latest coordinate is the pixel's alpha channel.

Note:
The alpha coordinate is not always taken into account and reliable.
See also:
The list of color names (ex : Pixels::RoyalBlue).

Definition at line 65 of file OSDLPixel.h.

typedef Ceylan::Uint8 OSDL::Video::Pixels::ColorElement

Describes a coordinate used in color space, including alpha.

Definition at line 90 of file OSDLPixel.h.

typedef Ceylan::Uint32 OSDL::Video::Pixels::ColorMask

Corresponds to a bit mask which allows to define how to get color coordinates from a PixelColor, for example depending on the endianness of the system.

Definition at line 83 of file OSDLPixel.h.

typedef Ceylan::Float32 OSDL::Video::Pixels::GammaFactor

Gamma controls the brightness/contrast of colors displayed on the screen.

Definition at line 118 of file OSDLPixel.h.

typedef Ceylan::Uint16 OSDL::Video::Pixels::GammaRampElement

A color element of a gamma ramp.

Definition at line 142 of file OSDLPixel.h.

typedef Ceylan::Uint32 OSDL::Video::Pixels::PixelColor

Corresponds to an actual pixel color, i.e.

a color definition which is encoded according to a pixel format.

Definition at line 73 of file OSDLPixel.h.

typedef SDL_PixelFormat OSDL::Video::Pixels::PixelFormat

Describes a pixel format.

Definition at line 48 of file OSDLPixel.h.

Function Documentation

void OSDL::Video::Pixels::alternativePutPixelColor ( Surface &  targetSurface,
Coordinate  x,
Coordinate  y,
PixelColor  color,
bool  mapToSurfaceFormat = false 
) throw ()

Alternative method to set the pixel at [x;y] to the given pixel color.

If the alpha coordinate is not AlphaOpaque, then the specified pixel will be alphablended with the pixel already present at specified location.

Parameters:
mapToSurfaceFormat tells whether the specified pixel color is to be encoded to target Surface's pixel format (if true), or if it is not wanted (if false, for example if it is already done).
Note:
This function should not be used directly, it is merely a debug method when pixel-level operations must be checked.

Definition at line 1084 of file OSDLPixel.cc.

References getRecommendedColorMasks(), and toString().

bool OSDL::Video::Pixels::areEqual ( PixelColor  first,
PixelColor  second 
) throw ()

Returns whether the two pixel colors describe the exact same color, supposing that the two pixel colors are defined according to the same pixel format.

Parameters:
first the first pixel color for the comparison.
second the second pixel definition for the comparison.
Note:
The alpha coordinate cannot be disabled or enabled, this function just compares the two values and could be directly replaced by the '==' operator.

Definition at line 742 of file OSDLPixel.cc.

Referenced by selectColorDifferentFrom().

bool OSDL::Video::Pixels::areEqual ( ColorDefinition  first,
ColorDefinition  second,
bool  useAlpha = true 
) throw ()

Returns whether the two color definitions describe the exact same color.

Parameters:
first the first color definition for the comparison.
second the second color definition for the comparison.
useAlpha tells whether the alpha coordinate is tested too for equality.

Definition at line 676 of file OSDLPixel.cc.

References toString().

Referenced by OSDL::Video::TwoDimensional::Text::FixedFont::basicRenderLatin1Glyph(), OSDL::Video::TwoDimensional::Text::TrueTypeFont::basicRenderUnicodeGlyph(), OSDL::Video::TwoDimensional::Text::Font::renderLatin1MultiLineText(), OSDL::Video::TwoDimensional::Text::TrueTypeFont::renderLatin1Text(), OSDL::Video::TwoDimensional::Text::TrueTypeFont::renderUnicodeText(), OSDL::Video::TwoDimensional::Text::TrueTypeFont::renderUTF8Text(), OSDL::Video::Surface::setAlphaForColor(), OSDL::Video::TwoDimensional::Widget::setBaseColorMode(), and OSDL::Video::TwoDimensional::BackBufferedWidget::setBaseColorMode().

PixelColor OSDL::Video::Pixels::convertColorDefinitionToPixelColor ( const PixelFormat &  format,
ColorDefinition  colorDef 
) throw ()

Converts a set of four coordinates in RGBA color space, expressed as a color definition, to a PixelColor, using specified surface format.

If the specified pixel format has no alpha component, or if a palette is used, then the alpha value will be ignored since it can be in no way be taken into account.

Definition at line 632 of file OSDLPixel.cc.

Referenced by OSDL::Video::TwoDimensional::Text::FixedFont::basicRenderLatin1Glyph(), OSDL::Video::TwoDimensional::Text::TrueTypeFont::basicRenderUnicodeGlyph(), OSDL::Video::TwoDimensional::Text::TrueTypeFont::renderLatin1Text(), OSDL::Video::TwoDimensional::Text::TrueTypeFont::renderUnicodeText(), OSDL::Video::TwoDimensional::Text::TrueTypeFont::renderUTF8Text(), OSDL::Video::TwoDimensional::Widget::setBaseColorMode(), OSDL::Video::TwoDimensional::BackBufferedWidget::setBaseColorMode(), and OSDL::Video::Palette::updatePixelColorsFrom().

PixelColor OSDL::Video::Pixels::convertColorDefinitionToRawPixelColor ( ColorDefinition  colorDef  )  throw ()

Converts a color definition to a raw PixelColor, regardless of any pixel format.

Note:
No pixel format mapping of any kind is performed, it is a transformation between two exactly similar formats, as if the pixel format was exactly 32-bit RGBA.

Definition at line 643 of file OSDLPixel.cc.

Referenced by OSDL::Video::TwoDimensional::Text::FixedFont::basicBlitLatin1Glyph(), OSDL::Video::TwoDimensional::UprightRectangle::draw(), OSDL::Video::TwoDimensional::Line::draw(), OSDL::Video::TwoDimensional::drawBezierCurve(), OSDL::Video::TwoDimensional::drawCircle(), OSDL::Video::TwoDimensional::drawEllipse(), OSDL::Video::TwoDimensional::Line::drawHorizontal(), OSDL::Video::TwoDimensional::drawPie(), OSDL::Video::TwoDimensional::drawPolygon(), OSDL::Video::TwoDimensional::drawTriangle(), OSDL::Video::TwoDimensional::Line::drawVertical(), and OSDL::Video::TwoDimensional::Text::printBasic().

void OSDL::Video::Pixels::convertColorDefinitionToRGBA ( ColorDefinition  color,
ColorElement &  red,
ColorElement &  green,
ColorElement &  blue,
ColorElement &  alpha 
) throw ()

Updates provided RGBA quadruplet from the specified color definition.

Note:
No mapping to any pixel format is performed, it is just two different ways of gathering the exact same data about color.
See also:
convertRGBAToColorDefinition, convertRGBAToPixelColor

Definition at line 581 of file OSDLPixel.cc.

ColorDefinition OSDL::Video::Pixels::convertPixelColorToColorDefinition ( const PixelFormat &  format,
PixelColor  pixel 
) throw ()

Returns RGBA quadruplet corresponding to specified pixel, encoded according to specified pixel format.

Note:
If the surface has no alpha component, the alpha will be returned as AlphaOpaque (100% opaque).

This methods uses the entire 8-bit [0..255] range when converting color components from pixel formats with less than 8-bits per RGB component (e.g., a completely white pixel in 16-bit RGB565 format would return [0xff, 0xff, 0xff] not [0xf8, 0xfc, 0xf8]).

Returns:
a ColorDefinition, from which RGBA components can be directly read (myPixelDefinition.r, myPixelDefinition.g, myPixelDefinition.b and myPixelDefinition.unused for alpha)

Definition at line 617 of file OSDLPixel.cc.

Referenced by getColorDefinition(), OSDL::Video::Surface::getColorDefinitionAt(), putPixelAlpha(), and toString().

ColorDefinition OSDL::Video::Pixels::convertRGBAToColorDefinition ( ColorElement  red,
ColorElement  green,
ColorElement  blue,
ColorElement  alpha = AlphaOpaque 
) throw ()

Converts a set of four coordinates in RGBA color space to the equivalent ColorDefinition.

Note:
If alpha coordinate is not specified (just plain RGB), the pixel will be considered as fully opaque.

No mapping to any pixel format is performed, it is just two different ways of gathering the exact same data about color.

See also:
convertColorDefinitionToRGBA, convertRGBAToPixelColor

Definition at line 564 of file OSDLPixel.cc.

Referenced by OSDL::Video::TwoDimensional::UprightRectangle::draw(), OSDL::Video::TwoDimensional::drawBezierCurve(), OSDL::Video::TwoDimensional::drawCircle(), and filledCircleRGBANotBlended().

PixelColor OSDL::Video::Pixels::convertRGBAToPixelColor ( const PixelFormat &  format,
ColorElement  red,
ColorElement  green,
ColorElement  blue,
ColorElement  alpha = AlphaOpaque 
) throw ()

Converts a set of four coordinates in RGBA color space to a PixelColor, using specified format.

Note:
If alpha coordinate is not specified (just plain RGB), the pixel will be considered as fully opaque.

Definition at line 595 of file OSDLPixel.cc.

Referenced by putColorDefinition(), and putRGBAPixel().

PixelColor OSDL::Video::Pixels::convertRGBAToRawPixelColor ( ColorElement  red,
ColorElement  green,
ColorElement  blue,
ColorElement  alpha = AlphaOpaque 
) throw ()

Converts a RGBA raw color into a raw PixelColor, with no pixel format mapping.

Note:
No pixel format mapping of any kind is performed, it is a transformation between two exactly similar formats, as if the pixel format was exactly 32-bit RGBA.

Definition at line 661 of file OSDLPixel.cc.

Pixels::ColorDefinition OSDL::Video::Pixels::getColorDefinition ( const Surface &  fromSurface,
Coordinate  x,
Coordinate  y 
) throw ( VideoException )

Returns the color definition of pixel at [x;y].

This method is generic (i.e. not optimized for any display format).

Parameters:
fromSurface the surface to read the pixel from. If this surface has no alpha coordinate, then the returned color definition will have its fourth color coordinate equal to AlphaOpaque.
Note:
No clipping is performed, and the surface should have been previously locked if necessary.
See also:
put methods

http://sdldoc.csn.ul.ie/guidevideo.php

Definition at line 851 of file OSDLPixel.cc.

References convertPixelColorToColorDefinition(), and getPixelColor().

void OSDL::Video::Pixels::getCurrentColorMasks ( const PixelFormat &  format,
ColorMask &  redMask,
ColorMask &  greenMask,
ColorMask &  blueMask,
ColorMask &  alphaMask 
) throw ()

Reads from specified pixel format the RBGA masks, and returns them by updating specified color mask references.

Parameters:
format the pixel format from which masks are to be read.
redMask the variable in which this method will put the red mask.
greenMask the variable in which this method will put the green mask.
blueMask the variable in which this method will put the blue mask.
alphaMask the variable in which this method will put the alpha mask.
See also:
getRecommendedColorMasks

Definition at line 547 of file OSDLPixel.cc.

Referenced by OSDL::Video::Surface::clone(), OSDL::Video::TwoDimensional::UprightRectangle::drawWithRoundedCorners(), and OSDL::Video::Surface::resize().

bool OSDL::Video::Pixels::getGammaRamp ( GammaRampElement *  redRamp,
GammaRampElement *  greenRamp,
GammaRampElement *  blueRamp 
) throw ()

Gets the color gamma lookup tables for the display.

Returns:
true iff the operation is a success. An error could be that gamma adjustment is not supported, since not all display hardware support it.
Ownership of specified buffers is not clear. Who should allocate them ? We suppose the caller must allocate them.

Definition at line 456 of file OSDLPixel.cc.

References OSDL::Utils::getBackendLastError().

Pixels::PixelColor OSDL::Video::Pixels::getPixelColor ( const Surface &  fromSurface,
Coordinate  x,
Coordinate  y 
) throw ( VideoException )

Returns the pixel color at [x;y].

This method is generic (i.e. not optimized for any display format).

Note:
No clipping is performed, and the surface should have been previously locked if necessary.
See also:
put methods

http://sdldoc.csn.ul.ie/guidevideo.php

Definition at line 809 of file OSDLPixel.cc.

Referenced by getColorDefinition(), OSDL::Video::Surface::getColorDefinitionAt(), and OSDL::Video::Surface::getPixelColorAt().

void OSDL::Video::Pixels::getRecommendedColorMasks ( ColorMask &  redMask,
ColorMask &  greenMask,
ColorMask &  blueMask 
) throw ()

Returns the RBG masks which are recommended on this platform : the endianness is taken into account, regardless of any specific pixel format.

This method just chooses, among the various 32 bit combinations of masks, one that would be suitable for most uses, including for OpenGL textures.

Parameters:
format the pixel format from which masks are to be read.
redMask the variable in which this method will put the red mask.
greenMask the variable in which this method will put the green mask.
blueMask the variable in which this method will put the blue mask.
See also:
getColorMasks

Definition at line 515 of file OSDLPixel.cc.

References OSDL::Video::OpenGL::BlueMask, OSDL::Video::OpenGL::GreenMask, and OSDL::Video::OpenGL::RedMask.

Referenced by alternativePutPixelColor(), OSDL::Video::TwoDimensional::Text::FixedFont::basicRenderLatin1Glyph(), OSDL::Video::TwoDimensional::Text::TrueTypeFont::basicRenderUnicodeGlyph(), OSDL::Video::TwoDimensional::Text::Font::renderLatin1MultiLineText(), OSDL::Video::TwoDimensional::Text::TrueTypeFont::renderLatin1Text(), OSDL::Video::TwoDimensional::Text::TrueTypeFont::renderUnicodeText(), and OSDL::Video::TwoDimensional::Text::TrueTypeFont::renderUTF8Text().

void OSDL::Video::Pixels::getRecommendedColorMasks ( ColorMask &  redMask,
ColorMask &  greenMask,
ColorMask &  blueMask,
ColorMask &  alphaMask 
) throw ()

Returns the RBGA masks which are recommended on this platform : the endianness is taken into account, regardless of any specific pixel format.

This method just chooses, among the various 32 bit combinations of masks, one that would be suitable for most uses, including for OpenGL textures.

Parameters:
format the pixel format from which masks are to be read.
redMask the variable in which this method will put the red mask.
greenMask the variable in which this method will put the green mask.
blueMask the variable in which this method will put the blue mask.
alphaMask the variable in which this method will put the alpha mask.
See also:
getColorMasks

Definition at line 476 of file OSDLPixel.cc.

References OSDL::Video::OpenGL::AlphaMask, OSDL::Video::OpenGL::BlueMask, OSDL::Video::OpenGL::GreenMask, and OSDL::Video::OpenGL::RedMask.

bool OSDL::Video::Pixels::isLess ( ColorDefinition  value,
ColorDefinition  comparison 
) throw ()

Returns whether value is strictly less than comparison, by defining an arbitrary order in color coordinates.

Parameters:
value the value of reference.
comparison the value to compare with.
Note:
This function is useful to provide a '<' operator for some containers (see Text::Font class).

Definition at line 706 of file OSDLPixel.cc.

Referenced by OSDL::Video::TwoDimensional::Text::Font::StringColorQualityKey::operator<(), and OSDL::Video::TwoDimensional::Text::Font::CharColorQualityKey::operator<().

void OSDL::Video::Pixels::putColorDefinition ( Surface &  targetSurface,
Coordinate  x,
Coordinate  y,
ColorDefinition  colorDef,
bool  blending = true,
bool  clipping = true,
bool  locking = false 
) throw ( VideoException )

Puts the specified pixel at [x;y] with the given color, specified as a RGBA color definition, not as a pixel color already encoded according to the pixel format of target surface.

If the alpha coordinate is not AlphaOpaque, then the specified pixel will be alphablended with the pixel already present at specified location.

Parameters:
x the abscissa of the point to change.
y the ordinate of the point to change.
colorDef the color definition of the pixel to be put. These color coordinates will be mapped according to the target surface's pixel format.
blending tells whether the alpha channel must be taken into account, resulting to alpha blending with the destination pixel. If false, the exact specified color will be put in target pixel, instead of being blended with it.
clipping tells whether point location is checked against surface bounds. If clipping is activated and the pixel is outside, nothing is done.
locking tells whether this primitive should take care of locking / unlocking the surface (not recommended on a per pixel basis, because of lock overhead).
Note:
This method is relatively expensive.
See also:
get methods

http://sdldoc.csn.ul.ie/guidevideo.php

Definition at line 879 of file OSDLPixel.cc.

References convertRGBAToPixelColor(), and putPixelColor().

void OSDL::Video::Pixels::putPixelColor ( Surface &  targetSurface,
Coordinate  x,
Coordinate  y,
PixelColor  convertedColor,
ColorElement  alpha,
bool  blending = true,
bool  clipping = true,
bool  locking = false 
) throw ( VideoException )

Puts the pixel at [x;y] with the given color, specified as a 32-bit RGBA pixel color, already encoded according to Surface's pixel format.

If the alpha coordinate is not AlphaOpaque, then the specified pixel will be alphablended with the pixel already present at specified location.

Parameters:
x the abscissa of the point to change.
y the ordinate of the point to change.
convertedColor the color of the pixel to be put, a 32-bit pixel value already mapped according to the target surface's pixel format.
alpha the full alpha coordinate to be used. The one guessed from the 'convertedColor' parameter would not be enough, since it would be already encoded and rounded.
blending tells whether the alpha channel must be taken into account, resulting to alpha blending with the destination pixel. If false, the exact specified color will be put in target pixel, instead of being blended with it.
clipping tells whether point location is checked against surface bounds. If clipping is activated and the pixel is outside, nothing is done.
locking tells whether this primitive should take care of locking / unlocking the surface (not recommended on a per pixel basis, because of lock overhead).
See also:
get methods

http://sdldoc.csn.ul.ie/guidevideo.php

Definition at line 894 of file OSDLPixel.cc.

References fastPixelColorNolock(), fastPixelColorNolockNoclip(), and putPixelAlpha().

Referenced by putColorDefinition(), OSDL::Video::Surface::putPixelColorAt(), and putRGBAPixel().

void OSDL::Video::Pixels::putRGBAPixel ( Surface &  targetSurface,
Coordinate  x,
Coordinate  y,
ColorElement  red,
ColorElement  green,
ColorElement  blue,
ColorElement  alpha = AlphaOpaque,
bool  blending = true,
bool  clipping = true,
bool  locking = false 
) throw ( VideoException )

Puts specified pixel at [x;y] with the given color, specified as separate RGBA coordinates.

If the alpha coordinate is not AlphaOpaque, then the specified pixel will be alphablended with the pixel already present at specified location.

Parameters:
x the abscissa of the point to change.
y the ordinate of the point to change.
red the red color coordinate.
green the green color coordinate.
blue the blue color coordinate.
alpha the alpha color coordinate.
blending tells whether the alpha channel must be taken into account, resulting to alpha blending with the destination pixel. If false, the exact specified color will be put in target pixel, instead of being blended with it.
clipping tells whether point location is checked against surface bounds. If clipping is activated and the pixel is outside, nothing is done.
locking tells whether this primitive should take care of locking / unlocking the surface (not recommended on a per pixel basis, because of lock overhead).
Exceptions:
VideoException if a problem occurs with a lock operation.
Note:
The four RGBA coordinates will be automatically mapped according to the target surface's pixel format.
See also:
get methods

http://sdldoc.csn.ul.ie/guidevideo.php

Definition at line 864 of file OSDLPixel.cc.

References convertRGBAToPixelColor(), and putPixelColor().

Referenced by OSDL::Video::Surface::putColorDefinitionAt(), and OSDL::Video::Surface::putRGBAPixelAt().

ColorDefinition OSDL::Video::Pixels::selectColorDifferentFrom ( ColorDefinition  first,
ColorDefinition  second,
ColorDefinition  third 
) throw ()

Returns a color definition which is different from the specified ones.

The alpha coordinate is not taken into account in comparisons.

It is useful for example when having to find predictably a color key which does not collide with a set of used colors.

Parameters:
first the first color to avoid.
second the second color to avoid.
third the third color to avoid.
Returns:
a colorkey different from all provided colors.

Definition at line 774 of file OSDLPixel.cc.

References areEqual(), Black, Blue, Green, and Red.

Referenced by OSDL::Video::TwoDimensional::UprightRectangle::drawWithRoundedCorners().

ColorDefinition OSDL::Video::Pixels::selectColorDifferentFrom ( ColorDefinition  first,
ColorDefinition  second 
) throw ()

Returns a color definition which is chosen different from the specified ones.

The alpha coordinate is not taken into account in comparisons.

It is useful for example when having to find predictably a color key which does not collide with two used colors.

Parameters:
first the first color to avoid.
second the second color to avoid.
Returns:
a colorkey different from all provided colors.

Definition at line 751 of file OSDLPixel.cc.

References areEqual(), Blue, Green, and Red.

bool OSDL::Video::Pixels::setGamma ( GammaFactor  red,
GammaFactor  green,
GammaFactor  blue 
) throw ()

Sets the "gamma function" for the display of each color component.

Gamma controls the brightness/contrast of colors displayed on the screen.

A gamma value of 1.0 is identity (i.e., no adjustment is made).

Note:
Not all display hardware are able to change gamma.
Returns:
true iff the operation is a success. An error could be that gamma adjustment is not supported : not all display hardware support it.

Definition at line 422 of file OSDLPixel.cc.

References OSDL::Utils::getBackendLastError().

bool OSDL::Video::Pixels::setGammaRamp ( GammaRampElement *  redRamp,
GammaRampElement *  greenRamp,
GammaRampElement *  blueRamp 
) throw ()

Sets the gamma lookup tables for the display for each color component.

Each ramp (table) should have 256 entries.

Each gamma ramp represents a mapping between the input and output for that color coordinate.

The input is the index into the array, and the output is the 16-bit gamma value at that index, scaled to the output color precision. You may pass a null pointer (O) to any of the channels to leave them unchanged.

Note:
This function adjusts the gamma based on lookup tables, you can also have the gamma calculated based on a "gamma function", parametered with setGamma.
Returns:
true iff the operation is a success. An error could be that gamma adjustment is not supported, since not all display hardware support it.
Ownership of specified buffers is not clear. Who should deallocate them ?

Definition at line 439 of file OSDLPixel.cc.

References OSDL::Utils::getBackendLastError().

string OSDL::Video::Pixels::toString ( ColorDefinition  color  )  throw ()

Returns a textual representation of the specified color definition.

Note:
The alpha coordinate has not always a meaning, depending of the context.

Definition at line 1234 of file OSDLPixel.cc.

Referenced by alternativePutPixelColor(), areEqual(), OSDL::Video::TwoDimensional::Text::TrueTypeFont::basicRenderUnicodeGlyph(), OSDL::Video::Surface::blitTo(), OSDL::Video::TwoDimensional::Text::FixedFont::BuildFontFilenameFor(), OSDL::Video::Surface::clone(), OSDL::Engine::CircleBoundingBox::compareWith(), OSDL::Video::TwoDimensional::UprightRectangle::computeRadiusForRoundRectangle(), OSDL::Video::VideoModule::DescribeEnvironmentVariables(), OSDL::Events::EventsModule::DescribeEnvironmentVariables(), OSDL::CommonModule::DescribeEnvironmentVariables(), OSDL::Audio::AudioModule::DescribeEnvironmentVariables(), OSDL::Events::EventsModule::DescribeEvent(), OSDL::Video::TwoDimensional::Text::Font::describeGlyphFor(), OSDL::Events::KeyboardHandler::DescribeKey(), OSDL::Video::Surface::describePixelAt(), OSDL::Events::KeyboardHandler::DescribeUnicode(), OSDL::Video::VideoModule::DescribeVideoCapabilities(), OSDL::Video::TwoDimensional::UprightRectangle::draw(), OSDL::Video::TwoDimensional::drawCircle(), OSDL::Video::TwoDimensional::UprightRectangle::drawWithRoundedCorners(), OSDL::Events::EventsModule::enterBasicMainLoop(), OSDL::Events::EventsModule::EvaluateCallbackduration(), OSDL::Video::Surface::fill(), filledCircleColorNotBlended(), OSDL::Video::VideoModule::GetAntiAliasingState(), OSDL::Video::Palette::getColorDefinitionAt(), OSDL::getCommonModule(), OSDL::Video::TwoDimensional::Widget::getConstContainer(), OSDL::Video::TwoDimensional::Widget::getContainer(), OSDL::Video::VideoModule::GetEndPointDrawState(), OSDL::Events::Joystick::getIndex(), OSDL::Video::Palette::getPixelColorAt(), OSDL::Events::Joystick::getPositionOfAxis(), OSDL::Events::Joystick::getPositionOfHat(), OSDL::Events::Joystick::getPositionOfTrackball(), OSDL::Engine::Scheduler::GetScheduler(), OSDL::CDROMDrive::getTrack(), OSDL::CDROMDrive::getTrackDuration(), OSDL::Events::Joystick::isButtonPressed(), OSDL::Events::Joystick::isOpen(), OSDL::Events::MouseHandler::linkToController(), OSDL::Events::JoystickHandler::linkToController(), OSDL::Video::TwoDimensional::Text::FixedFont::loadFontFrom(), OSDL::Engine::ActiveObject::onImpossibleActivation(), OSDL::Engine::PeriodicSlot::onNextTick(), OSDL::Engine::Scheduler::onRenderingSkipped(), OSDL::Events::EventsModule::onResizedWindow(), OSDL::Engine::Scheduler::onScheduleFailure(), OSDL::Engine::Scheduler::onSimulationSkipped(), OSDL::Engine::ActiveObject::onSkip(), OSDL::Events::JoystickHandler::openJoystick(), putPixelAlpha(), OSDL::Video::TwoDimensional::Widget::redraw(), OSDL::Video::TwoDimensional::BackBufferedWidget::redraw(), OSDL::Video::TwoDimensional::TextWidget::redrawBackBuffer(), OSDL::Video::TwoDimensional::BackBufferedWidget::redrawInternal(), OSDL::Video::TwoDimensional::Text::Font::renderLatin1MultiLineText(), OSDL::Video::TwoDimensional::Text::TrueTypeFont::renderLatin1Text(), OSDL::Video::TwoDimensional::Text::TrueTypeFont::renderUnicodeText(), OSDL::Video::TwoDimensional::Text::TrueTypeFont::renderUTF8Text(), OSDL::Video::VideoModule::resize(), OSDL::Engine::Scheduler::scheduleBestEffort(), OSDL::Engine::Scheduler::scheduleNoDeadline(), OSDL::Engine::Scheduler::Scheduler(), OSDL::Video::Surface::setAlphaForColor(), OSDL::Engine::Scheduler::setInputPollingFrequency(), OSDL::Video::TwoDimensional::UprightRectangle::setLowerRightAbscissa(), OSDL::Video::TwoDimensional::UprightRectangle::setLowerRightCorner(), OSDL::Video::TwoDimensional::UprightRectangle::setLowerRightOrdinate(), OSDL::Events::KeyboardHandler::SetMode(), OSDL::Engine::Scheduler::setRenderingFrequency(), OSDL::Engine::Scheduler::setScreenshotFrequency(), OSDL::Engine::Scheduler::setSimulationFrequency(), OSDL::Video::OpenGL::GLTexture::SetTextureFlavour(), OSDL::Video::TwoDimensional::Text::FixedFont::submitLatin1GlyphToCache(), OSDL::Engine::WorldObject::toString(), OSDL::Video::TwoDimensional::Widget::toString(), OSDL::Rendering::VideoRenderer::toString(), OSDL::Video::VideoModule::toString(), OSDL::Video::TwoDimensional::UprightRectangle::toString(), OSDL::Video::TwoDimensional::Text::TrueTypeFont::toString(), OSDL::Video::TwoDimensional::TextWidget::toString(), OSDL::Video::Surface::toString(), OSDL::Rendering::Sprite::toString(), OSDL::Engine::Scheduler::toString(), OSDL::Rendering::Renderer::toString(), OSDL::Video::TwoDimensional::PolygonSet::toString(), OSDL::Video::TwoDimensional::Polygon::toString(), toString(), OSDL::Engine::PeriodicSlot::toString(), OSDL::Video::Palette::toString(), OSDL::Video::Overlay::toString(), OSDL::Video::OpenGL::OpenGLContext::ToString(), OSDL::Rendering::MultimediaRenderer::toString(), OSDL::Events::MouseHandler::toString(), OSDL::MVC::Model::toString(), OSDL::Events::JoystickHandler::toString(), OSDL::Events::Joystick::toString(), OSDL::Video::TwoDimensional::UprightRectangleGL::toString(), OSDL::Video::OpenGL::GLTexture::toString(), OSDL::Video::TwoDimensional::Text::FixedFont::toString(), OSDL::Events::EventsModule::toString(), OSDL::MVC::Controller::toString(), OSDL::Events::ClassicalJoystick::toString(), OSDL::Engine::CircleBoundingBox::toString(), OSDL::CDROMDriveHandler::toString(), OSDL::CDROMDrive::toString(), OSDL::CDTrack::toString(), OSDL::Engine::BoundingBox2D::toString(), OSDL::CommonModule::toString(), OSDL::Video::TwoDimensional::BackBufferedWidget::toString(), OSDL::Rendering::AudioRenderer::toString(), OSDL::Audio::AudioModule::toString(), OSDL::Engine::ActiveObject::toString(), OSDL::Video::TwoDimensional::Text::TrueTypeFont::TrueTypeFont(), OSDL::Events::JoystickHandler::update(), OSDL::Video::OpenGL::GLTexture::upload(), OSDL::Video::TwoDimensional::UprightRectangle::UprightRectangle(), and OSDL::Video::Surface::~Surface().

string OSDL::Video::Pixels::toString ( PixelColor  pixel,
const PixelFormat &  format 
) throw ()

Returns a textual representation of the specified color, according to the specified pixel format.

Parameters:
pixel the pixel color to describe.
format the pixel format which allows to decode the pixel.

Definition at line 1224 of file OSDLPixel.cc.

References convertPixelColorToColorDefinition(), and toString().

string OSDL::Video::Pixels::toString ( const PixelFormat &  format  )  throw ()

Returns a textual representation of the specified pixel format.

Parameters:
format the pixel format to describe.

Definition at line 1159 of file OSDLPixel.cc.

References toString().

Referenced by OSDL::Video::Palette::CreateGradationPalette(), OSDL::Video::VideoModule::DescribeVideoCapabilities(), OSDL::Video::TwoDimensional::UprightRectangle::draw(), OSDL::Video::TwoDimensional::UprightRectangle::drawWithRoundedCorners(), OSDL::Video::Surface::setAlphaForColor(), OSDL::Video::TwoDimensional::Widget::toString(), OSDL::Video::TwoDimensional::TextWidget::toString(), and OSDL::Video::Palette::toString().

Variable Documentation

const ColorDefinition OSDL::Video::Pixels::AliceBlue

Shades of Blue :.

Definition at line 66 of file OSDLPixel.cc.

const ColorElement OSDL::Video::Pixels::AlphaOpaque = 255

The alpha coordinate which corresponds to opaque (solid) pixels.

Note:
This is the reverse for OpenGL.

Definition at line 109 of file OSDLPixel.h.

Referenced by OSDL::Video::TwoDimensional::drawDiscWithEdge(), and OSDL::Video::TwoDimensional::UprightRectangle::drawWithRoundedCorners().

const ColorElement OSDL::Video::Pixels::AlphaTransparent = 0

The alpha coordinate which corresponds to transparent pixels.

Note:
This is the reverse for OpenGL.

Definition at line 99 of file OSDLPixel.h.

const ColorDefinition OSDL::Video::Pixels::AntiqueWhite

Shades of White :.

Definition at line 339 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::Aquamarine

Definition at line 111 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::Azure

Definition at line 114 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::Beige

Definition at line 143 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::Bisque

Definition at line 231 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::Black

Shades of Grey :.

Definition at line 43 of file OSDLPixel.cc.

Referenced by OSDL::Video::TwoDimensional::Text::FixedFont::basicRenderLatin1Glyph(), OSDL::Video::TwoDimensional::Text::TrueTypeFont::basicRenderUnicodeGlyph(), OSDL::Video::Surface::clear(), OSDL::Video::Palette::CreateGreyScalePalette(), OSDL::Video::TwoDimensional::Text::Font::renderLatin1MultiLineText(), OSDL::Video::TwoDimensional::Text::TrueTypeFont::renderLatin1Text(), OSDL::Video::TwoDimensional::Text::TrueTypeFont::renderUnicodeText(), OSDL::Video::TwoDimensional::Text::TrueTypeFont::renderUTF8Text(), and selectColorDifferentFrom().

const ColorDefinition OSDL::Video::Pixels::BlanchedAlmond

Shades of Yellow :.

Definition at line 383 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::Blue

Definition at line 117 of file OSDLPixel.cc.

Referenced by selectColorDifferentFrom().

const ColorDefinition OSDL::Video::Pixels::BlueViolet

Definition at line 69 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::Brown

Shades of Brown :.

Definition at line 134 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::Burlywood

Definition at line 146 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::CadetBlue

Definition at line 72 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::Chartreuse

Definition at line 202 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::Chocolate

Definition at line 149 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::Copper

Definition at line 158 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::Coral

Definition at line 234 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::Cornsilk

Definition at line 404 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::Cyan

Definition at line 120 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::DarkGoldenrod

Definition at line 386 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::DarkGreen

Shades of Green :.

Definition at line 166 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::DarkOliveGreen

Definition at line 169 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::DarkOrange

Shades of Orange :.

Definition at line 216 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::DarkOrchid

Shades of Violet :.

Definition at line 295 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::DarkSalmon

Definition at line 219 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::DarkSlateBlue

Definition at line 75 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::DarkTurquoise

Definition at line 78 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::DarkViolet

Definition at line 298 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::DeepPink

Shades of Red :.

Definition at line 254 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::DeepSkyBlue

Definition at line 81 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::DimGrey

Definition at line 49 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::DodgerBlue

Definition at line 84 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::Firebrick

Definition at line 278 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::FloralWhite

Definition at line 342 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::ForestGreen

Definition at line 172 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::Gainsboro

Definition at line 357 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::GhostWhite

Definition at line 345 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::Gold

Definition at line 407 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::Goldenrod

Definition at line 410 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::Green

Definition at line 205 of file OSDLPixel.cc.

Referenced by selectColorDifferentFrom().

const ColorDefinition OSDL::Video::Pixels::GreenYellow

Definition at line 175 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::Grey

Definition at line 46 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::Honeydew

Definition at line 237 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::HotPink

Definition at line 257 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::IndianRed

Definition at line 260 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::Ivory

Definition at line 360 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::Khaki

Definition at line 208 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::Lavender

Definition at line 310 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::LavenderBlush

Definition at line 301 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::LawnGreen

Definition at line 178 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::LemonChiffon

Definition at line 389 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::LightBlue

Definition at line 87 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::LightCoral

Definition at line 222 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::LightCyan

Definition at line 90 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::LightGoldenrod

Definition at line 392 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::LightGrey

Definition at line 52 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::LightPink

Definition at line 263 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::LightSalmon

Definition at line 225 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::LightYellow

Definition at line 395 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::LimeGreen

Definition at line 181 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::Linen

Definition at line 363 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::Magenta

Definition at line 313 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::Maroon

Definition at line 316 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::MediumBlue

Definition at line 93 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::MediumOrchid

Definition at line 304 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::MediumPurple

Definition at line 307 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::MediumVioletRed

Definition at line 266 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::MidnightBlue

Definition at line 126 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::MintCream

Definition at line 184 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::MistyRose

Definition at line 269 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::Moccasin

Definition at line 413 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::NavajoWhite

Definition at line 348 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::NavyBlue

Definition at line 96 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::OldLace

Definition at line 351 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::OliveDrab

Definition at line 187 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::Orange

Definition at line 240 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::OrangeRed

Definition at line 272 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::Orchid

Definition at line 319 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::PaleGoldenrod

Definition at line 398 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::PaleGreen

Definition at line 190 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::PapayaWhip

Definition at line 401 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::PeachPuff

Definition at line 228 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::Peru

Definition at line 152 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::Pink

Definition at line 281 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::Plum

Definition at line 322 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::Purple

Definition at line 325 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::Red

Definition at line 284 of file OSDLPixel.cc.

Referenced by selectColorDifferentFrom().

const ColorDefinition OSDL::Video::Pixels::RosyBrown

Definition at line 137 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::RoyalBlue

Definition at line 99 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::SaddleBrown

Definition at line 140 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::Salmon

Definition at line 243 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::SeaGreen

Definition at line 193 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::Seashell

Definition at line 366 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::Sienna

Definition at line 246 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::Silver

Definition at line 58 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::SkyBlue

Definition at line 102 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::SlateBlue

Definition at line 105 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::SlateGrey

Definition at line 55 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::Snow

Definition at line 369 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::SpringGreen

Definition at line 196 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::SteelBlue

Definition at line 108 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::Tan

Definition at line 155 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::Thistle

Definition at line 328 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::Tomato

Definition at line 287 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::Transparent

Transparent color (alpha set to not opaque at all).

With an opaque alpha, would be pure black.

This color is useful to specify that, for example, a background should remain empty, i.e. fully transparent.

Definition at line 35 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::Turquoise

Definition at line 123 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::Violet

Definition at line 331 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::VioletRed

Definition at line 275 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::Wheat

Definition at line 372 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::White

Definition at line 375 of file OSDLPixel.cc.

Referenced by OSDL::Video::TwoDimensional::Text::FixedFont::basicRenderLatin1Glyph(), OSDL::Video::TwoDimensional::Text::TrueTypeFont::basicRenderUnicodeGlyph(), OSDL::Video::Palette::CreateGreyScalePalette(), OSDL::Video::TwoDimensional::Text::Font::renderLatin1MultiLineText(), OSDL::Video::TwoDimensional::Text::TrueTypeFont::renderLatin1Text(), OSDL::Video::TwoDimensional::Text::TrueTypeFont::renderUnicodeText(), and OSDL::Video::TwoDimensional::Text::TrueTypeFont::renderUTF8Text().

const ColorDefinition OSDL::Video::Pixels::WhiteSmoke

Definition at line 354 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::Yellow

Definition at line 416 of file OSDLPixel.cc.

const ColorDefinition OSDL::Video::Pixels::YellowGreen

Definition at line 199 of file OSDLPixel.cc.

Generated on Fri Mar 30 14:47:32 2007 for OSDL by  doxygen 1.5.1