X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/a660d684eda27638bca0384b2058911a31c8e845..2f3f48883d514cc48cadb15f370bd6d52f49611b:/docs/latex/wx/palette.tex?ds=sidebyside diff --git a/docs/latex/wx/palette.tex b/docs/latex/wx/palette.tex index 5bee9c9b6a..7f8c2cc6f0 100644 --- a/docs/latex/wx/palette.tex +++ b/docs/latex/wx/palette.tex @@ -3,13 +3,22 @@ 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. -TODO: topic overview for wxPalette. - +%TODO: topic overview for wxPalette. \wxheading{Derived from} \helpref{wxGDIObject}{wxgdiobject}\\ \helpref{wxObject}{wxobject} +\wxheading{Include files} + + + +\wxheading{Predefined objects} + +Objects: + +{\bf wxNullPalette} + \wxheading{See also} \helpref{wxDC::SetPalette}{wxdcsetpalette}, \helpref{wxBitmap}{wxbitmap} @@ -26,11 +35,7 @@ Default constructor. Copy constructor. This uses reference counting so is a cheap operation. -\func{}{wxPalette}{\param{const wxPalette*}{ palette}} - -Copy constructor. This uses reference counting so is a cheap operation. - -\func{}{wxPalette}{\param{const int}{ n}, \param{const unsigned char* }{red},\\ +\func{}{wxPalette}{\param{int}{ n}, \param{const unsigned char* }{red},\\ \param{const unsigned char* }{green}, \param{const unsigned char* }{blue}} Creates a palette from arrays of size {\it n}, one for each @@ -52,6 +57,9 @@ red, blue or green component. \helpref{wxPalette::Create}{wxpalettecreate} +\perlnote{In wxPerl the third constructor form takes as parameters + 3 array references ( they must be of the same length ).} + \membersection{wxPalette::\destruct{wxPalette}} \func{}{\destruct{wxPalette}}{\void} @@ -60,7 +68,7 @@ Destructor. \membersection{wxPalette::Create}\label{wxpalettecreate} -\func{bool}{Create}{\param{const int}{ n}, \param{const unsigned char* }{red},\rtfsp +\func{bool}{Create}{\param{int}{ n}, \param{const unsigned char* }{red},\rtfsp \param{const unsigned char* }{green}, \param{const unsigned char* }{blue}} Creates a palette from arrays of size {\it n}, one for each @@ -109,7 +117,7 @@ The nearest palette index. \membersection{wxPalette::GetRGB}\label{wxpalettegetrgb} -\constfunc{bool}{GetPixel}{\param{const int}{ pixel}, \param{const unsigned char* }{red}, \param{const unsigned char* }{green},\rtfsp +\constfunc{bool}{GetPixel}{\param{int}{ pixel}, \param{const unsigned char* }{red}, \param{const unsigned char* }{green},\rtfsp \param{const unsigned char* }{blue}} Returns RGB values for a given palette index. @@ -132,6 +140,9 @@ TRUE if the operation was successful. \helpref{wxPalette::GetPixel}{wxpalettegetpixel} +\perlnote{In wxPerl this method takes only the {\tt pixel} parameter and + returns a 3-element list ( or the empty list upon failure ).} + \membersection{wxPalette::Ok}\label{wxpaletteok} \constfunc{bool}{Ok}{\void}