X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f6fcbb63d0a6ca455f2c81cd0fe42c4bb93b2b21..f37615d7896e9b976c5c251e567570c394f19cf8:/docs/latex/wx/image.tex diff --git a/docs/latex/wx/image.tex b/docs/latex/wx/image.tex index bbe5f315ab..bd0617ef98 100644 --- a/docs/latex/wx/image.tex +++ b/docs/latex/wx/image.tex @@ -10,8 +10,6 @@ A wxImage cannot (currently) be drawn directly to a wxDC. Instead, a platform-sp wxBitmap object must be created from it, and that bitmap drawn on the wxDC, using wxDC::DrawBitmap. -This class is currently only available under GTK and Windows. - \wxheading{Derived from} \helpref{wxObject}{wxobject} @@ -62,15 +60,16 @@ Loads an image from an input stream. \docparam{type}{May be one of the following: -\twocolwidtha{5cm} +\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\_JPEG}}}{Load a JPEG bitmap file.} \end{twocollist} 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 -and a PNG (portable network graphics) file is supported on all platforms that +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{See also} @@ -246,8 +245,8 @@ Returns TRUE if there is a mask active, FALSE otherwise. \func{static void}{InitStandardHandlers}{\void} Adds the standard image format handlers, which, depending on wxWindows -configuration, can be handlers for Windows BMP (loading) and PNG -(loading and saving) file formats. +configuration, can be handlers for Windows BMP (loading), PNG +(loading and saving) and JPEG (loading and saving) file formats. This function is called by wxWindows on startup. @@ -288,10 +287,11 @@ The meaning of {\it stream} data is determined by the {\it type} parameter.} \docparam{type}{One of the following values: -\twocolwidtha{5cm} +\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\_JPEG}}{Load a JPEG image file.} \end{twocollist} The validity of these flags depends on the platform and wxWindows configuration.} @@ -343,11 +343,12 @@ Saves a image in the given stream. \docparam{stream}{An output stream. The meaning of {\it stream} is determined by the {\it type} parameter.} -\docparam{type}{Currently only one type can be used: +\docparam{type}{Currently two types can be used: -\twocolwidtha{5cm} +\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} The validity of these flags depends on the platform and wxWindows configuration @@ -371,9 +372,9 @@ Depending on how wxWindows has been configured, not all formats may be available 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 do blit a wxMemoryDC into another wxMemoryDC. Windows can such scaling -itself, but on GTK scaling bitmaps is done using this routine -internally. +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. \membersection{wxImage::SetData}\label{wximagesetdata} @@ -393,7 +394,7 @@ Specifies whether there is a mask or not. The area of the mask is determined by \func{void}{SetMaskColour}{\param{unsigned char }{red}, \param{unsigned char }{blue}, \param{unsigned char }{green}} -Sets the mask colour for this image. +Sets the mask colour for this image (and tells the image to use the mask). \membersection{wxImage::SetRGB}\label{wximagesetrgb} @@ -459,6 +460,14 @@ If you wish to extend the capabilities of wxImage, derive a class from wxImageHa and add the handler using \helpref{wxImage::AddHandler}{wximageaddhandler} in your application initialisation. +\wxheading{Note (Legal Issue)} + +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.) + \wxheading{Derived from} \helpref{wxObject}{wxobject} @@ -575,4 +584,3 @@ Sets the handler type. \docparam{name}{Handler type.} -