X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/dcbd177f06597f98aae27bf53a4c98b4739102c7..83811067515a49ce16e9502c1cf217497a216b18:/docs/latex/wx/palette.tex diff --git a/docs/latex/wx/palette.tex b/docs/latex/wx/palette.tex index 25c98ec8f2..f46329e085 100644 --- a/docs/latex/wx/palette.tex +++ b/docs/latex/wx/palette.tex @@ -1,3 +1,14 @@ +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% Name: palette.tex +%% Purpose: wxPalette docs +%% Author: +%% Modified by: +%% Created: +%% RCS-ID: $Id$ +%% Copyright: (c) wxWidgets +%% License: wxWindows license +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + \section{\class{wxPalette}}\label{wxpalette} A palette is a table that maps pixel values to RGB colours. It allows the colours @@ -92,10 +103,16 @@ true if the creation was successful, false otherwise. \helpref{wxPalette::wxPalette}{wxpalettector} +\membersection{wxPalette::GetColoursCount}\label{wxpalettegetcolourscount} + +\constfunc{int}{GetColoursCount}{\void} + +Returns number of entries in palette. + \membersection{wxPalette::GetPixel}\label{wxpalettegetpixel} -\constfunc{int}{GetPixel}{\param{const unsigned char }{red}, \param{const unsigned char }{green},\rtfsp - \param{const unsigned char }{blue}} +\constfunc{int}{GetPixel}{\param{unsigned char }{red}, \param{unsigned char }{green},\rtfsp + \param{unsigned char }{blue}} Returns a pixel value (index into the palette) for the given RGB values. @@ -109,7 +126,7 @@ Returns a pixel value (index into the palette) for the given RGB values. \wxheading{Return value} -The nearest palette index. +The nearest palette index or {\tt wxNOT\_FOUND} for unexpected errors. \wxheading{See also} @@ -117,7 +134,7 @@ The nearest palette index. \membersection{wxPalette::GetRGB}\label{wxpalettegetrgb} -\constfunc{bool}{GetPixel}{\param{int}{ pixel}, \param{const unsigned char* }{red}, \param{const unsigned char* }{green},\rtfsp +\constfunc{bool}{GetRGB}{\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. @@ -171,5 +188,3 @@ fail the test. Inequality operator. Two palettes are not equal if they contain pointers to different underlying palette data. It does not compare each attribute. - -