OSDL::Video::Pixels Namespace Reference

Allows to handle the various pixel colors and formats. More...

Typedefs

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 FloatColorElement
 Describes a floating-point coordinate used in color space, including alpha.
typedef ::SDL_Color ColorDefinition
 Format-independent color description.
typedef ::SDL_PixelFormat PixelFormat
 Describes a pixel format.
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)
 Sets the "gamma function" for the display of each color component.
OSDL_DLL bool setGammaRamp (GammaRampElement *redRamp, GammaRampElement *greenRamp, GammaRampElement *blueRamp)
 Sets the gamma lookup tables for the display for each color component.
OSDL_DLL bool getGammaRamp (GammaRampElement *redRamp, GammaRampElement *greenRamp, GammaRampElement *blueRamp)
 Gets the color gamma lookup tables for the display.
OSDL_DLL void getRecommendedColorMasks (ColorMask &redMask, ColorMask &greenMask, ColorMask &blueMask, ColorMask &alphaMask)
 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)
 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)
 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)
 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)
 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)
 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)
 Returns RGBA quadruplet corresponding to specified pixel, encoded according to specified pixel format.
OSDL_DLL PixelColor convertColorDefinitionToPixelColor (const PixelFormat &format, ColorDefinition colorDef)
 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)
 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)
 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)
 Returns whether the two color definitions describe the exact same color.
OSDL_DLL bool isLess (ColorDefinition value, ColorDefinition comparison)
 Returns whether value is strictly less than comparison, by defining an arbitrary order in color coordinates.
OSDL_DLL bool areEqual (PixelColor first, PixelColor second)
 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)
 Returns a color definition which is chosen different from the specified ones.
OSDL_DLL ColorDefinition selectColorDifferentFrom (ColorDefinition first, ColorDefinition second, ColorDefinition third)
 Returns a color definition which is different from the specified ones.
OSDL_DLL PixelColor getPixelColor (const Surface &fromSurface, Coordinate x, Coordinate y)
 Returns the pixel color at [x;y].
OSDL_DLL ColorDefinition getColorDefinition (const Surface &fromSurface, Coordinate x, Coordinate y)
 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)
 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)
 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)
 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)
 Alternative method to set the pixel at [x;y] to the given pixel color.
OSDL_DLL std::string toString (const PixelFormat &format)
 Returns a textual representation of the specified pixel format.
OSDL_DLL std::string toString (PixelColor pixel, const PixelFormat &format)
 Returns a textual representation of the specified color, according to the specified pixel format.
OSDL_DLL std::string toString (ColorDefinition color)
 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
 Main color definitions: 115 different colors described by name.
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
 Pure magenta is the OSDL default color key.
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
OSDL_DLL const ColorDefinition DefaultColorkey = Magenta
 Pure magenta is the OSDL default color key.

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.


Typedef Documentation

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). Describes a color definition, not converted to a specific format.

Definition at line 172 of file OSDLPixel.h.

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

Describes a coordinate used in color space, including alpha.

Definition at line 114 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 106 of file OSDLPixel.h.

typedef Ceylan::Float32 OSDL::Video::Pixels::FloatColorElement

Describes a floating-point coordinate used in color space, including alpha.

Note:
These coordinates, quite useful with OpenGL, are expected to range from zero to full intensity, in [0,1].

Definition at line 147 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 252 of file OSDLPixel.h.

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

A color element of a gamma ramp.

Definition at line 278 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 96 of file OSDLPixel.h.

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

Describes a pixel format.

Definition at line 180 of file OSDLPixel.h.


Function Documentation

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

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 1198 of file OSDLPixel.cc.

References OSDL::Video::Surface::getBytesPerPixel(), OSDL::Video::Surface::getPitch(), OSDL::Video::Surface::getPixelFormat(), OSDL::Video::Surface::getPixels(), getRecommendedColorMasks(), and toString().

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

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 840 of file OSDLPixel.cc.

bool OSDL::Video::Pixels::areEqual ( ColorDefinition  first,
ColorDefinition  second,
bool  useAlpha = true 
)
PixelColor OSDL::Video::Pixels::convertColorDefinitionToPixelColor ( const PixelFormat &  format,
ColorDefinition  colorDef 
)
PixelColor OSDL::Video::Pixels::convertColorDefinitionToRawPixelColor ( ColorDefinition  colorDef  ) 

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 741 of file OSDLPixel.cc.

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

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

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 652 of file OSDLPixel.cc.

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

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)
Exceptions:
VideoException if the operation failed or is not supported.

Definition at line 697 of file OSDLPixel.cc.

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

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

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 634 of file OSDLPixel.cc.

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

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

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 666 of file OSDLPixel.cc.

Referenced by putColorDefinition(), and putRGBAPixel().

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

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 759 of file OSDLPixel.cc.

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

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 960 of file OSDLPixel.cc.

References convertPixelColorToColorDefinition(), getPixelColor(), and OSDL::Video::Surface::getPixelFormat().

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

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 616 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 
)

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 517 of file OSDLPixel.cc.

References OSDL::Utils::getBackendLastError().

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

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 909 of file OSDLPixel.cc.

References OSDL::Video::Surface::getBytesPerPixel(), OSDL::Video::Surface::getPitch(), and OSDL::Video::Surface::getPixels().

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

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

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 584 of file OSDLPixel.cc.

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

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

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 547 of file OSDLPixel.cc.

References OSDL::Video::OpenGL::AlphaMask, 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::Font::basicRenderLatin1Text(), OSDL::Video::TwoDimensional::Text::TrueTypeFont::basicRenderUnicodeGlyph(), OSDL::Video::TwoDimensional::Text::Font::renderLatin1MultiLineText(), OSDL::Video::TwoDimensional::Text::TrueTypeFont::renderLatin1Text(), OSDL::Video::TwoDimensional::Text::Font::renderLatin1TextWithWordCached(), OSDL::Video::TwoDimensional::Text::TrueTypeFont::renderUnicodeText(), and OSDL::Video::TwoDimensional::Text::TrueTypeFont::renderUTF8Text().

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

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 804 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 
)

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 986 of file OSDLPixel.cc.

References convertRGBAToPixelColor(), OSDL::Video::Surface::getPixelFormat(), 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 
)

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 1000 of file OSDLPixel.cc.

References OSDL::Video::Surface::getSDLSurface(), and OSDL::Video::Surface::mustBeLocked().

Referenced by putColorDefinition(), 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 
)

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 972 of file OSDLPixel.cc.

References convertRGBAToPixelColor(), OSDL::Video::Surface::getPixelFormat(), and putPixelColor().

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

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 872 of file OSDLPixel.cc.

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

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

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 849 of file OSDLPixel.cc.

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

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

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

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 468 of file OSDLPixel.cc.

References OSDL::Utils::getBackendLastError().

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

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 492 of file OSDLPixel.cc.

References OSDL::Utils::getBackendLastError().

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

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 1358 of file OSDLPixel.cc.

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

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 1348 of file OSDLPixel.cc.

References convertPixelColorToColorDefinition(), and toString().

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

Returns a textual representation of the specified pixel format.

Parameters:
format the pixel format to describe.

Definition at line 1283 of file OSDLPixel.cc.

Referenced by alternativePutPixelColor(), OSDL::Video::VideoModule::AreDefinitionsRestricted(), areEqual(), OSDL::Video::TwoDimensional::Text::Font::basicRenderLatin1Text(), OSDL::Video::TwoDimensional::Text::TrueTypeFont::basicRenderUnicodeGlyph(), OSDL::Video::TwoDimensional::Text::TrueTypeFont::blitLatin1Glyph(), OSDL::Video::Surface::blitTo(), OSDL::Video::TwoDimensional::Text::FixedFont::BuildFontFilenameFor(), OSDL::Audio::channelFormatToString(), OSDL::Video::Surface::clone(), OSDL::Engine::CircleBoundingBox::compareWith(), OSDL::Video::TwoDimensional::UprightRectangle::computeRadiusForRoundRectangle(), OSDL::Video::VideoModule::DescribeAvailableDefinitions(), OSDL::Video::TwoDimensional::Text::Font::describeGlyphFor(), OSDL::Video::VideoModule::DescribeVideoCapabilities(), OSDL::Video::OpenGL::OpenGLContext::DisableFeature(), OSDL::Data::ResourceManager::discardTexture(), OSDL::Data::ResourceManager::displayLoadedResources(), OSDL::Video::TwoDimensional::UprightRectangle::draw(), OSDL::Video::TwoDimensional::drawCircle(), OSDL::Video::TwoDimensional::UprightRectangle::drawWithRoundedCorners(), OSDL::Video::OpenGL::OpenGLContext::EnableFeature(), OSDL::CommonModule::enableGUI(), OSDL::Events::EventsModule::enterBasicMainLoop(), OSDL::Events::EventsModule::EvaluateCallbackduration(), OSDL::Video::Surface::fill(), OSDL::Audio::Music::fillFirstBuffer(), OSDL::Audio::Music::fillSecondBuffer(), OSDL::Video::VideoModule::GetAntiAliasingState(), OSDL::Audio::AudioModule::GetChannelCountFor(), OSDL::Video::Palette::getColorDefinitionAt(), OSDL::Video::TwoDimensional::Widget::getConstContainer(), OSDL::Video::TwoDimensional::Widget::getContainer(), OSDL::Video::VideoModule::GetEndPointDrawState(), OSDL::Video::OpenGL::GLTexture::GetExtensionForFlavour(), OSDL::Data::ResourceManager::getImage(), OSDL::Events::Joystick::getIndex(), OSDL::Audio::Audible::GetLoopsForPlayCount(), OSDL::Data::ResourceManager::getMusic(), OSDL::Engine::Scheduler::getPeriodicSlotFor(), OSDL::Video::Palette::getPixelColorAt(), OSDL::Events::Joystick::getPositionOfAxis(), OSDL::Events::Joystick::getPositionOfHat(), OSDL::Events::Joystick::getPositionOfTrackball(), OSDL::Audio::AudioModule::GetSampleSizeFor(), OSDL::Engine::Scheduler::GetScheduler(), OSDL::Data::ResourceManager::getSound(), OSDL::Data::ResourceManager::getTexture(), OSDL::CDROMDrive::getTrack(), OSDL::CDROMDrive::getTrackDuration(), OSDL::Video::Palette::hasDuplicates(), OSDL::Events::Joystick::isButtonPressed(), OSDL::Events::Joystick::isOpen(), OSDL::Events::MouseHandler::linkToController(), OSDL::Events::JoystickHandler::linkToController(), OSDL::Video::TwoDimensional::Text::TrueTypeFont::load(), OSDL::Audio::Sound::load(), OSDL::Audio::Music::load(), OSDL::Video::TwoDimensional::Image::LoadIcon(), OSDL::Audio::Music::managePlaybackEnded(), OSDL::Rendering::StandardRenderer::onRenderingSkipped(), OSDL::Events::EventsModule::onResizedWindow(), OSDL::Engine::Scheduler::onScheduleFailure(), OSDL::Events::JoystickHandler::openJoystick(), OSDL::Video::Palette::Palette(), OSDL::Engine::PeriodicalActiveObject::PeriodicalActiveObject(), OSDL::Video::TwoDimensional::Widget::redraw(), OSDL::Video::TwoDimensional::BackBufferedWidget::redraw(), OSDL::Video::TwoDimensional::TextWidget::redrawBackBuffer(), OSDL::Video::TwoDimensional::BackBufferedWidget::redrawInternal(), OSDL::Engine::PeriodicSlot::removeFromSubslot(), OSDL::Video::TwoDimensional::Text::Font::renderLatin1MultiLineText(), OSDL::Video::TwoDimensional::Text::TrueTypeFont::renderLatin1Text(), OSDL::Video::TwoDimensional::Text::Font::renderLatin1TextWithWordCached(), OSDL::Video::TwoDimensional::Text::TrueTypeFont::renderUnicodeGlyph(), OSDL::Video::TwoDimensional::Text::TrueTypeFont::renderUnicodeText(), OSDL::Video::TwoDimensional::Text::TrueTypeFont::renderUTF8Text(), OSDL::Video::VideoModule::resize(), OSDL::Audio::sampleFormatToString(), OSDL::Engine::Scheduler::scheduleBestEffort(), OSDL::Engine::Scheduler::scheduleNoDeadline(), OSDL::Engine::Scheduler::Scheduler(), OSDL::Video::Surface::setAlphaForColor(), OSDL::Video::OpenGL::OpenGLContext::SetGLAttribute(), OSDL::Video::TwoDimensional::UprightRectangle::setLowerRightAbscissa(), OSDL::Video::TwoDimensional::UprightRectangle::setLowerRightOrdinate(), OSDL::Video::VideoModule::setMode(), OSDL::Events::KeyboardHandler::SetMode(), OSDL::Video::OpenGL::GLTexture::SetTextureFlavour(), OSDL::Video::OpenGL::OpenGLContext::SetUpForFlavour(), OSDL::Video::OpenGL::OpenGLContext::setViewPort(), OSDL::Video::TwoDimensional::Text::FixedFont::submitLatin1GlyphToCache(), OSDL::Video::VideoModule::ToScreenDimensions(), OSDL::Video::VideoModule::ToStandardScreenSize(), OSDL::Video::TwoDimensional::Widget::toString(), OSDL::Video::TwoDimensional::TextWidget::toString(), OSDL::Video::Surface::toString(), OSDL::Engine::Scheduler::toString(), OSDL::Data::ResourceManager::toString(), OSDL::Video::TwoDimensional::PolygonSet::toString(), OSDL::Video::TwoDimensional::Polygon::toString(), toString(), OSDL::Engine::PeriodicSlot::toString(), OSDL::Video::Palette::toString(), OSDL::Events::MouseHandler::toString(), OSDL::Events::JoystickHandler::toString(), OSDL::Events::EventsModule::toString(), OSDL::CDROMDriveHandler::toString(), OSDL::CDROMDrive::toString(), OSDL::CommonModule::toString(), OSDL::Video::OpenGL::OpenGLContext::TrySettingGLAttribute(), OSDL::Engine::Scheduler::unregisterProgrammedObject(), OSDL::Events::JoystickHandler::update(), OSDL::Video::OpenGL::GLTexture::upload(), OSDL::Video::TwoDimensional::UprightRectangle::UprightRectangle(), OSDL::Audio::MusicManager::~MusicManager(), OSDL::Engine::PeriodicSlot::~PeriodicSlot(), OSDL::Rendering::StandardRenderer::~StandardRenderer(), OSDL::Video::Surface::~Surface(), and OSDL::Video::VideoModule::~VideoModule().


Variable Documentation

Initial value:
 
    { 240, 248, 255, 255 }

Shades of Blue:

Definition at line 108 of file OSDLPixel.cc.

The alpha coordinate which corresponds to transparent pixels.

Note:
This is the reverse for OpenGL.

Definition at line 124 of file OSDLPixel.h.

Referenced by OSDL::Video::OpenGL::GLTexture::setUpInternalSurfaceFrom().

Initial value:
 
    { 250, 235, 215, 255 }

Shades of White:

Definition at line 381 of file OSDLPixel.cc.

Initial value:
 
    { 127, 255, 212, 255 }

Definition at line 153 of file OSDLPixel.cc.

Initial value:
 
    { 240, 255, 255, 255 }

Definition at line 156 of file OSDLPixel.cc.

Initial value:
 
    { 245,  42,  42, 255 }

Definition at line 185 of file OSDLPixel.cc.

Initial value:
 
    { 255, 228, 196, 255 }

Definition at line 273 of file OSDLPixel.cc.

Initial value:
 
    { 255, 235, 205, 255 }

Shades of Yellow:

Definition at line 425 of file OSDLPixel.cc.

Initial value:
 
    {   0,   0, 255, 255 }

Definition at line 159 of file OSDLPixel.cc.

Referenced by selectColorDifferentFrom().

Initial value:
 
    { 138,  43, 226, 255 }

Definition at line 111 of file OSDLPixel.cc.

Initial value:
 
    { 165,  42,  42, 255 }

Shades of Brown:

Definition at line 176 of file OSDLPixel.cc.

Initial value:
 
    { 222, 184, 135, 255 }

Definition at line 188 of file OSDLPixel.cc.

Initial value:
 
    {  95, 158, 160, 255 }

Definition at line 114 of file OSDLPixel.cc.

Initial value:
 
    { 127, 255,   0, 255 }

Definition at line 244 of file OSDLPixel.cc.

Initial value:
 
    { 210, 105,  30, 255 }

Definition at line 191 of file OSDLPixel.cc.

Initial value:
 
    { 184, 115,  51, 255 }

Definition at line 200 of file OSDLPixel.cc.

Initial value:
 
    { 255, 127,  80, 255 }

Definition at line 276 of file OSDLPixel.cc.

Initial value:
 
    { 255, 248, 220, 255 }

Definition at line 446 of file OSDLPixel.cc.

Initial value:
 
    {   0, 255, 255, 255 }

Definition at line 162 of file OSDLPixel.cc.

Initial value:
 
    { 184, 134,  11, 255 }

Definition at line 428 of file OSDLPixel.cc.

Initial value:
 
    {   0, 100,   0, 255 }

Shades of Green:

Definition at line 208 of file OSDLPixel.cc.

Initial value:
 
    {  85, 107,  47, 255 }

Definition at line 211 of file OSDLPixel.cc.

Initial value:
 
    { 255, 140,   0, 255 }

Shades of Orange:

Definition at line 258 of file OSDLPixel.cc.

Initial value:
 
    { 153,  50, 204, 255 }

Shades of Violet:

Definition at line 337 of file OSDLPixel.cc.

Initial value:
 
    { 233, 150, 122, 255 }

Definition at line 261 of file OSDLPixel.cc.

Initial value:
 
    {  72,  61, 139, 255 }

Definition at line 117 of file OSDLPixel.cc.

Initial value:
 
    {   0, 206, 209, 255 }

Definition at line 120 of file OSDLPixel.cc.

Initial value:
 
    { 148,   0, 211, 255 }

Definition at line 340 of file OSDLPixel.cc.

Initial value:
 
    { 255,  20, 147, 255 }

Shades of Red:

Definition at line 296 of file OSDLPixel.cc.

Initial value:
 
    {   0, 191, 255, 255 }

Definition at line 123 of file OSDLPixel.cc.

Pure magenta is the OSDL default color key.

Definition at line 462 of file OSDLPixel.cc.

Referenced by OSDL::Video::Palette::CreateMasterPalette().

Initial value:
 
    { 105, 105, 105, 255 }

Definition at line 91 of file OSDLPixel.cc.

Initial value:
 
    {  30, 144, 255, 255 }

Definition at line 126 of file OSDLPixel.cc.

Initial value:
 
    { 178,  34, 34 , 255 }

Definition at line 320 of file OSDLPixel.cc.

Initial value:
 
    { 255, 250, 240, 255 }

Definition at line 384 of file OSDLPixel.cc.

Initial value:
 
    {  34, 139,  34, 255 }

Definition at line 214 of file OSDLPixel.cc.

Initial value:
 
    { 220, 220, 220, 255 }

Definition at line 399 of file OSDLPixel.cc.

Initial value:
 
    { 248, 248, 255, 255 }

Definition at line 387 of file OSDLPixel.cc.

Initial value:
 
    { 255, 215,   0, 255 }

Definition at line 449 of file OSDLPixel.cc.

Initial value:
 
    { 218, 165,  32, 255 }

Definition at line 452 of file OSDLPixel.cc.

Initial value:
 
    {   0, 255,   0, 255 }

Definition at line 247 of file OSDLPixel.cc.

Referenced by selectColorDifferentFrom().

Initial value:
 
    { 173, 255,  47, 255 }

Definition at line 217 of file OSDLPixel.cc.

Initial value:
 
    { 190, 190, 190, 255 }

Definition at line 88 of file OSDLPixel.cc.

Initial value:
 
    { 240, 255, 240, 255 }

Definition at line 279 of file OSDLPixel.cc.

Initial value:
 
    { 255, 105, 180, 255 }

Definition at line 299 of file OSDLPixel.cc.

Initial value:
 
    { 205,  92,  92, 255 }

Definition at line 302 of file OSDLPixel.cc.

Initial value:
 
    { 255, 255, 240, 255 }

Definition at line 402 of file OSDLPixel.cc.

Initial value:
 
    { 240, 230, 140, 255 }

Definition at line 250 of file OSDLPixel.cc.

Initial value:
 
    { 230, 230, 250, 255 }

Definition at line 352 of file OSDLPixel.cc.

Initial value:
 
    { 255, 240, 245, 255 }

Definition at line 343 of file OSDLPixel.cc.

Initial value:
 
    { 124, 252,   0, 255 }

Definition at line 220 of file OSDLPixel.cc.

Initial value:
 
    { 255, 250, 205, 255 }

Definition at line 431 of file OSDLPixel.cc.

Initial value:
 
    { 173, 216, 230, 255 }

Definition at line 129 of file OSDLPixel.cc.

Initial value:
 
    { 240, 128, 128, 255 }

Definition at line 264 of file OSDLPixel.cc.

Initial value:
 
    { 224, 255, 255, 255 }

Definition at line 132 of file OSDLPixel.cc.

Initial value:
 
    { 238, 221, 130, 255 }

Definition at line 434 of file OSDLPixel.cc.

Initial value:
 
    { 211, 211, 211, 255 }

Definition at line 94 of file OSDLPixel.cc.

Initial value:
 
    { 255, 182, 193, 255 }

Definition at line 305 of file OSDLPixel.cc.

Initial value:
 
    { 255, 160, 122, 255 }

Definition at line 267 of file OSDLPixel.cc.

Initial value:
 
    { 255, 255, 224, 255 }

Definition at line 437 of file OSDLPixel.cc.

Initial value:
 
    {  50, 205,  50, 255 }

Definition at line 223 of file OSDLPixel.cc.

Initial value:
 
    { 250, 240, 230, 255 }

Definition at line 405 of file OSDLPixel.cc.

Initial value:
 
    { 255,   0, 255, 255 }

Pure magenta is the OSDL default color key.

Definition at line 355 of file OSDLPixel.cc.

Initial value:
 
    { 176,  48,  96, 255 }

Definition at line 358 of file OSDLPixel.cc.

Initial value:
 
    { 123, 104, 238, 255 }

Definition at line 135 of file OSDLPixel.cc.

Initial value:
 
    { 186,  85, 211, 255 }

Definition at line 346 of file OSDLPixel.cc.

Initial value:
 
    { 147, 112, 219, 255 }

Definition at line 349 of file OSDLPixel.cc.

Initial value:
 
    { 199,  21, 133, 255 }

Definition at line 308 of file OSDLPixel.cc.

Initial value:
 
    {  25,  25, 112, 255 }

Definition at line 168 of file OSDLPixel.cc.

Initial value:
 
    { 245, 255, 250, 255 }

Definition at line 226 of file OSDLPixel.cc.

Initial value:
 
    { 255, 228, 225, 255 }

Definition at line 311 of file OSDLPixel.cc.

Initial value:
 
    { 255, 228, 181, 255 }

Definition at line 455 of file OSDLPixel.cc.

Initial value:
 
    { 255, 222, 173, 255 }

Definition at line 390 of file OSDLPixel.cc.

Initial value:
 
    {   0,   0, 128, 255 }

Definition at line 138 of file OSDLPixel.cc.

Initial value:
 
    { 253, 245, 230, 255 }

Definition at line 393 of file OSDLPixel.cc.

Initial value:
 
    { 107, 142,  35, 255 }

Definition at line 229 of file OSDLPixel.cc.

Initial value:
 
    { 255, 165,   0, 255 }

Definition at line 282 of file OSDLPixel.cc.

Initial value:
 
    { 255,  69,   0, 255 }

Definition at line 314 of file OSDLPixel.cc.

Initial value:
 
    { 218, 112, 214, 255 }

Definition at line 361 of file OSDLPixel.cc.

Initial value:
 
    { 238, 232, 170, 255 }

Definition at line 440 of file OSDLPixel.cc.

Initial value:
 
    { 152, 251, 152, 255 }

Definition at line 232 of file OSDLPixel.cc.

Initial value:
 
    { 255, 239, 213, 255 }

Definition at line 443 of file OSDLPixel.cc.

Initial value:
 
    { 255, 218, 185, 255 }

Definition at line 270 of file OSDLPixel.cc.

Initial value:
 
    { 205, 133,  63, 255 }

Definition at line 194 of file OSDLPixel.cc.

Initial value:
 
    { 255, 192, 203, 255 }

Definition at line 323 of file OSDLPixel.cc.

Initial value:
 
    { 221, 160, 221, 255 }

Definition at line 364 of file OSDLPixel.cc.

Initial value:
 
    { 160,  32, 240, 255 }

Definition at line 367 of file OSDLPixel.cc.

Initial value:
 
    { 255,   0,   0, 255 }

Definition at line 326 of file OSDLPixel.cc.

Referenced by selectColorDifferentFrom().

Initial value:
 
    { 188, 143, 143, 255 }

Definition at line 179 of file OSDLPixel.cc.

Initial value:
 
    {  65, 105, 225, 255 }

Definition at line 141 of file OSDLPixel.cc.

Initial value:
 
    { 139,  69,  19, 255 }

Definition at line 182 of file OSDLPixel.cc.

Initial value:
 
    { 250, 128, 114, 255 }

Definition at line 285 of file OSDLPixel.cc.

Initial value:
 
    {  46, 139,  87, 255 }

Definition at line 235 of file OSDLPixel.cc.

Initial value:
 
    { 255, 245, 238, 255 }

Definition at line 408 of file OSDLPixel.cc.

Initial value:
 
    { 160,  82,  45, 255 }

Definition at line 288 of file OSDLPixel.cc.

Initial value:
 
    { 230, 232, 250, 255 }

Definition at line 100 of file OSDLPixel.cc.

Initial value:
 
    { 135, 206, 235, 255 }

Definition at line 144 of file OSDLPixel.cc.

Initial value:
 
    { 106,  90, 205, 255 }

Definition at line 147 of file OSDLPixel.cc.

Initial value:
 
    { 112, 128, 144, 255 }

Definition at line 97 of file OSDLPixel.cc.

Initial value:
 
    { 255, 250, 250, 255 }

Definition at line 411 of file OSDLPixel.cc.

Initial value:
 
    {   0, 255, 127, 255 }

Definition at line 238 of file OSDLPixel.cc.

Initial value:
 
    {  70, 130, 180, 255 }

Definition at line 150 of file OSDLPixel.cc.

Initial value:
 
    { 210, 180, 140, 255 }

Definition at line 197 of file OSDLPixel.cc.

Initial value:
 
    { 216, 191, 216, 255 }

Definition at line 370 of file OSDLPixel.cc.

Initial value:
 
    { 255,  99,  71, 255 }

Definition at line 329 of file OSDLPixel.cc.

Initial value:
 
    {   0,   0,   0,  0  }

Main color definitions: 115 different colors described by name.

Fully Transparent special color:

Come from http://eies.njit.edu/~walsh Copyright © 2001 Kevin J. Walsh 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 76 of file OSDLPixel.cc.

Initial value:
 
    {  64, 224, 208, 255 }

Definition at line 165 of file OSDLPixel.cc.

Initial value:
 
    { 238, 130, 238, 255 }

Definition at line 373 of file OSDLPixel.cc.

Initial value:
 
    { 208,  32, 144, 255 }

Definition at line 317 of file OSDLPixel.cc.

Initial value:
 
    { 245, 222, 179, 255 }

Definition at line 414 of file OSDLPixel.cc.

Initial value:
 
    { 245, 245, 245, 255 }

Definition at line 396 of file OSDLPixel.cc.

Initial value:
 
    { 255, 255,   0, 255 }

Definition at line 458 of file OSDLPixel.cc.

Initial value:
 
    { 154, 205,  50, 255 }

Definition at line 241 of file OSDLPixel.cc.

Generated on Mon Nov 29 14:06:09 2010 for OSDL by  doxygen 1.6.3