X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/07aaa1a4b853b64e61c01a9daf8a322d3896c36b..598e55d7143d4fca6cd7e2562cff5310671b7cd3:/docs/latex/wx/image.tex diff --git a/docs/latex/wx/image.tex b/docs/latex/wx/image.tex index efcbd11191..b199e0c95f 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.} @@ -95,7 +98,7 @@ Default constructor. \func{}{wxImage}{\param{const wxImage\& }{image}} -Copy constructor. +Copy constructor, uses \helpref{reference counting}{trefcount}. \func{}{wxImage}{\param{const wxBitmap\&}{ bitmap}} @@ -128,7 +131,7 @@ Loads an image from a file. Loads an image from an input stream. -\func{}{wxImage}{\param{const char** }{xpmData}} +\func{}{wxImage}{\param{const char* const* }{xpmData}} Creates an image from XPM data. @@ -153,6 +156,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 +226,7 @@ platform-dependent bitmap} \func{}{\destruct{wxImage}}{\void} Destructor. +See \helpref{reference-counted object destruction}{refcountdestruct} for more info. \membersection{wxImage::AddHandler}\label{wximageaddhandler} @@ -248,7 +253,9 @@ returns true if the current image handlers can read this file \func{wxImage}{Blur}{\param{int}{ blurRadius}} -Blurs the image in both horizontal and vertical directions by the specified pixel {\it blurRadius}. +Blurs the image in both horizontal and vertical directions by the specified pixel +{\it blurRadius}. This should not be used when using a single mask colour +for transparency. \wxheading{See also} @@ -260,8 +267,8 @@ Blurs the image in both horizontal and vertical directions by the specified pixe \func{wxImage}{BlurHorizontal}{\param{int}{ blurRadius}} -Blurs the image in the horizontal direction only. - +Blurs the image in the horizontal direction only. This should not be used +when using a single mask colour for transparency. \wxheading{See also} \helpref{Blur}{wximageblur} @@ -272,7 +279,8 @@ Blurs the image in the horizontal direction only. \func{wxImage}{BlurVertical}{\param{int}{ blurRadius}} -Blurs the image in the vertical direction only. +Blurs the image in the vertical direction only. This should not be used +when using a single mask colour for transparency. \wxheading{See also} @@ -468,7 +476,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} @@ -881,9 +889,9 @@ mimetype from a file} -\membersection{wxImage::Ok}\label{wximageok} +\membersection{wxImage::IsOk}\label{wximageisok} -\constfunc{bool}{Ok}{\void} +\constfunc{bool}{IsOk}{\void} Returns true if image data is present. @@ -1095,9 +1103,6 @@ Returns a scaled version of the image. This is also useful for scaling bitmaps in general as the only other way to scale bitmaps is to blit a wxMemoryDC into another wxMemoryDC. -It may be mentioned that the GTK port uses this function internally -to scale bitmaps when using mapping modes in wxDC. - \docparam{quality}{Determines what method to use for resampling the image. Can be one of the following: \twocolwidtha{5cm}% @@ -1110,7 +1115,13 @@ It should be noted that although using wxIMAGE\_QUALITY\_HIGH produces much nice looking results it is a slower method. Downsampling will use the box averaging method which seems to operate very fast. If you are upsampling larger images using this method you will most likely notice that it is a bit slower and in extreme cases -it will be quite substantially slower as the bicubic algorithm has to process a lot of data. +it will be quite substantially slower as the bicubic algorithm has to process a lot of +data. + +It should also be noted that the high quality scaling may not work as expected +when using a single mask colour for transparency, as the scaling will blur the +image and will therefore remove the mask partially. Using the alpha channel +will work. Example: @@ -1281,9 +1292,7 @@ data. \func{wxImage\& }{operator $=$}{\param{const wxImage\& }{image}} -Assignment operator. This operator does not copy any data, but instead -passes a pointer to the data in {\it image} and increments a reference -counter. It is a fast operation. +Assignment operator, using \helpref{reference counting}{trefcount}. \wxheading{Parameters} @@ -1294,36 +1303,6 @@ counter. It is a fast operation. 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} @@ -1374,14 +1353,14 @@ Destroys the wxImageHandler object. \membersection{wxImageHandler::GetName}\label{wximagehandlergetname} -\constfunc{wxString}{GetName}{\void} +\constfunc{const wxString\&}{GetName}{\void} Gets the name of this handler. \membersection{wxImageHandler::GetExtension}\label{wximagehandlergetextension} -\constfunc{wxString}{GetExtension}{\void} +\constfunc{const wxString\&}{GetExtension}{\void} Gets the file extension associated with this handler. @@ -1411,7 +1390,7 @@ Gets the image type associated with this handler. \membersection{wxImageHandler::GetMimeType}\label{wximagehandlergetmimetype} -\constfunc{wxString}{GetMimeType}{\void} +\constfunc{const wxString\&}{GetMimeType}{\void} Gets the MIME type associated with this handler.