X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/5e5437e00bb1e42d24060e6115d2e6a042c1a93f..76ff52f7c9f4e0c33f44e2e3564b74530bab2641:/docs/latex/wx/image.tex diff --git a/docs/latex/wx/image.tex b/docs/latex/wx/image.tex index f8efd1e724..78a3f2f121 100644 --- a/docs/latex/wx/image.tex +++ b/docs/latex/wx/image.tex @@ -145,6 +145,15 @@ platform-dependent bitmap} \end{twocollist}} } +\perlnote{Constructors supported by wxPerl are:\par +\begin{itemize} +\item{Wx::Image->new( bitmap )} +\item{Wx::Image->new( width, height )} +\item{Wx::Image->new( name, type )} +\item{Wx::Image->new( name, mimetype )} +\end{itemize} +} + \membersection{wxImage::\destruct{wxImage}} \func{}{\destruct{wxImage}}{\void} @@ -187,6 +196,10 @@ on program start-up to look up colors. This ensures a very fast conversion, but the image quality won't be perfect (and could be better for photo images using more sophisticated dithering algorithms). +On Windows, if there is a palette present (set with SetPalette), it will be used when +creating the wxBitmap (most useful in 8-bit display mode). On other platforms, +the palette is currently ignored. + \membersection{wxImage::Copy}\label{wximagecopy} \constfunc{wxImage}{Copy}{\void} @@ -309,6 +322,15 @@ Gets the green value of the mask colour. Gets the red value of the mask colour. +\membersection{wxImage::GetPalette}\label{wximagegetpalette} + +\constfunc{const wxPalette\&}{GetPalette}{\void} + +Returns the palette associated with the image. Currently the palette is only +used in ConvertToBitmap under Windows. + +Eventually wxImage handlers will set the palette if one exists in the image file. + \membersection{wxImage::GetSubImage}\label{wximagegetsubimage} \constfunc{wxImage}{GetSubImage}{\param{const wxRect\&}{ rect}} @@ -458,6 +480,13 @@ mimetype from a file} \end{twocollist}} } +\perlnote{Methods supported by wxPerl are:\par +\begin{itemize} +\item{\$bitmap->LoadFile( name, type )} +\item{\$bitmap->LoadFile( name, mimetype )} +\end{itemize} +} + \membersection{wxImage::Ok}\label{wximageok} @@ -536,6 +565,13 @@ mimetype to the named file} \end{twocollist}} } +\perlnote{Methods supported by wxPerl are:\par +\begin{itemize} +\item{\$bitmap->SaveFile( name, type )} +\item{\$bitmap->SaveFile( name, mimetype )} +\end{itemize} +} + \membersection{wxImage::Mirror}\label{wximagemirror} \constfunc{wxImage}{Mirror}{\param{bool}{ horizontally = TRUE}} @@ -653,6 +689,13 @@ used, which is a number between 0 and 100 (0 is terrible, 100 is very good). \helpref{wxImage::GetOptionInt}{wximagegetoptionint},\rtfsp \helpref{wxImage::HasOption}{wximagehasoption} +\membersection{wxImage::SetPalette}\label{wximagesetpalette} + +\func{void}{SetPalette}{\param{const wxPalette\&}{ palette}} + +Associates a palette with the image. The palette may be used in ConvertToBitmap (MSW only at present) +or in file save operations (none as yet). + \membersection{wxImage::SetRGB}\label{wximagesetrgb} \func{void}{SetRGB}{\param{int }{x}, \param{int }{y}, \param{unsigned char }{red}, \param{unsigned char }{green}, \param{unsigned char }{blue}}