File: wx115.htm

package info (click to toggle)
wxwin2-doc 2.01-1
links: PTS
area: main
in suites: potato
size: 6,540 kB
ctags: 5,968
sloc: cpp: 15,157; makefile: 434; sh: 6
file content (550 lines) | stat: -rw-r--r-- 18,319 bytes
<HTML>
<head><title>wxImage</title></head>

<BODY BGCOLOR=#FFFFFF>
<A NAME="wximage"></A><CENTER>
<A HREF="wx.htm"><img align=center src="contents.gif" BORDER=0 ALT="Contents"></A> <A HREF="wx22.htm#classref"><img align=center src="up.gif" BORDER=0 ALT="Up"></A> <A HREF="wx114.htm#wxicon"><img align=center src="back.gif" BORDER=0 ALT="Previous"></A> <A HREF="wx116.htm#wximagehandler"><img align=center src="forward.gif" BORDER=0 ALT="Next"></A> </CENTER><HR>

<H2>wxImage</H2>
<P>
This class encapsulates a platform-independent image. An image can be created
from data, or using the constructor taking a wxBitmap object. 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.<P>
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.<P>
<B><FONT COLOR="#FF0000">Derived from</FONT></B><P>
<A HREF="wx158.htm#wxobject">wxObject</A><P>
<B><FONT COLOR="#FF0000">Include files</FONT></B><P>
&lt;wx/image.h&gt;<P>
<B><FONT COLOR="#FF0000">See also</FONT></B><P>
<A HREF="wx32.htm#wxbitmap">wxBitmap</A><P>
<B><FONT COLOR="#FF0000">Members</FONT></B><P>
<A HREF="#wximageconstr">wxImage::wxImage</A><BR>
<A HREF="#topic448">wxImage::~wxImage</A><BR>
<A HREF="#wximageaddhandler">wxImage::AddHandler</A><BR>
<A HREF="#topic449">wxImage::CleanUpHandlers</A><BR>
<A HREF="#wximageconverttobitmap">wxImage::ConvertToBitmap</A><BR>
<A HREF="#wximagecreate">wxImage::Create</A><BR>
<A HREF="#wximagedestroy">wxImage::Destroy</A><BR>
<A HREF="#topic450">wxImage::FindHandler</A><BR>
<A HREF="#wximagegetblue">wxImage::GetBlue</A><BR>
<A HREF="#wximagegetdata">wxImage::GetData</A><BR>
<A HREF="#wximagegetgreen">wxImage::GetGreen</A><BR>
<A HREF="#wximagegetred">wxImage::GetRed</A><BR>
<A HREF="#topic451">wxImage::GetHandlers</A><BR>
<A HREF="#wximagegetheight">wxImage::GetHeight</A><BR>
<A HREF="#wximagegetmaskblue">wxImage::GetMaskBlue</A><BR>
<A HREF="#wximagegetmaskgreen">wxImage::GetMaskGreen</A><BR>
<A HREF="#wximagegetmaskred">wxImage::GetMaskRed</A><BR>
<A HREF="#wximagegetwidth">wxImage::GetWidth</A><BR>
<A HREF="#wximagehasmask">wxImage::HasMask</A><BR>
<A HREF="#topic452">wxImage::InitStandardHandlers</A><BR>
<A HREF="#topic453">wxImage::InsertHandler</A><BR>
<A HREF="#wximageloadfile">wxImage::LoadFile</A><BR>
<A HREF="#wximageok">wxImage::Ok</A><BR>
<A HREF="#topic454">wxImage::RemoveHandler</A><BR>
<A HREF="#wximagesavefile">wxImage::SaveFile</A><BR>
<A HREF="#wximagescale">wxImage::Scale</A><BR>
<A HREF="#wximagesetdata">wxImage::SetData</A><BR>
<A HREF="#wximagesetmask">wxImage::SetMask</A><BR>
<A HREF="#wximagesetmaskcolour">wxImage::SetMaskColour</A><BR>
<A HREF="#wximagesetrgb">wxImage::SetRGB</A><BR>
<A HREF="#topic455">wxImage::operator =</A><BR>
<A HREF="#topic456">wxImage::operator ==</A><BR>
<A HREF="#topic457">wxImage::operator !=</A><BR>
<P>

<HR>
<A NAME="wximageconstr"></A>
<H3>wxImage::wxImage</H3>
<P>
<B></B> <B>wxImage</B>()<P>
Default constructor.<P>
<B></B> <B>wxImage</B>(<B>const wxImage&amp; </B><I>image</I>)<P>
Copy constructor.<P>
<B></B> <B>wxImage</B>(<B>const wxBitmap&amp;</B><I> bitmap</I>)<P>
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.<P>
<B></B> <B>wxImage</B>(<B>int</B><I> width</I>, <B>int</B><I> height</I>)<P>
Creates an image with the given width and height.<P>
<B></B> <B>wxImage</B>(<B>const wxString&amp; </B><I>name</I>, <B>long</B><I> type = wxBITMAP_TYPE_PNG</I>)<P>
Loads an image from a file.<P>
<B></B> <B>wxImage</B>(<B>wxInputStream&amp; </B><I>stream</I>, <B>long</B><I> type = wxBITMAP_TYPE_PNG</I>)<P>
Loads an image from an input stream.<P>
<B><FONT COLOR="#FF0000">Parameters</FONT></B><P>
<I>width</I><UL><UL>
Specifies the width of the image.</UL></UL>
<P>
<I>height</I><UL><UL>
Specifies the height of the image.</UL></UL>
<P>
<I>name</I><UL><UL>
This refers to an image filename. Its meaning is determined by the <I>type</I> parameter.</UL></UL>
<P>
<I>stream</I><UL><UL>
This refers to an input stream. Its meaning is determined by the <I>type</I> parameter. It is equal to loading from file except that you provide opened stream (file, HTTP or any other custom class).</UL></UL>
<P>
<I>type</I><UL><UL>
May be one of the following:<P>

<TABLE>


<TR><TD VALIGN=TOP>
<B>wxBITMAP_TYPE_BMP</B>
</TD>

<TD VALIGN=TOP>
Load a Windows bitmap file.
</TD></TR>


<TR><TD VALIGN=TOP>
<B>wxBITMAP_TYPE_PNG</B>
</TD>

<TD VALIGN=TOP>
Load a PNG bitmap file.
</TD></TR>


<TR><TD VALIGN=TOP>
<B>wxBITMAP_TYPE_JPEG</B>
</TD>

<TD VALIGN=TOP>
Load a JPEG bitmap file.
</TD></TR>


</TABLE>
<P>
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.</UL></UL>
<P>
Note : you must call wxImage::AddHandler(new wxJPEGHandler) during application 
initialization in order to work with JPEGs.<P>
<B><FONT COLOR="#FF0000">See also</FONT></B><P>
<A HREF="wx115.htm#wximageloadfile">wxImage::LoadFile</A><P>

<HR>
<A NAME="topic448"></A>
<H3>wxImage::~wxImage</H3>
<P>
<B></B> <B>~wxImage</B>()<P>
Destructor.<P>

<HR>
<A NAME="wximageaddhandler"></A>
<H3>wxImage::AddHandler</H3>
<P>
<B>static void</B> <B>AddHandler</B>(<B>wxImageHandler*</B><I> handler</I>)<P>
Adds a handler to the end of the static list of format handlers.<P>
<I>handler</I><UL><UL>
A new image format handler object. There is usually only one instance
of a given handler class in an application session.</UL></UL>
<P>
<B><FONT COLOR="#FF0000">See also</FONT></B><P>
<A HREF="wx116.htm#wximagehandler">wxImageHandler</A><P>

<HR>
<A NAME="topic449"></A>
<H3>wxImage::CleanUpHandlers</H3>
<P>
<B>static void</B> <B>CleanUpHandlers</B>()<P>
Deletes all image handlers.<P>
This function is called by wxWindows on exit.<P>

<HR>
<A NAME="wximageconverttobitmap"></A>
<H3>wxImage::ConvertToBitmap</H3>
<P>
<B>wxBitmap</B> <B>ConvertToBitmap</B>() <B>const</B><P>
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.<P>

<HR>
<A NAME="wximagecreate"></A>
<H3>wxImage::Create</H3>
<P>
<B>bool</B> <B>Create</B>(<B>int</B><I> width</I>, <B>int</B><I> height</I>)<P>
Creates a fresh image.<P>
<B><FONT COLOR="#FF0000">Parameters</FONT></B><P>
<I>width</I><UL><UL>
The width of the image in pixels.</UL></UL>
<P>
<I>height</I><UL><UL>
The height of the image in pixels.</UL></UL>
<P>
<B><FONT COLOR="#FF0000">Return value</FONT></B><P>
TRUE if the call succeeded, FALSE otherwise.<P>

<HR>
<A NAME="wximagedestroy"></A>
<H3>wxImage::Destroy</H3>
<P>
<B>bool</B> <B>Destroy</B>()<P>
Destroys the image data.<P>

<HR>
<A NAME="topic450"></A>
<H3>wxImage::FindHandler</H3>
<P>
<B>static wxImageHandler*</B> <B>FindHandler</B>(<B>const wxString&amp; </B><I>name</I>)<P>
Finds the handler with the given name.<P>
<B>static wxImageHandler*</B> <B>FindHandler</B>(<B>const wxString&amp; </B><I>extension</I>, <B>long</B><I> imageType</I>)<P>
Finds the handler associated with the given extension and type.<P>
<B>static wxImageHandler*</B> <B>FindHandler</B>(<B>long </B><I>imageType</I>)<P>
Finds the handler associated with the given image type.<P>
<I>name</I><UL><UL>
The handler name.</UL></UL>
<P>
<I>extension</I><UL><UL>
The file extension, such as "bmp".</UL></UL>
<P>
<I>imageType</I><UL><UL>
The image type, such as wxBITMAP_TYPE_BMP.</UL></UL>
<P>
<B><FONT COLOR="#FF0000">Return value</FONT></B><P>
A pointer to the handler if found, NULL otherwise.<P>
<B><FONT COLOR="#FF0000">See also</FONT></B><P>
<A HREF="wx116.htm#wximagehandler">wxImageHandler</A><P>

<HR>
<A NAME="wximagegetblue"></A>
<H3>wxImage::GetBlue</H3>
<P>
<B>unsigned char</B> <B>GetBlue</B>(<B>int</B><I> x</I>, <B>int</B><I> y</I>) <B>const</B><P>
Returns the blue intensity at the given coordinate.<P>

<HR>
<A NAME="wximagegetdata"></A>
<H3>wxImage::GetData</H3>
<P>
<B>unsigned char*</B> <B>GetData</B>() <B>const</B><P>
Returns the image data as an array. This is most often used when doing
direct image manipulation. The return value points to an array of
chararcters in RGBGBRGB... format.<P>

<HR>
<A NAME="wximagegetgreen"></A>
<H3>wxImage::GetGreen</H3>
<P>
<B>unsigned char</B> <B>GetGreen</B>(<B>int</B><I> x</I>, <B>int</B><I> y</I>) <B>const</B><P>
Returns the green intensity at the given coordinate.<P>

<HR>
<A NAME="wximagegetred"></A>
<H3>wxImage::GetRed</H3>
<P>
<B>unsigned char</B> <B>GetRed</B>(<B>int</B><I> x</I>, <B>int</B><I> y</I>) <B>const</B><P>
Returns the red intensity at the given coordinate.<P>

<HR>
<A NAME="topic451"></A>
<H3>wxImage::GetHandlers</H3>
<P>
<B>static wxList&amp;</B> <B>GetHandlers</B>()<P>
Returns the static list of image format handlers.<P>
<B><FONT COLOR="#FF0000">See also</FONT></B><P>
<A HREF="wx116.htm#wximagehandler">wxImageHandler</A><P>

<HR>
<A NAME="wximagegetheight"></A>
<H3>wxImage::GetHeight</H3>
<P>
<B>int</B> <B>GetHeight</B>() <B>const</B><P>
Gets the height of the image in pixels.<P>

<HR>
<A NAME="wximagegetmaskblue"></A>
<H3>wxImage::GetMaskBlue</H3>
<P>
<B>unsigned char</B> <B>GetMaskBlue</B>() <B>const</B><P>
Gets the blue value of the mask colour.<P>

<HR>
<A NAME="wximagegetmaskgreen"></A>
<H3>wxImage::GetMaskGreen</H3>
<P>
<B>unsigned char</B> <B>GetMaskGreen</B>() <B>const</B><P>
Gets the green value of the mask colour.<P>

<HR>
<A NAME="wximagegetmaskred"></A>
<H3>wxImage::GetMaskRed</H3>
<P>
<B>unsigned char</B> <B>GetMaskRed</B>() <B>const</B><P>
Gets the red value of the mask colour.<P>

<HR>
<A NAME="wximagegetwidth"></A>
<H3>wxImage::GetWidth</H3>
<P>
<B>int</B> <B>GetWidth</B>() <B>const</B><P>
Gets the width of the image in pixels.<P>
<B><FONT COLOR="#FF0000">See also</FONT></B><P>
<A HREF="wx115.htm#wximagegetheight">wxImage::GetHeight</A><P>

<HR>
<A NAME="wximagehasmask"></A>
<H3>wxImage::HasMask</H3>
<P>
<B>bool</B> <B>HasMask</B>() <B>const</B><P>
Returns TRUE if there is a mask active, FALSE otherwise.<P>

<HR>
<A NAME="topic452"></A>
<H3>wxImage::InitStandardHandlers</H3>
<P>
<B>static void</B> <B>InitStandardHandlers</B>()<P>
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.<P>
This function is called by wxWindows on startup.<P>
<B><FONT COLOR="#FF0000">See also</FONT></B><P>
<A HREF="wx116.htm#wximagehandler">wxImageHandler</A><P>

<HR>
<A NAME="topic453"></A>
<H3>wxImage::InsertHandler</H3>
<P>
<B>static void</B> <B>InsertHandler</B>(<B>wxImageHandler*</B><I> handler</I>)<P>
Adds a handler at the start of the static list of format handlers.<P>
<I>handler</I><UL><UL>
A new image format handler object. There is usually only one instance
of a given handler class in an application session.</UL></UL>
<P>
<B><FONT COLOR="#FF0000">See also</FONT></B><P>
<A HREF="wx116.htm#wximagehandler">wxImageHandler</A><P>

<HR>
<A NAME="wximageloadfile"></A>
<H3>wxImage::LoadFile</H3>
<P>
<B>bool</B> <B>LoadFile</B>(<B>const wxString&amp;</B><I> name</I>, <B>long</B><I> type</I>)<P>
Loads an image from a file.<P>
<B>bool</B> <B>LoadFile</B>(<B>wxInputStream&amp;</B><I> stream</I>, <B>long</B><I> type</I>)<P>
Loads an image from an input stream.<P>
<B><FONT COLOR="#FF0000">Parameters</FONT></B><P>
<I>name</I><UL><UL>
A filename.
The meaning of <I>name</I> is determined by the <I>type</I> parameter.</UL></UL>
<P>
<I>stream</I><UL><UL>
An input stream.
The meaning of <I>stream</I> data is determined by the <I>type</I> parameter.</UL></UL>
<P>
<I>type</I><UL><UL>
One of the following values:<P>

<TABLE>


<TR><TD VALIGN=TOP>
<B>wxBITMAP_TYPE_BMP</B>
</TD>

<TD VALIGN=TOP>
Load a Windows image file.
</TD></TR>


<TR><TD VALIGN=TOP>
<B>wxBITMAP_TYPE_PNG</B>
</TD>

<TD VALIGN=TOP>
Load a PNG image file.
</TD></TR>


<TR><TD VALIGN=TOP>
<B>wxBITMAP_TYPE_JPEG</B>
</TD>

<TD VALIGN=TOP>
Load a JPEG image file.
</TD></TR>


</TABLE>
<P>
The validity of these flags depends on the platform and wxWindows configuration.</UL></UL>
<P>
<B><FONT COLOR="#FF0000">Return value</FONT></B><P>
TRUE if the operation succeeded, FALSE otherwise.<P>
<B><FONT COLOR="#FF0000">See also</FONT></B><P>
<A HREF="wx115.htm#wximagesavefile">wxImage::SaveFile</A><P>

<HR>
<A NAME="wximageok"></A>
<H3>wxImage::Ok</H3>
<P>
<B>bool</B> <B>Ok</B>() <B>const</B><P>
Returns TRUE if image data is present.<P>

<HR>
<A NAME="topic454"></A>
<H3>wxImage::RemoveHandler</H3>
<P>
<B>static bool</B> <B>RemoveHandler</B>(<B>const wxString&amp; </B><I>name</I>)<P>
Finds the handler with the given name, and removes it. The handler
is not deleted.<P>
<I>name</I><UL><UL>
The handler name.</UL></UL>
<P>
<B><FONT COLOR="#FF0000">Return value</FONT></B><P>
TRUE if the handler was found and removed, FALSE otherwise.<P>
<B><FONT COLOR="#FF0000">See also</FONT></B><P>
<A HREF="wx116.htm#wximagehandler">wxImageHandler</A><P>

<HR>
<A NAME="wximagesavefile"></A>
<H3>wxImage::SaveFile</H3>
<P>
<B>bool</B> <B>SaveFile</B>(<B>const wxString&amp; </B><I>name</I>, <B>int</B><I> type</I>)<P>
Saves a image in the named file.<P>
<B>bool</B> <B>SaveFile</B>(<B>wxOutputStream&amp; </B><I>stream</I>, <B>int</B><I> type</I>)<P>
Saves a image in the given stream.<P>
<B><FONT COLOR="#FF0000">Parameters</FONT></B><P>
<I>name</I><UL><UL>
A filename. The meaning of <I>name</I> is determined by the <I>type</I> parameter.</UL></UL>
<P>
<I>stream</I><UL><UL>
An output stream. The meaning of <I>stream</I> is determined by the <I>type</I> parameter.</UL></UL>
<P>
<I>type</I><UL><UL>
Currently two types can be used:<P>

<TABLE>


<TR><TD VALIGN=TOP>
<B>wxBITMAP_TYPE_PNG</B>
</TD>

<TD VALIGN=TOP>
Save a PNG image file.
</TD></TR>


<TR><TD VALIGN=TOP>
<B>wxBITMAP_TYPE_JPEG</B>
</TD>

<TD VALIGN=TOP>
Save a JPEG image file.
</TD></TR>


</TABLE>
<P>
The validity of these flags depends on the platform and wxWindows configuration
as well as user-added handlers.</UL></UL>
<P>
<B><FONT COLOR="#FF0000">Return value</FONT></B><P>
TRUE if the operation succeeded, FALSE otherwise.<P>
<B><FONT COLOR="#FF0000">Remarks</FONT></B><P>
Depending on how wxWindows has been configured, not all formats may be available.<P>
<B><FONT COLOR="#FF0000">See also</FONT></B><P>
<A HREF="wx115.htm#wximageloadfile">wxImage::LoadFile</A><P>

<HR>
<A NAME="wximagescale"></A>
<H3>wxImage::Scale</H3>
<P>
<B>wxImage</B> <B>Scale</B>(<B>int</B><I> width</I>, <B>int</B><I> height</I>)<P>
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.<P>

<HR>
<A NAME="wximagesetdata"></A>
<H3>wxImage::SetData</H3>
<P>
<B>void</B> <B>SetData</B>(<B>unsigned char*</B><I>data</I>)<P>
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.<P>

<HR>
<A NAME="wximagesetmask"></A>
<H3>wxImage::SetMask</H3>
<P>
<B>void</B> <B>SetMask</B>(<B>bool</B><I> hasMask = TRUE</I>)<P>
Specifies whether there is a mask or not. The area of the mask is determined by the current mask colour.<P>

<HR>
<A NAME="wximagesetmaskcolour"></A>
<H3>wxImage::SetMaskColour</H3>
<P>
<B>void</B> <B>SetMaskColour</B>(<B>unsigned char </B><I>red</I>, <B>unsigned char </B><I>blue</I>, <B>unsigned char </B><I>green</I>)<P>
Sets the mask colour for this image (and tells the image to use the mask).<P>

<HR>
<A NAME="wximagesetrgb"></A>
<H3>wxImage::SetRGB</H3>
<P>
<B>void</B> <B>SetRGB</B>(<B>int </B><I>x</I>, <B>int </B><I>y</I>, <B>unsigned char </B><I>red</I>, <B>unsigned char </B><I>blue</I>, <B>unsigned char </B><I>green</I>)<P>
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().<P>

<HR>
<A NAME="topic455"></A>
<H3>wxImage::operator =</H3>
<P>
<B>wxImage&amp; </B> <B>operator =</B>(<B>const wxImage&amp; </B><I>image</I>)<P>
Assignment operator. This operator does not copy any data, but instead
passes a pointer to the data in <I>image</I> and increments a reference
counter. It is a fast operation.<P>
<B><FONT COLOR="#FF0000">Parameters</FONT></B><P>
<I>image</I><UL><UL>
Image to assign.</UL></UL>
<P>
<B><FONT COLOR="#FF0000">Return value</FONT></B><P>
Returns 'this' object.<P>

<HR>
<A NAME="topic456"></A>
<H3>wxImage::operator ==</H3>
<P>
<B>bool</B> <B>operator ==</B>(<B>const wxImage&amp; </B><I>image</I>)<P>
Equality operator. This operator tests whether the internal data pointers are
equal (a fast test).<P>
<B><FONT COLOR="#FF0000">Parameters</FONT></B><P>
<I>image</I><UL><UL>
Image to compare with 'this'</UL></UL>
<P>
<B><FONT COLOR="#FF0000">Return value</FONT></B><P>
Returns TRUE if the images were effectively equal, FALSE otherwise.<P>

<HR>
<A NAME="topic457"></A>
<H3>wxImage::operator !=</H3>
<P>
<B>bool</B> <B>operator !=</B>(<B>const wxImage&amp; </B><I>image</I>)<P>
Inequality operator. This operator tests whether the internal data pointers are
unequal (a fast test).<P>
<B><FONT COLOR="#FF0000">Parameters</FONT></B><P>
<I>image</I><UL><UL>
Image to compare with 'this'</UL></UL>
<P>
<B><FONT COLOR="#FF0000">Return value</FONT></B><P>
Returns TRUE if the images were unequal, FALSE otherwise.<P>

</BODY></HTML>