X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7468b994be5579ff57516f07e2d771831e73f65e..e0eedd681816255e89d4cb5725003f479eeb4133:/docs/latex/wx/image.tex?ds=inline diff --git a/docs/latex/wx/image.tex b/docs/latex/wx/image.tex index 87ead917f6..6199e3ec2d 100644 --- a/docs/latex/wx/image.tex +++ b/docs/latex/wx/image.tex @@ -14,6 +14,30 @@ be drawn in a device context, using \helpref{wxDC::DrawBitmap}{wxdcdrawbitmap}. One colour value of the image may be used as a mask colour which will lead to the automatic creation of a \helpref{wxMask}{wxmask} object associated to the bitmap object. +\wxheading{Available image handlers} + +The following image handlers are available. {\bf wxBMPHandler} is always +installed by default. To use other image formats, install the appropiate +handler with \helpref{wxImage::AddHandler}{wximageaddhandler} or +\helpref{wxInitAllImageHandlers}{wxinitallimagehandlers}. + +\twocolwidtha{5cm}% +\begin{twocollist} +\twocolitem{{\bf \indexit{wxBMPHandler}}}{Only for loading, always installed.} +\twocolitem{{\bf \indexit{wxPNGHandler}}}{For loading and saving.} +\twocolitem{{\bf \indexit{wxJPEGHandler}}}{For loading and saving.} +\twocolitem{{\bf \indexit{wxGIFHandler}}}{Only for loading, due to legal issues.} +\twocolitem{{\bf \indexit{wxPCXHandler}}}{For loading and saving (see below).} +\twocolitem{{\bf \indexit{wxPNMHandler}}}{For loading and saving (see below).} +\end{twocollist} + +When saving in PCX format, {\bf wxPCXHandler} will count the number of +different colours in the image; if there are 256 or less colours, it will +save as 8 bit, else it will save as 24 bit. + +Loading PNMs only works for ASCII or raw RGB images. When saving in +PNM format, {\bf wxPNMHandler} will always save as raw RGB. + \wxheading{Derived from} \helpref{wxObject}{wxobject} @@ -49,13 +73,13 @@ and forth without loss in that respect. Creates an image with the given width and height. -\func{}{wxImage}{\param{const wxString\& }{name}, \param{long}{ type = wxBITMAP\_TYPE\_PNG}} +\func{}{wxImage}{\param{const wxString\& }{name}, \param{long}{ type = wxBITMAP\_TYPE\_ANY}} \func{}{wxImage}{\param{const wxString\& }{name}, \param{const wxString\&}{ mimetype}} Loads an image from a file. -\func{}{wxImage}{\param{wxInputStream\& }{stream}, \param{long}{ type = wxBITMAP\_TYPE\_PNG}} +\func{}{wxImage}{\param{wxInputStream\& }{stream}, \param{long}{ type = wxBITMAP\_TYPE\_ANY}} \func{}{wxImage}{\param{wxInputStream\& }{stream}, \param{const wxString\&}{ mimetype}} @@ -81,6 +105,7 @@ Loads an image from an input stream. \twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_GIF}}}{Load a GIF bitmap file.} \twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_PCX}}}{Load a PCX bitmap file.} \twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_PNM}}}{Load a PNM bitmap file.} +\twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_ANY}}}{Will try to autodetect the format.} \end{twocollist} The validity of these flags depends on the platform and wxWindows configuration.