X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ff865c132a61e615bb7a157cd314d7f7428374a3..2d1d813e2dc392d2480a2dc9cdf61ce6330db72d:/docs/latex/wx/image.tex diff --git a/docs/latex/wx/image.tex b/docs/latex/wx/image.tex index 77cc3231c7..0b0719ea46 100644 --- a/docs/latex/wx/image.tex +++ b/docs/latex/wx/image.tex @@ -17,7 +17,7 @@ creation of a \helpref{wxMask}{wxmask} object associated to the bitmap object. \wxheading{Alpha channel support} -Starting from wxWindows 2.5.0 wxImage supports alpha channel data, that is in +Starting from wxWidgets 2.5.0 wxImage supports alpha channel data, that is in addition to a byte for the red, green and blue colour components for each pixel it also stores a byte representing the pixel opacity. The alpha value of $0$ corresponds to a transparent pixel (null opacity) while the value of $255$ @@ -29,7 +29,7 @@ alpha value with \helpref{HasAlpha}{wximagehasalpha}. In fact, currently only images loaded from PNG files with transparency information will have alpha channel but support for it will be added to the other formats as well (as well as support for saving images with alpha channel which is not still implemented -neither). +either). \wxheading{Available image handlers} @@ -154,7 +154,7 @@ the GIF and TIFF handler and as the largest and most colourful one by the ICO ha \wxheading{Remarks} -Depending on how wxWindows has been configured, not all formats may be available. +Depending on how wxWidgets has been configured, not all formats may be available. Note: any handler other than BMP must be previously initialized with \helpref{wxImage::AddHandler}{wximageaddhandler} or @@ -189,9 +189,13 @@ platform-dependent bitmap} \perlnote{Constructors supported by wxPerl are:\par \begin{itemize} \item{Wx::Image->new( bitmap )} +\item{Wx::Image->new( icon )} \item{Wx::Image->new( width, height )} -\item{Wx::Image->new( name, type )} -\item{Wx::Image->new( name, mimetype )} +\item{Wx::Image->new( width, height, data )} +\item{Wx::Image->new( file, type, index )} +\item{Wx::Image->new( file, mimetype, index )} +\item{Wx::Image->new( stream, type, index )} +\item{Wx::Image->new( stream, mimetype, index )} \end{itemize} } @@ -225,7 +229,7 @@ returns true if the current image handlers can read this file Deletes all image handlers. -This function is called by wxWindows on exit. +This function is called by wxWidgets on exit. \membersection{wxImage::ComputeHistogram}\label{wximagecomputehistogram} @@ -355,6 +359,29 @@ A pointer to the handler if found, NULL otherwise. \helpref{wxImageHandler}{wximagehandler} +\membersection{wxImage::GetImageExtWildcard} + +\func{static wxString}{GetImageExtWildcard}{\void} + +Iterates all registered wxImageHandler objects, and returns a string containing file extension masks +suitable for passing to file open/save dialog boxes. + +\wxheading{Return value} + +The format of the returned string is "(*.ext1;*.ext2)|*.ext1;*.ext2". + +It is usually a good idea to prepend a description before passing the result to the dialog. + +Example: + +\begin{verbatim} + wxFileDialog FileDlg( this, "Choose Image", ::wxGetWorkingDirectory(), "", _("Image Files ") + wxImage::GetImageExtWildcard(), wxOPEN ); +\end{verbatim} + +\wxheading{See also} + +\helpref{wxImageHandler}{wximagehandler} + \membersection{wxImage::GetAlpha}\label{wximagegetalpha} \constfunc{unsigned char}{GetAlpha}{\param{int}{ x}, \param{int}{ y}} @@ -564,7 +591,7 @@ Returns true if the given option is present. The function is case-insensitive to Internal use only. Adds standard image format handlers. It only install BMP for the time being, which is used by wxBitmap. -This function is called by wxWindows on startup, and shouldn't be called by +This function is called by wxWidgets on startup, and shouldn't be called by the user. \wxheading{See also} @@ -633,7 +660,7 @@ the GIF and TIFF handler and as the largest and most colourful one by the ICO ha \wxheading{Remarks} -Depending on how wxWindows has been configured, not all formats may be available. +Depending on how wxWidgets has been configured, not all formats may be available. Note: you can use \helpref{GetOptionInt}{wximagegetoptionint} to get the hotspot for loaded cursor file: @@ -693,6 +720,52 @@ true if the handler was found and removed, false otherwise. \helpref{wxImageHandler}{wximagehandler} +\membersection{wxImage::Mirror}\label{wximagemirror} + +\constfunc{wxImage}{Mirror}{\param{bool}{ horizontally = true}} + +Returns a mirrored copy of the image. The parameter {\it horizontally} +indicates the orientation. + +\membersection{wxImage::Replace}\label{wximagereplace} + +\func{void}{Replace}{\param{unsigned char}{ r1}, \param{unsigned char}{ g1}, \param{unsigned char}{ b1}, +\param{unsigned char}{ r2}, \param{unsigned char}{ g2}, \param{unsigned char}{ b2}} + +Replaces the colour specified by {\it r1,g1,b1} by the colour {\it r2,g2,b2}. + +\membersection{wxImage::Rescale}\label{wximagerescale} + +\func{wxImage \&}{Rescale}{\param{int}{ width}, \param{int}{ height}} + +Changes the size of the image in-place: after a call to this function, the +image will have the given width and height. + +Returns the (modified) image itself. + +\wxheading{See also} + +\helpref{Scale}{wximagescale} + +\membersection{wxImage::Rotate}\label{wximagerotate} + +\func{wxImage}{Rotate}{\param{double}{ angle}, \param{const wxPoint\& }{rotationCentre}, + \param{bool}{ interpolating = true}, \param{wxPoint*}{ offsetAfterRotation = NULL}} + +Rotates the image about the given point, by {\it angle} radians. Passing true +to {\it interpolating} results in better image quality, but is slower. If the +image has a mask, then the mask colour is used for the uncovered pixels in the +rotated image background. Else, black (rgb 0, 0, 0) will be used. + +Returns the rotated image, leaving this image intact. + +\membersection{wxImage::Rotate90}\label{wximagerotate90} + +\constfunc{wxImage}{Rotate90}{\param{bool}{ clockwise = true}} + +Returns a copy of the image rotated 90 degrees in the direction +indicated by {\it clockwise}. + \membersection{wxImage::SaveFile}\label{wximagesavefile} \constfunc{bool}{SaveFile}{\param{const wxString\& }{name}, \param{int}{ type}} @@ -742,7 +815,7 @@ true if the operation succeeded, false otherwise. \wxheading{Remarks} -Depending on how wxWindows has been configured, not all formats may be available. +Depending on how wxWidgets has been configured, not all formats may be available. Note: you can use \helpref{GetOptionInt}{wximagegetoptionint} to set the hotspot before saving an image into a cursor file (default hotspot is in @@ -774,52 +847,6 @@ mimetype to the named file} \end{itemize} } -\membersection{wxImage::Mirror}\label{wximagemirror} - -\constfunc{wxImage}{Mirror}{\param{bool}{ horizontally = true}} - -Returns a mirrored copy of the image. The parameter {\it horizontally} -indicates the orientation. - -\membersection{wxImage::Replace}\label{wximagereplace} - -\func{void}{Replace}{\param{unsigned char}{ r1}, \param{unsigned char}{ g1}, \param{unsigned char}{ b1}, -\param{unsigned char}{ r2}, \param{unsigned char}{ g2}, \param{unsigned char}{ b2}} - -Replaces the colour specified by {\it r1,g1,b1} by the colour {\it r2,g2,b2}. - -\membersection{wxImage::Rescale}\label{wximagerescale} - -\func{wxImage \&}{Rescale}{\param{int}{ width}, \param{int}{ height}} - -Changes the size of the image in-place: after a call to this function, the -image will have the given width and height. - -Returns the (modified) image itself. - -\wxheading{See also} - -\helpref{Scale}{wximagescale} - -\membersection{wxImage::Rotate}\label{wximagerotate} - -\func{wxImage}{Rotate}{\param{double}{ angle}, \param{const wxPoint\& }{rotationCentre}, - \param{bool}{ interpolating = true}, \param{wxPoint*}{ offsetAfterRotation = NULL}} - -Rotates the image about the given point, by {\it angle} radians. Passing true -to {\it interpolating} results in better image quality, but is slower. If the -image has a mask, then the mask colour is used for the uncovered pixels in the -rotated image background. Else, black (rgb 0, 0, 0) will be used. - -Returns the rotated image, leaving this image intact. - -\membersection{wxImage::Rotate90}\label{wximagerotate90} - -\constfunc{wxImage}{Rotate90}{\param{bool}{ clockwise = true}} - -Returns a copy of the image rotated 90 degrees in the direction -indicated by {\it clockwise}. - \membersection{wxImage::Scale}\label{wximagescale} \constfunc{wxImage}{Scale}{\param{int}{ width}, \param{int}{ height}} @@ -1019,7 +1046,7 @@ application initialisation. This software is based in part on the work of the Independent JPEG Group. -(Applies when wxWindows is linked with JPEG support. wxJPEGHandler uses libjpeg +(Applies when wxWidgets is linked with JPEG support. wxJPEGHandler uses libjpeg created by IJG.) \wxheading{Derived from}