via image format handlers. Functions are available to set and get image bits, so
it can be used for basic image manipulation.
-A wxImage cannot (currently) be drawn directly to a wxDC. Instead, a platform-specific
-wxBitmap object must be created from it, and that bitmap drawn on the wxDC, using
-wxDC::DrawBitmap.
+A wxImage cannot (currently) be drawn directly to a \helpref{wxDC}{wxdc}. Instead,
+a platform-specific \helpref{wxBitmap}{wxbitmap} object must be created from it using
+the \helpref{ConvertToBitmap}{wximageconverttobitmap} function. This bitmap can then
+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).}
+\twocolitem{{\bf \indexit{wxTIFFHandler}}}{For loading and saving.}
+\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}
+\wxheading{Include files}
+
+<wx/image.h>
+
\wxheading{See also}
-\helpref{wxBitmap}{wxbitmap}
+\helpref{wxBitmap}{wxbitmap},
+\helpref{wxInitAllImageHandlers}{wxinitallimagehandlers}
\latexignore{\rtfignore{\wxheading{Members}}}
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}}
Loads an image from an input stream.
\docparam{height}{Specifies the height of the image.}
-\docparam{name}{This refers to an image filename. Its meaning is determined by the {\it type} parameter.}
+\docparam{name}{Name of the file from which to load the image.}
-\docparam{stream}{This refers to an input stream. Its meaning is determined by the {\it type} parameter. It is equal to loading from file except that you provide opened stream (file, HTTP or any other custom class).}
+\docparam{stream}{Opened input stream from which to load the image. Currently, the stream must support seeking.}
\docparam{type}{May be one of the following:
\twocolwidtha{5cm}%
\begin{twocollist}
\twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_BMP}}}{Load a Windows bitmap file.}
-\twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_PNG}}}{Load a PNG bitmap file.}
+\twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_GIF}}}{Load a GIF bitmap file.}
\twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_JPEG}}}{Load a JPEG bitmap file.}
-\end{twocollist}
+\twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_PNG}}}{Load a PNG 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\_TIF}}}{Load a TIFF bitmap file.}
+\twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_ANY}}}{Will try to autodetect the format.}
+\end{twocollist}}
+
+\docparam{mimetype}{MIME type string (for example 'image/jpeg')}
-The validity of these flags depends on the platform and wxWindows configuration.
-If all possible wxWindows settings are used, the loading a BMP (Windows bitmap) file,
-a PNG (portable network graphics) file and a JPEG file is supported on all platforms that
-implement wxImage.}
+\wxheading{Remarks}
+
+Depending on how wxWindows 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
+\helpref{wxInitAllImageHandlers}{wxinitallimagehandlers}.
\wxheading{See also}
\helpref{wxImage::LoadFile}{wximageloadfile}
+\pythonnote{Constructors supported by wxPython are:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{{\bf wxImage(name, flag)}}{Loads an image from a file}
+\twocolitem{{\bf wxNullImage()}}{Create a null image (has no size or
+image data)}
+\twocolitem{{\bf wxEmptyImage(width, height)}}{Creates an empty image
+of the given size}
+\twocolitem{{\bf wxImageFromMime(name, mimetype}}{Creates an image from
+the given file of the given mimetype}
+\twocolitem{{\bf wxImageFromBitmap(bitmap)}}{Creates an image from a
+platform-dependent bitmap}
+\end{twocollist}}
+}
+
\membersection{wxImage::\destruct{wxImage}}
\func{}{\destruct{wxImage}}{\void}
\helpref{wxImageHandler}{wximagehandler}
+\pythonnote{In wxPython this static method is named {\tt wxImage_AddHandler}.}
\membersection{wxImage::CleanUpHandlers}
\func{static void}{CleanUpHandlers}{\void}
Converts the image to a platform-specific bitmap object. This has to be done
to actually display an image as you cannot draw an image directly on a window.
The resulting bitmap will use the colour depth of the current system which entails
-that a (crude) colour reduction has to take place. When in 8-bit mode, this
-routine will use a color cube created on program start-up to look up colors.
-Still, the image quality won't be perfect for photo images.
+that a colour reduction has to take place.
+
+When in 8-bit mode (PseudoColour mode), the GTK port will use a color cube created
+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).
\membersection{wxImage::Create}\label{wximagecreate}
Finds the handler associated with the given image type.
+\func{static wxImageHandler*}{FindHandlerMime}{\param{const wxString\& }{mimetype}}
+
+Finds the handler associated with the given MIME type.
+
\docparam{name}{The handler name.}
\docparam{extension}{The file extension, such as ``bmp".}
\docparam{imageType}{The image type, such as wxBITMAP\_TYPE\_BMP.}
+\docparam{mimetype}{MIME type.}
+
\wxheading{Return value}
A pointer to the handler if found, NULL otherwise.
Gets the red value of the mask colour.
+\membersection{wxImage::GetSubImage}\label{wximagegetsubimage}
+
+\constfunc{wxImage}{GetSubImage}{\param{const wxRect\&}{ rect}}
+
+Returns a sub image of the current one as long as the rect belongs entirely to
+the image.
+
\membersection{wxImage::GetWidth}\label{wximagegetwidth}
\constfunc{int}{GetWidth}{\void}
\func{static void}{InitStandardHandlers}{\void}
-Adds the standard image format handlers, which, depending on wxWindows
-configuration, can be handlers for Windows BMP (loading), PNG
-(loading and saving) and JPEG (loading and saving) file formats.
+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.
+This function is called by wxWindows on startup, and shouldn't be called by
+the user.
\wxheading{See also}
\helpref{wxImageHandler}{wximagehandler}
+\helpref{wxInitAllImageHandlers}{wxinitallimagehandlers}
\membersection{wxImage::InsertHandler}
\membersection{wxImage::LoadFile}\label{wximageloadfile}
-\func{bool}{LoadFile}{\param{const wxString\&}{ name}, \param{long}{ type}}
+\func{bool}{LoadFile}{\param{const wxString\&}{ name}, \param{long}{ type = wxBITMAP\_TYPE\_ANY}}
-Loads an image from a file.
+\func{bool}{LoadFile}{\param{const wxString\&}{ name}, \param{const wxString\&}{ mimetype}}
+
+Loads an image from a file. If no handler type is provided, the library will
+try to autodetect the format.
\func{bool}{LoadFile}{\param{wxInputStream\&}{ stream}, \param{long}{ type}}
+\func{bool}{LoadFile}{\param{wxInputStream\&}{ stream}, \param{const wxString\&}{ mimetype}}
+
Loads an image from an input stream.
\wxheading{Parameters}
-\docparam{name}{A filename.
-The meaning of {\it name} is determined by the {\it type} parameter.}
+\docparam{name}{Name of the file from which to load the image.}
-\docparam{stream}{An input stream.
-The meaning of {\it stream} data is determined by the {\it type} parameter.}
+\docparam{stream}{Opened input stream from which to load the image. Currently, the stream must support seeking.}
\docparam{type}{One of the following values:
\twocolwidtha{5cm}%
\begin{twocollist}
\twocolitem{{\bf wxBITMAP\_TYPE\_BMP}}{Load a Windows image file.}
-\twocolitem{{\bf wxBITMAP\_TYPE\_PNG}}{Load a PNG image file.}
+\twocolitem{{\bf wxBITMAP\_TYPE\_GIF}}{Load a GIF image file.}
\twocolitem{{\bf wxBITMAP\_TYPE\_JPEG}}{Load a JPEG image file.}
-\end{twocollist}
+\twocolitem{{\bf wxBITMAP\_TYPE\_PCX}}{Load a PCX image file.}
+\twocolitem{{\bf wxBITMAP\_TYPE\_PNG}}{Load a PNG image file.}
+\twocolitem{{\bf wxBITMAP\_TYPE\_PNM}}{Load a PNM image file.}
+\twocolitem{{\bf wxBITMAP\_TYPE\_TIF}}{Load a TIFF image file.}
+\twocolitem{{\bf wxBITMAP\_TYPE\_ANY}}{Will try to autodetect the format.}
+\end{twocollist}}
-The validity of these flags depends on the platform and wxWindows configuration.}
+\docparam{mimetype}{MIME type string (for example 'image/jpeg')}
+
+\wxheading{Remarks}
+
+Depending on how wxWindows has been configured, not all formats may be available.
\wxheading{Return value}
\helpref{wxImage::SaveFile}{wximagesavefile}
+\pythonnote{In place of a single overloaded method name, wxPython
+implements the following methods:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{{\bf LoadFile(filename, type)}}{Loads an image of the given
+type from a file}
+\twocolitem{{\bf LoadMimeFile(filename, mimetype)}}{Loads an image of the given
+mimetype from a file}
+\end{twocollist}}
+}
+
+
\membersection{wxImage::Ok}\label{wximageok}
\constfunc{bool}{Ok}{\void}
\func{bool}{SaveFile}{\param{const wxString\& }{name}, \param{int}{ type}}
+\func{bool}{SaveFile}{\param{const wxString\& }{name}, \param{const wxString\&}{ mimetype}}
+
Saves a image in the named file.
\func{bool}{SaveFile}{\param{wxOutputStream\& }{stream}, \param{int}{ type}}
+\func{bool}{SaveFile}{\param{wxOutputStream\& }{stream}, \param{const wxString\&}{ mimetype}}
+
Saves a image in the given stream.
\wxheading{Parameters}
-\docparam{name}{A filename. The meaning of {\it name} is determined by the {\it type} parameter.}
+\docparam{name}{Name of the file to save the image to.}
-\docparam{stream}{An output stream. The meaning of {\it stream} is determined by the {\it type} parameter.}
+\docparam{stream}{Opened output stream to save the image to.}
-\docparam{type}{Currently two types can be used:
+\docparam{type}{Currently three types can be used:
\twocolwidtha{5cm}%
\begin{twocollist}
-\twocolitem{{\bf wxBITMAP\_TYPE\_PNG}}{Save a PNG image file.}
\twocolitem{{\bf wxBITMAP\_TYPE\_JPEG}}{Save a JPEG image file.}
-\end{twocollist}
+\twocolitem{{\bf wxBITMAP\_TYPE\_PNG}}{Save a PNG image file.}
+\twocolitem{{\bf wxBITMAP\_TYPE\_PCX}}{Save a PCX image file (tries to save as 8-bit if possible, falls back to 24-bit otherwise).}
+\twocolitem{{\bf wxBITMAP\_TYPE\_PNM}}{Save a PNM image file (as raw RGB always).}
+\twocolitem{{\bf wxBITMAP\_TYPE\_TIF}}{Save a TIFF image file.}
+\end{twocollist}}
-The validity of these flags depends on the platform and wxWindows configuration
-as well as user-added handlers.}
+\docparam{mimetype}{MIME type.}
\wxheading{Return value}
\helpref{wxImage::LoadFile}{wximageloadfile}
+\pythonnote{In place of a single overloaded method name, wxPython
+implements the following methods:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{{\bf SaveFile(filename, type)}}{Saves the image using the given
+type to the named file}
+\twocolitem{{\bf SaveMimeFile(filename, mimetype)}}{Saves the image using the given
+mimetype to the named file}
+\end{twocollist}}
+}
+
+\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::Scale}\label{wximagescale}
-\func{wxImage}{Scale}{\param{int}{ width}, \param{int}{ height}}
+\constfunc{wxImage}{Scale}{\param{int}{ width}, \param{int}{ height}}
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. Windows can do such
-scaling itself but in the GTK port, scaling bitmaps is done using
-this routine internally.
+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 mode in wxDC.
+
+Example:
+
+\begin{verbatim}
+ // get the bitmap from somewhere
+ wxBitmap bmp = ...;
+
+ // rescale it to have size of 32*32
+ if ( bmp.GetWidth() != 32 || bmp.GetHeight() != 32 )
+ {
+ wxImage image(bmp);
+ bmp = image.Scale(32, 32).ConvertToBitmap();
+
+ // another possibility:
+ image.Rescale(32, 32);
+ bmp = image;
+ }
+
+\end{verbatim}
+
+\wxheading{See also}
+
+\helpref{Rescale}{wximagerescale}
\membersection{wxImage::SetData}\label{wximagesetdata}
\func{void}{SetData}{\param{unsigned char*}{data}}
-Sets the image data without performing checks. The data given must have
+Sets the image data without performing checks. The data given must have
the size (width*height*3) or results will be unexpected. Don't use this
method if you aren't sure you know what you are doing.
Sets the pixel at the given coordinate. This routine performs bounds-checks
for the coordinate so it can be considered a safe way to manipulate the
data, but in some cases this might be too slow so that the data will have to
-be set directly. In that case you have to get that data by calling GetData().
+be set directly. In that case you will have to get access to the image data
+using the \helpref{GetData}{wximagegetdata} method.
\membersection{wxImage::operator $=$}
\wxheading{Note (Legal Issue)}
-This software is based in part on the work of
- the Independent JPEG Group.
+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
created by IJG.)
\helpref{wxObject}{wxobject}
+\wxheading{Include files}
+
+<wx/image.h>
+
\wxheading{See also}
\helpref{wxImage}{wximage}
+\helpref{wxInitAllImageHandlers}{wxinitallimagehandlers}
\latexignore{\rtfignore{\wxheading{Members}}}
Gets the file extension associated with this handler.
+\membersection{wxImageHandler::GetImageCount}\label{wximagehandlergetimagecount}
+
+\func{int}{GetImageCount}{\param{wxInputStream\&}{ stream}}
+
+If the image file contains more than one image and the image handler is capable
+of retrieving these individually, this function will return the number of
+available images.
+
+\docparam{stream}{Opened input stream for reading image data. Currently, the stream must support seeking.}
+
+\wxheading{Return value}
+
+Number of available images. For most image handles, this defaults to 1.
+
\membersection{wxImageHandler::GetType}
\constfunc{long}{GetType}{\void}
Gets the image type associated with this handler.
+\membersection{wxImageHandler::GetMimeType}
+
+\constfunc{wxString}{GetMimeType}{\void}
+
+Gets the MIME type associated with this handler.
+
\membersection{wxImageHandler::LoadFile}\label{wximagehandlerloadfile}
-\func{bool}{LoadFile}{\param{wxImage* }{image}, \param{wxInputStream\&}{ stream}}
+\func{bool}{LoadFile}{\param{wxImage* }{image}, \param{wxInputStream\&}{ stream}, \param{bool}{ verbose=TRUE}, \param{int}{ index=0}}
-Loads a image from a stream, putting the resulting data into {\it image}.
+Loads a image from a stream, putting the resulting data into {\it image}. If the image file contains
+more than one image and the image handler is capable of retrieving these individually, {\it index}
+indicates which image to read from the stream.
\wxheading{Parameters}
\docparam{image}{The image object which is to be affected by this operation.}
-\docparam{stream}{Opened input stream.
-The meaning of {\it stream} is determined by the {\it type} parameter.}
+\docparam{stream}{Opened input stream for reading image data.}
+
+\docparam{verbose}{If set to TRUE, errors reported by the image handler will produce wxLogMessages.}
+
+\docparam{index}{The index of the image in the file (starting from zero).}
\wxheading{Return value}
\docparam{image}{The image object which is to be affected by this operation.}
-\docparam{stream}{A stream. The meaning of {\it stream} is determined by the {\it type} parameter.}
+\docparam{stream}{Opened output stream for writing the data.}
\wxheading{Return value}
\docparam{name}{Handler type.}
+
+\membersection{wxImageHandler::SetMimeType}
+
+\func{void}{SetMimeType}{\param{const wxString\& }{mimetype}}
+
+Sets the handler MIME type.
+
+\wxheading{Parameters}
+
+\docparam{mimename}{Handler MIME type.}
+
projects / wxWidgets.git / blobdiff