wx.Palette

Inheritance diagram for wx.Palette:

Description

A 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 also

wx.DC.SetPalette, wx.Bitmap, wx.Image

Derived From

• wx.GDIObject
• wx.Object

Methods Summary

• __init__
• GetColoursCount
• GetPixel
• GetRGB
• IsOk

Properties Summary

• ColoursCount

Class API

Methods

__init__(red, green, blue)

Creates a palette from arrays of size n, one for each red, blue or green component.

Parameters:

• red (array of integers)
• green (array of integers)
• blue (array of integers)

Returns:

wx.Palette

---

GetColoursCount()

Returns number of entries in palette.

Returns:

int

---

GetPixel(red, green, blue)

Returns a pixel value (index into the palette) for the given RGB values.

Parameters:

• red (int): Red value.
• green (int): Green value.
• blue (int): Blue value.

Returns:

int

See also

GetRGB

---

GetRGB(pixel)

Returns RGB values for a given palette index.

Parameters:

• pixel (int): The palette index.

Returns:

bool

See also

GetPixel

---

IsOk()

Returns True if palette data is present.

Returns:

bool

---

Properties

ColoursCount

See GetColoursCount