wxPaletteA palette is a table that maps pixel values to RGB colours. It allows the colours of a low-depth bitmap, for example, to be mapped to the available colours in a display. The notion of palettes is becoming more and more obsolete nowadays and only the MSW port is still using a native palette. All other ports use generic code which is basically just an array of colours. It is likely that in the future the only use for palettes within wxWidgets will be for representing colour indeces from images (such as GIF or PNG). The image handlers for these formats have been modified to create a palette if there is such information in the original image file (usually 256 or less colour images). See wxImage for more information. Derived from Include files <wx/palette.h> Predefined objects Objects: wxNullPalette See also Members
wxPalette::wxPalette
wxPalette::wxPalettewxPalette() Default constructor. wxPalette(const wxPalette& palette) Copy constructor, uses reference counting.
wxPalette(int n, const unsigned char* red, Creates a palette from arrays of size n, one for each red, blue or green component. Parameters palette
n
red
green
blue
See also wxPerl note: In wxPerl the third constructor form takes as parameters 3 array references ( they must be of the same length ).
wxPalette::~wxPalette~wxPalette() Destructor. See reference-counted object destruction for more info.
wxPalette::Createbool Create(int n, const unsigned char* red, const unsigned char* green, const unsigned char* blue) Creates a palette from arrays of size n, one for each red, blue or green component. Parameters n
red
green
blue
Return value true if the creation was successful, false otherwise. See also
wxPalette::GetColoursCountint GetColoursCount() const Returns number of entries in palette.
wxPalette::GetPixelint GetPixel(unsigned char red, unsigned char green, unsigned char blue) const Returns a pixel value (index into the palette) for the given RGB values. Parameters red
green
blue
Return value The nearest palette index or wxNOT_FOUND for unexpected errors. See also
wxPalette::GetRGBbool GetRGB(int pixel, const unsigned char* red, const unsigned char* green, const unsigned char* blue) const Returns RGB values for a given palette index. Parameters pixel
red
green
blue
Return value true if the operation was successful. See also wxPerl note: In wxPerl this method takes only the pixel parameter and returns a 3-element list ( or the empty list upon failure ).
wxPalette::IsOkbool IsOk() const Returns true if palette data is present.
wxPalette::operator =wxPalette& operator =(const wxPalette& palette) Assignment operator, using reference counting.
|