X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/5873607e5c6d255f5692cc37637551eaeb2e4472..8dba8632c5bcd64724e2e9e2d40e295555a0cb86:/docs/latex/wx/image.tex diff --git a/docs/latex/wx/image.tex b/docs/latex/wx/image.tex index 78a3f2f121..30c7afb2cb 100644 --- a/docs/latex/wx/image.tex +++ b/docs/latex/wx/image.tex @@ -1,14 +1,15 @@ \section{\class{wxImage}}\label{wximage} This class encapsulates a platform-independent image. An image can be created -from data, or using the constructor taking a wxBitmap object. An image +from data, or using \helpref{wxBitmap::ConvertToImage}{wxbitmapconverttoimage}. An image can be loaded from a file in a variety of formats, and is extensible to new formats 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 \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 +the \helpref{wxBitmap::wxBitmap(wxImage,int depth)}{wxbitmapconstr} constructor. +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 @@ -23,13 +24,15 @@ handler with \helpref{wxImage::AddHandler}{wximageaddhandler} or \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.} +\twocolitem{\indexit{wxBMPHandler}}{Only for loading, always installed.} +\twocolitem{\indexit{wxPNGHandler}}{For loading and saving.} +\twocolitem{\indexit{wxJPEGHandler}}{For loading and saving.} +\twocolitem{\indexit{wxGIFHandler}}{Only for loading, due to legal issues.} +\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{wxXPMHandler}}{For loading and saving.} +\twocolitem{\indexit{wxICOHandler}}{For loading and saving.} \end{twocollist} When saving in PCX format, {\bf wxPCXHandler} will count the number of @@ -66,7 +69,8 @@ Copy constructor. \func{}{wxImage}{\param{const wxBitmap\&}{ bitmap}} -Constructs an image from a platform-dependent bitmap. This preserves +(Deprecated form, use \helpref{wxBitmap::ConvertToImage}{wxbitmapconverttoimage} +instead.) Constructs an image from a platform-dependent bitmap. This preserves mask information so that bitmaps and images can be converted back and forth without loss in that respect. @@ -74,10 +78,10 @@ and forth without loss in that respect. Creates an image with the given width and height. -\func{}{wxImage}{\param{int}{ width}, \param{int}{ height}, \param{unsigned char*}{ data}, \param{bool}{ static_data=FALSE}} +\func{}{wxImage}{\param{int}{ width}, \param{int}{ height}, \param{unsigned char*}{ data}, \param{bool}{ static\_data=FALSE}} Creates an image from given data with the given width and height. If -{\it static_data} is TRUE, then wxImage will not delete the actual +{\it static\_data} is TRUE, then wxImage will not delete the actual image data in its destructor, otherwise it will free it by calling {\it free()}. @@ -107,14 +111,16 @@ Loads an image from an input stream. \twocolwidtha{5cm}% \begin{twocollist} -\twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_BMP}}}{Load a Windows bitmap file.} -\twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_GIF}}}{Load a GIF bitmap file.} -\twocolitem{{\bf \indexit{wxBITMAP\_TYPE\_JPEG}}}{Load a JPEG bitmap file.} -\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.} +\twocolitem{\indexit{wxBITMAP\_TYPE\_BMP}}{Load a Windows bitmap file.} +\twocolitem{\indexit{wxBITMAP\_TYPE\_GIF}}{Load a GIF bitmap file.} +\twocolitem{\indexit{wxBITMAP\_TYPE\_JPEG}}{Load a JPEG bitmap file.} +\twocolitem{\indexit{wxBITMAP\_TYPE\_PNG}}{Load a PNG bitmap file.} +\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\_XPM}}{Load a XPM bitmap file.} +\twocolitem{\indexit{wxBITMAP\_TYPE\_ICO}}{Load a ICO Icon file.} +\twocolitem{\indexit{wxBITMAP\_TYPE\_ANY}}{Will try to autodetect the format.} \end{twocollist}} \docparam{mimetype}{MIME type string (for example 'image/jpeg')} @@ -173,7 +179,7 @@ of a given handler class in an application session.} \helpref{wxImageHandler}{wximagehandler} -\pythonnote{In wxPython this static method is named {\tt wxImage_AddHandler}.} +\pythonnote{In wxPython this static method is named {\tt wxImage\_AddHandler}.} \membersection{wxImage::CleanUpHandlers} \func{static void}{CleanUpHandlers}{\void} @@ -186,19 +192,16 @@ This function is called by wxWindows on exit. \constfunc{wxBitmap}{ConvertToBitmap}{\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 colour reduction has to take place. +Deprecated, use equivalent \helpref{wxBitmap constructor}{wxbitmapconstr} +(which takes wxImage and depth as its arguments) instead. -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::ConvertToMono}\label{wxbitmapconverttomono} -On Windows, if there is a palette present (set with SetPalette), it will be used when -creating the wxBitmap (most useful in 8-bit display mode). On other platforms, -the palette is currently ignored. +\constfunc{wxImage}{ConvertToMono}{\param{unsigned char}{ r}, \param{unsigned char}{ g}, \param{unsigned char}{ b}} + +Returns monochromatic version of the image. The returned image has white +colour where the original has {\it (r,g,b)} colour and black colour +everywhere else. \membersection{wxImage::Copy}\label{wximagecopy} @@ -228,6 +231,30 @@ TRUE if the call succeeded, FALSE otherwise. Destroys the image data. +\membersection{wxImage::FindFirstUnusedColour}\label{wximagefindfirstunusedcolour} + +\func{bool}{FindFirstUnusedColour}{\param{unsigned char *}{ r}, \param{unsigned char *}{ g}, \param{unsigned char *}{ b}, \param{unsigned char}{ startR = 1}, \param{unsigned char}{ startG = 0}, \param{unsigned char}{ startB = 0}} + +\wxheading{Parameters} + +\docparam{r,g,b}{Pointers to variables to save the colour.} + +\docparam{startR,startG,startB}{Initial values of the colour. Returned colour +will have RGB values equal to or greater than these.} + +Finds the first colour that is never used in the image. The search begins at +given initial colour and continues by increasing R, G and B components (in this +order) by 1 until an unused colour is found or the colour space exhausted. + +\wxheading{Return value} + +Returns FALSE if there is no unused colour left, TRUE on success. + +\wxheading{Notes} + +Note that this method involves computing the histogram, which is +computationally intensive operation. + \membersection{wxImage::FindHandler} \func{static wxImageHandler*}{FindHandler}{\param{const wxString\& }{name}} @@ -327,7 +354,7 @@ Gets the red value of the mask colour. \constfunc{const wxPalette\&}{GetPalette}{\void} Returns the palette associated with the image. Currently the palette is only -used in ConvertToBitmap under Windows. +used when converting to wxBitmap under Windows. Eventually wxImage handlers will set the palette if one exists in the image file. @@ -453,6 +480,8 @@ Loads an image from an input stream. \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\_XPM}}{Load a XPM image file.} +\twocolitem{{\bf wxBITMAP\_TYPE\_ICO}}{Load a ICO icon file.} \twocolitem{{\bf wxBITMAP\_TYPE\_ANY}}{Will try to autodetect the format.} \end{twocollist}} @@ -462,6 +491,8 @@ Loads an image from an input stream. Depending on how wxWindows has been configured, not all formats may be available. +wxBITMAP\_TYPE\_ICO will laod the largest image found, with the most colours + \wxheading{Return value} TRUE if the operation succeeded, FALSE otherwise. @@ -482,8 +513,8 @@ mimetype from a file} \perlnote{Methods supported by wxPerl are:\par \begin{itemize} -\item{\$bitmap->LoadFile( name, type )} -\item{\$bitmap->LoadFile( name, mimetype )} +\item{bitmap->LoadFile( name, type )} +\item{bitmap->LoadFile( name, mimetype )} \end{itemize} } @@ -539,6 +570,9 @@ Saves a image in the given stream. \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\_TIFF}}{Save a TIFF image file.} +\twocolitem{{\bf wxBITMAP\_TYPE\_XPM}}{Save a XPM image file.} +\twocolitem{{\bf wxBITMAP\_TYPE\_ICO}}{Save a ICO image file. (The size may be up to 255 wide by 127 high. A single image is saved in 8 colors at the size supplied.)} \end{twocollist}} \docparam{mimetype}{MIME type.} @@ -567,8 +601,8 @@ mimetype to the named file} \perlnote{Methods supported by wxPerl are:\par \begin{itemize} -\item{\$bitmap->SaveFile( name, type )} -\item{\$bitmap->SaveFile( name, mimetype )} +\item{bitmap->SaveFile( name, type )} +\item{bitmap->SaveFile( name, mimetype )} \end{itemize} } @@ -639,7 +673,7 @@ Example: if ( bmp.GetWidth() != 32 || bmp.GetHeight() != 32 ) { wxImage image(bmp); - bmp = image.Scale(32, 32).ConvertToBitmap(); + bmp = wxBitmap(image.Scale(32, 32)); // another possibility: image.Rescale(32, 32); @@ -672,6 +706,33 @@ Specifies whether there is a mask or not. The area of the mask is determined by Sets the mask colour for this image (and tells the image to use the mask). +\membersection{wxImage::SetMaskFromImage}\label{wximagesetmaskfromimage} + +\func{bool}{SetMaskFromImage}{\param{const wxImage\&}{ mask}, \param{unsigned char}{ mr}, \param{unsigned char}{ mg}, \param{unsigned char}{ mb}} + +\wxheading{Parameters} + +\docparam{mask}{The mask image to extract mask shape from. Must have same dimensions as the image.} + +\docparam{mr,mg,mb}{RGB value of pixels in {\it mask} that will be used to create the mask.} + +Sets image's mask so that the pixels that have RGB value of {\it mr,mg,mb} +in {\it mask} will be masked in the image. This is done by first finding an +unused colour in the image, setting this colour as the mask colour and then +using this colour to draw all pixels in the image who corresponding pixel +in {\it mask} has given RGB value. + +\wxheading{Return value} + +Returns FALSE if {\it mask} does not have same dimensions as the image or if +there is no unused colour left. Returns TRUE if the mask was successfully +applied. + +\wxheading{Notes} + +Note that this method involves computing the histogram, which is +computationally intensive operation. + \membersection{wxImage::SetOption}\label{wximagesetoption} \func{void}{SetOption}{\param{const wxString\&}{ name}, \param{const wxString\&}{ value}} @@ -693,8 +754,8 @@ used, which is a number between 0 and 100 (0 is terrible, 100 is very good). \func{void}{SetPalette}{\param{const wxPalette\&}{ palette}} -Associates a palette with the image. The palette may be used in ConvertToBitmap (MSW only at present) -or in file save operations (none as yet). +Associates a palette with the image. The palette may be used when converting +wxImage to wxBitmap (MSW only at present) or in file save operations (none as yet). \membersection{wxImage::SetRGB}\label{wximagesetrgb}