## 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 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 wxDC. Instead, a platform-specific wxBitmap object must be created from it using the ConvertToBitmap function. This bitmap can then be drawn in a device context, using wxDC::DrawBitmap.

One colour value of the image may be used as a mask colour which will lead to the automatic creation of a wxMask object associated to the bitmap object.

Available image handlers

The following image handlers are available. wxBMPHandler is always installed by default. To use other image formats, install the appropiate handler with wxImage::AddHandler or wxInitAllImageHandlers.

wxBMPHandler | Only for loading, always installed.
wxPNGHandler | For loading and saving.
wxJPEGHandler | For loading and saving.
wxGIFHandler | Only for loading, due to legal issues.
wxPCXHandler | For loading and saving (see below).
wxPNMHandler | For loading and saving (see below).
wxTIFFHandler | For loading.

When saving in PCX format, 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, wxPNMHandler will always save as raw RGB.

Derived from

wxObject

Include files

<wx/image.h>

See also

wxBitmap, wxInitAllImageHandlers

Members

wxImage::wxImage
wxImage::~wxImage
wxImage::AddHandler
wxImage::CleanUpHandlers
wxImage::ConvertToBitmap
wxImage::Copy
wxImage::Create
wxImage::Destroy
wxImage::FindHandler
wxImage::GetBlue
wxImage::GetData
wxImage::GetGreen
wxImage::GetRed
wxImage::GetHandlers
wxImage::GetHeight
wxImage::GetMaskBlue
wxImage::GetMaskGreen
wxImage::GetMaskRed
wxImage::GetPalette
wxImage::GetSubImage
wxImage::GetWidth
wxImage::HasMask
wxImage::InitStandardHandlers
wxImage::InsertHandler
wxImage::LoadFile
wxImage::Ok
wxImage::RemoveHandler
wxImage::SaveFile
wxImage::Mirror
wxImage::Replace
wxImage::Rescale
wxImage::Rotate
wxImage::Rotate90
wxImage::Scale
wxImage::SetData
wxImage::SetMask
wxImage::SetMaskColour
wxImage::SetPalette
wxImage::SetRGB
wxImage::operator =
wxImage::operator ==
wxImage::operator !=

### wxImage::wxImage

wxImage()

Default constructor.

wxImage(const wxImage& image)

Copy constructor.

wxImage(const wxBitmap& bitmap)

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.

wxImage(int width, int height)

Creates an image with the given width and height.

wxImage(int width, int height, unsigned char* data, bool static_data=FALSE)

Creates an image from given data with the given width and height. If static_data is TRUE, then wxImage will not delete the actual image data in its destructor, otherwise it will free it by calling free().

wxImage(const wxString& name, long type = wxBITMAP_TYPE_ANY)

wxImage(const wxString& name, const wxString& mimetype)

Loads an image from a file.

wxImage(wxInputStream& stream, long type = wxBITMAP_TYPE_ANY)

wxImage(wxInputStream& stream, const wxString& mimetype)

Loads an image from an input stream.

Parameters

width

Specifies the width of the image.

height

Specifies the height of the image.

name

Name of the file from which to load the image.

stream

Opened input stream from which to load the image. Currently, the stream must support seeking.

type

May be one of the following:

wxBITMAP_TYPE_BMP | Load a Windows bitmap file.
wxBITMAP_TYPE_GIF | Load a GIF bitmap file.
wxBITMAP_TYPE_JPEG | Load a JPEG bitmap file.
wxBITMAP_TYPE_PNG | Load a PNG bitmap file.
wxBITMAP_TYPE_PCX | Load a PCX bitmap file.
wxBITMAP_TYPE_PNM | Load a PNM bitmap file.
wxBITMAP_TYPE_TIF | Load a TIFF bitmap file.
wxBITMAP_TYPE_ANY | Will try to autodetect the format.

mimetype

MIME type string (for example 'image/jpeg')

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 wxImage::AddHandler or wxInitAllImageHandlers.

See also

wxImage::LoadFile

wxPython note: Constructors supported by wxPython are:

wxImage(name, flag) | Loads an image from a file
wxNullImage() | Create a null image (has no size or image data)
wxEmptyImage(width, height) | Creates an empty image of the given size
wxImageFromMime(name, mimetype | Creates an image from the given file of the given mimetype
wxImageFromBitmap(bitmap) | Creates an image from a platform-dependent bitmap

### wxImage::~wxImage

~wxImage()

Destructor.

### wxImage::AddHandler

static void AddHandler(wxImageHandler* handler)

Adds a handler to the end of the static list of format handlers.

handler

A new image format handler object. There is usually only one instance of a given handler class in an application session.

See also

wxImageHandler

wxPython note: In wxPython this static method is named `wxImage_AddHandler`.

### wxImage::CleanUpHandlers

static void CleanUpHandlers()

Deletes all image handlers.

This function is called by wxWindows on exit.

### wxImage::ConvertToBitmap

wxBitmap ConvertToBitmap() const

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.

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).

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.

### wxImage::Copy

wxImage Copy() const

Returns an identical copy of the image.

### wxImage::Create

bool Create(int width, int height)

Creates a fresh image.

Parameters

width

The width of the image in pixels.

height

The height of the image in pixels.

Return value

TRUE if the call succeeded, FALSE otherwise.

### wxImage::Destroy

bool Destroy()

Destroys the image data.

### wxImage::FindHandler

static wxImageHandler* FindHandler(const wxString& name)

Finds the handler with the given name.

static wxImageHandler* FindHandler(const wxString& extension, long imageType)

Finds the handler associated with the given extension and type.

static wxImageHandler* FindHandler(long imageType)

Finds the handler associated with the given image type.

static wxImageHandler* FindHandlerMime(const wxString& mimetype)

Finds the handler associated with the given MIME type.

name

The handler name.

extension

The file extension, such as "bmp".

imageType

The image type, such as wxBITMAP_TYPE_BMP.

mimetype

MIME type.

Return value

A pointer to the handler if found, NULL otherwise.

See also

wxImageHandler

### wxImage::GetBlue

unsigned char GetBlue(int x, int y) const

Returns the blue intensity at the given coordinate.

### wxImage::GetData

unsigned char* GetData() const

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.

### wxImage::GetGreen

unsigned char GetGreen(int x, int y) const

Returns the green intensity at the given coordinate.

### wxImage::GetRed

unsigned char GetRed(int x, int y) const

Returns the red intensity at the given coordinate.

### wxImage::GetHandlers

static wxList& GetHandlers()

Returns the static list of image format handlers.

See also

wxImageHandler

### wxImage::GetHeight

int GetHeight() const

Gets the height of the image in pixels.

### wxImage::GetMaskBlue

unsigned char GetMaskBlue() const

Gets the blue value of the mask colour.

### wxImage::GetMaskGreen

unsigned char GetMaskGreen() const

Gets the green value of the mask colour.

### wxImage::GetMaskRed

unsigned char GetMaskRed() const

Gets the red value of the mask colour.

### wxImage::GetPalette

const wxPalette& GetPalette() const

Returns the palette associated with the image. Currently the palette is only used in ConvertToBitmap under Windows.

Eventually wxImage handlers will set the palette if one exists in the image file.

### wxImage::GetSubImage

wxImage GetSubImage(const wxRect& rect) const

Returns a sub image of the current one as long as the rect belongs entirely to the image.

### wxImage::GetWidth

int GetWidth() const

Gets the width of the image in pixels.

See also

wxImage::GetHeight

### wxImage::HasMask

bool HasMask() const

Returns TRUE if there is a mask active, FALSE otherwise.

### wxImage::InitStandardHandlers

static void InitStandardHandlers()

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 the user.

See also

wxImageHandler, wxInitAllImageHandlers

### wxImage::InsertHandler

static void InsertHandler(wxImageHandler* handler)

Adds a handler at the start of the static list of format handlers.

handler

A new image format handler object. There is usually only one instance of a given handler class in an application session.

See also

wxImageHandler

### wxImage::LoadFile

bool LoadFile(const wxString& name, long type = wxBITMAP_TYPE_ANY)

bool LoadFile(const wxString& name, const wxString& mimetype)

Loads an image from a file. If no handler type is provided, the library will try to autodetect the format.

bool LoadFile(wxInputStream& stream, long type)

bool LoadFile(wxInputStream& stream, const wxString& mimetype)

Loads an image from an input stream.

Parameters

name

Name of the file from which to load the image.

stream

Opened input stream from which to load the image. Currently, the stream must support seeking.

type

One of the following values:

wxBITMAP_TYPE_BMP | Load a Windows image file.
wxBITMAP_TYPE_GIF | Load a GIF image file.
wxBITMAP_TYPE_JPEG | Load a JPEG image file.
wxBITMAP_TYPE_PCX | Load a PCX image file.
wxBITMAP_TYPE_PNG | Load a PNG image file.
wxBITMAP_TYPE_PNM | Load a PNM image file.
wxBITMAP_TYPE_TIF | Load a TIFF image file.
wxBITMAP_TYPE_ANY | Will try to autodetect the format.

mimetype

MIME type string (for example 'image/jpeg')

Remarks

Depending on how wxWindows has been configured, not all formats may be available.

Return value

TRUE if the operation succeeded, FALSE otherwise.

See also

wxImage::SaveFile

wxPython note: In place of a single overloaded method name, wxPython implements the following methods:

LoadFile(filename, type) | Loads an image of the given type from a file
LoadMimeFile(filename, mimetype) | Loads an image of the given mimetype from a file

### wxImage::Ok

bool Ok() const

Returns TRUE if image data is present.

### wxImage::RemoveHandler

static bool RemoveHandler(const wxString& name)

Finds the handler with the given name, and removes it. The handler is not deleted.

name

The handler name.

Return value

TRUE if the handler was found and removed, FALSE otherwise.

See also

wxImageHandler

### wxImage::SaveFile

bool SaveFile(const wxString& name, int type)

bool SaveFile(const wxString& name, const wxString& mimetype)

Saves a image in the named file.

bool SaveFile(wxOutputStream& stream, int type)

bool SaveFile(wxOutputStream& stream, const wxString& mimetype)

Saves a image in the given stream.

Parameters

name

Name of the file to save the image to.

stream

Opened output stream to save the image to.

type

Currently three types can be used:

wxBITMAP_TYPE_JPEG | Save a JPEG image file.
wxBITMAP_TYPE_PNG | Save a PNG image file.
wxBITMAP_TYPE_PCX | Save a PCX image file (tries to save as 8-bit if possible, falls back to 24-bit otherwise).
wxBITMAP_TYPE_PNM | Save a PNM image file (as raw RGB always).

mimetype

MIME type.

Return value

TRUE if the operation succeeded, FALSE otherwise.

Remarks

Depending on how wxWindows has been configured, not all formats may be available.

See also

wxImage::LoadFile

wxPython note: In place of a single overloaded method name, wxPython implements the following methods:

SaveFile(filename, type) | Saves the image using the given type to the named file
SaveMimeFile(filename, mimetype) | Saves the image using the given mimetype to the named file

### wxImage::Mirror

wxImage Mirror(bool horizontally = TRUE) const

Returns a mirrored copy of the image. The parameter horizontally indicates the orientation.

### wxImage::Replace

void Replace(unsigned char r1, unsigned char g1, unsigned char b1, unsigned char r2, unsigned char g2, unsigned char b2)

Replaces the colour specified by r1,g1,b1 by the colour r2,g2,b2.

### wxImage::Rescale

wxImage & Rescale(int width, 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.

See also

Scale

### wxImage::Rotate

wxImage Rotate(double angle, const wxPoint& rotationCentre, bool interpolating = TRUE, wxPoint* offsetAfterRotation = NULL)

Rotates the image about the given point, by angle radians. Passing TRUE to 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.

### wxImage::Rotate90

wxImage Rotate90(bool clockwise = TRUE) const

Returns a copy of the image rotated 90 degrees in the direction indicated by clockwise.

### wxImage::Scale

wxImage Scale(int width, int height) const

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.

It may be mentioned that the GTK port uses this function internally to scale bitmaps when using mapping modes in wxDC.

Example:

        // 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;
        }

See also

Rescale

### wxImage::SetData

void SetData(unsigned char*data)

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.

### wxImage::SetMask

void SetMask(bool hasMask = TRUE)

Specifies whether there is a mask or not. The area of the mask is determined by the current mask colour.

### wxImage::SetMaskColour

void SetMaskColour(unsigned char red, unsigned char blue, unsigned char green)

Sets the mask colour for this image (and tells the image to use the mask).

### wxImage::SetPalette

void SetPalette(const wxPalette& palette)

Associates a palette with the image. Currently, the palette is not used.

### wxImage::SetRGB

void SetRGB(int x, int y, unsigned char red, unsigned char green, unsigned char blue)

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 will have to get access to the image data using the GetData method.

### wxImage::operator =

wxImage& operator =(const wxImage& image)

Assignment operator. This operator does not copy any data, but instead passes a pointer to the data in image and increments a reference counter. It is a fast operation.

Parameters

image

Image to assign.

Return value

Returns 'this' object.

### wxImage::operator ==

bool operator ==(const wxImage& image)

Equality operator. This operator tests whether the internal data pointers are equal (a fast test).

Parameters

image

Image to compare with 'this'

Return value

Returns TRUE if the images were effectively equal, FALSE otherwise.

### wxImage::operator !=

bool operator !=(const wxImage& image)

Inequality operator. This operator tests whether the internal data pointers are unequal (a fast test).

Parameters

image

Image to compare with 'this'

Return value

Returns TRUE if the images were unequal, FALSE otherwise.