X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4483a3d2999a8337854c84a2e09614524fe5473e..c266eff98c5e44012647f54f38a1e29ecabd8759:/docs/latex/wx/image.tex diff --git a/docs/latex/wx/image.tex b/docs/latex/wx/image.tex index fa8d2da1e8..56a42b74d9 100644 --- a/docs/latex/wx/image.tex +++ b/docs/latex/wx/image.tex @@ -36,16 +36,18 @@ means that the pixel is 100\% opaque. Unlike RGB data, not all images have an alpha channel and before using \helpref{GetAlpha}{wximagegetalpha} you should check if this image contains -an alpha channel with \helpref{HasAlpha}{wximagehasalpha}. Note that currently only -images loaded from PNG files with transparency information will have an alpha -channel but alpha support will be added to the other formats as well (as well -as support for saving images with alpha channel which also isn't implemented). +an alpha channel with \helpref{HasAlpha}{wximagehasalpha}. Note that currently +only the PNG format has full alpha channel support so only the images loaded +from PNG files can have alpha and, if you initialize the image alpha channel +yourself using \helpref{SetAlpha}{wximagesetalpha}, you should save it in PNG +format to avoid losing it. + \wxheading{Available image handlers} The following image handlers are available. {\bf wxBMPHandler} is always installed by default. To use other image formats, install the appropriate -handler with \helpref{wxImage::AddHandler}{wximageaddhandler} or +handler with \helpref{wxImage::AddHandler}{wximageaddhandler} or call \helpref{wxInitAllImageHandlers}{wxinitallimagehandlers}. \twocolwidtha{5cm}% @@ -57,6 +59,7 @@ handler with \helpref{wxImage::AddHandler}{wximageaddhandler} or \twocolitem{\indexit{wxPCXHandler}}{For loading and saving (see below).} \twocolitem{\indexit{wxPNMHandler}}{For loading and saving (see below).} \twocolitem{\indexit{wxTIFFHandler}}{For loading and saving.} +\twocolitem{\indexit{wxTGAHandler}}{For loading only.} \twocolitem{\indexit{wxIFFHandler}}{For loading only.} \twocolitem{\indexit{wxXPMHandler}}{For loading and saving.} \twocolitem{\indexit{wxICOHandler}}{For loading and saving.} @@ -79,6 +82,10 @@ PNM format, {\bf wxPNMHandler} will always save as raw RGB. +\wxheading{Library} + +\helpref{wxCore}{librarieslist} + \wxheading{See also} \helpref{wxBitmap}{wxbitmap}, @@ -153,6 +160,7 @@ Creates an image from XPM data. \twocolitem{\indexit{wxBITMAP\_TYPE\_PCX}}{Load a PCX bitmap file.} \twocolitem{\indexit{wxBITMAP\_TYPE\_PNM}}{Load a PNM bitmap file.} \twocolitem{\indexit{wxBITMAP\_TYPE\_TIF}}{Load a TIFF bitmap file.} +\twocolitem{\indexit{wxBITMAP\_TYPE\_TGA}}{Load a TGA bitmap file.} \twocolitem{\indexit{wxBITMAP\_TYPE\_XPM}}{Load a XPM bitmap file.} \twocolitem{\indexit{wxBITMAP\_TYPE\_ICO}}{Load a Windows icon file (ICO).} \twocolitem{\indexit{wxBITMAP\_TYPE\_CUR}}{Load a Windows cursor file (CUR).} @@ -222,6 +230,7 @@ platform-dependent bitmap} \func{}{\destruct{wxImage}}{\void} Destructor. +See \helpref{reference-counted object destruction}{refcountdestruct} for more info. \membersection{wxImage::AddHandler}\label{wximageaddhandler} @@ -471,7 +480,7 @@ It is usually a good idea to prepend a description before passing the result to Example: \begin{verbatim} - wxFileDialog FileDlg( this, "Choose Image", ::wxGetCwd(), "", _("Image Files ") + wxImage::GetImageExtWildcard(), wxOPEN ); + wxFileDialog FileDlg( this, "Choose Image", ::wxGetCwd(), "", _("Image Files ") + wxImage::GetImageExtWildcard(), wxFD_OPEN ); \end{verbatim} \wxheading{See also} @@ -1298,36 +1307,6 @@ Assignment operator, using \helpref{reference counting}{trefcount}. Returns 'this' object. -\membersection{wxImage::operator $==$}\label{wximageequal} - -\constfunc{bool}{operator $==$}{\param{const wxImage\& }{image}} - -Equality operator. This operator tests whether the internal data pointers are -equal (a fast test). - -\wxheading{Parameters} - -\docparam{image}{Image to compare with 'this'} - -\wxheading{Return value} - -Returns true if the images were effectively equal, false otherwise. - - -\membersection{wxImage::operator $!=$}\label{wximagenotequal} - -\constfunc{bool}{operator $!=$}{\param{const wxImage\& }{image}} - -Inequality operator. This operator tests whether the internal data pointers are -unequal (a fast test). - -\wxheading{Parameters} - -\docparam{image}{Image to compare with 'this'} - -\wxheading{Return value} - -Returns true if the images were unequal, false otherwise. \section{\class{wxImageHandler}}\label{wximagehandler} @@ -1353,6 +1332,10 @@ created by IJG.) +\wxheading{Library} + +\helpref{wxCore}{librarieslist} + \wxheading{See also} \helpref{wxImage}{wximage},