]>
git.saurik.com Git - wxWidgets.git/blob - interface/palette.h
1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: interface of wxPalette
4 // Author: wxWidgets team
6 // Licence: wxWindows license
7 /////////////////////////////////////////////////////////////////////////////
13 A palette is a table that maps pixel values to RGB colours. It allows the
14 colours of a low-depth bitmap, for example, to be mapped to the available
15 colours in a display. The notion of palettes is becoming more and more
16 obsolete nowadays and only the MSW port is still using a native palette.
17 All other ports use generic code which is basically just an array of
20 It is likely that in the future the only use for palettes within wxWidgets
21 will be for representing colour indeces from images (such as GIF or PNG).
22 The image handlers for these formats have been modified to create a palette
23 if there is such information in the original image file (usually 256 or less
24 colour images). See wxImage for more information.
32 @see wxDC::SetPalette(), wxBitmap
34 class wxPalette
: public wxGDIObject
43 Copy constructor, uses @ref overview_refcount.
45 wxPalette(const wxPalette
& palette
);
47 Creates a palette from arrays of size @e n, one for each red, blue or
51 A pointer or reference to the palette to copy.
53 The number of indices in the palette.
55 An array of red values.
57 An array of green values.
59 An array of blue values.
63 wxPalette(int n
, const unsigned char* red
,
64 const unsigned char* green
,
65 const unsigned char* blue
);
70 @see @ref overview_refcount_destruct "reference-counted object destruction"
75 Creates a palette from arrays of size @e n, one for each red, blue or
79 The number of indices in the palette.
81 An array of red values.
83 An array of green values.
85 An array of blue values.
87 @returns @true if the creation was successful, @false otherwise.
91 bool Create(int n
, const unsigned char* red
,
92 const unsigned char* green
,
93 const unsigned char* blue
);
96 Returns number of entries in palette.
98 int GetColoursCount() const;
101 Returns a pixel value (index into the palette) for the given RGB values.
110 @returns The nearest palette index or @c wxNOT_FOUND for unexpected errors.
114 int GetPixel(unsigned char red
, unsigned char green
,
115 unsigned char blue
) const;
118 Returns RGB values for a given palette index.
123 Receives the red value.
125 Receives the green value.
127 Receives the blue value.
129 @returns @true if the operation was successful.
133 bool GetRGB(int pixel
, const unsigned char* red
,
134 const unsigned char* green
,
135 const unsigned char* blue
) const;
138 Returns @true if palette data is present.
143 Assignment operator, using @ref overview_refcount.
145 wxPalette
& operator =(const wxPalette
& palette
);
152 wxPalette wxNullPalette
;