]>
git.saurik.com Git - wxWidgets.git/blob - interface/wx/palette.h
1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: interface of wxPalette
4 // Author: wxWidgets team
6 // Licence: wxWindows licence
7 /////////////////////////////////////////////////////////////////////////////
12 A palette is a table that maps pixel values to RGB colours. It allows the
13 colours of a low-depth bitmap, for example, to be mapped to the available
14 colours in a display. The notion of palettes is becoming more and more
15 obsolete nowadays and only the MSW port is still using a native palette.
16 All other ports use generic code which is basically just an array of
19 It is likely that in the future the only use for palettes within wxWidgets
20 will be for representing colour indeces from images (such as GIF or PNG).
21 The image handlers for these formats have been modified to create a palette
22 if there is such information in the original image file (usually 256 or less
23 colour images). See wxImage for more information.
31 @see wxDC::SetPalette(), wxBitmap
33 class wxPalette
: public wxGDIObject
43 Copy constructor, uses @ref overview_refcount.
46 A reference to the palette to copy.
48 wxPalette(const wxPalette
& palette
);
51 Creates a palette from arrays of size @a n, one for each red, blue or
55 The number of indices in the palette.
57 An array of red values.
59 An array of green values.
61 An array of blue values.
64 In wxPerl this method takes as parameters
65 3 array references (they must be of the same length).
70 wxPalette(int n
, const unsigned char* red
,
71 const unsigned char* green
,
72 const unsigned char* blue
);
77 @see @ref overview_refcount_destruct "reference-counted object destruction"
82 Creates a palette from arrays of size @a n, one for each red, blue or
86 The number of indices in the palette.
88 An array of red values.
90 An array of green values.
92 An array of blue values.
94 @return @true if the creation was successful, @false otherwise.
98 bool Create(int n
, const unsigned char* red
,
99 const unsigned char* green
,
100 const unsigned char* blue
);
103 Returns number of entries in palette.
105 virtual int GetColoursCount() const;
108 Returns a pixel value (index into the palette) for the given RGB values.
117 @return The nearest palette index or @c wxNOT_FOUND for unexpected errors.
121 int GetPixel(unsigned char red
, unsigned char green
,
122 unsigned char blue
) const;
125 Returns RGB values for a given palette index.
130 Receives the red value.
132 Receives the green value.
134 Receives the blue value.
136 @return @true if the operation was successful.
139 In wxPerl this method takes only the @a pixel parameter and
140 returns a 3-element list (or the empty list upon failure).
145 bool GetRGB(int pixel
, unsigned char* red
, unsigned char* green
,
146 unsigned char* blue
) const;
149 Returns @true if palette data is present.
151 virtual bool IsOk() const;
154 Assignment operator, using @ref overview_refcount.
156 wxPalette
& operator =(const wxPalette
& palette
);
163 wxPalette wxNullPalette
;