Contents Up Previous Next

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, and that bitmap drawn on the wxDC, using wxDC::DrawBitmap.

Derived from

wxObject

Include files

<wx/image.h>

See also

wxBitmap

Members

wxImage::wxImage
wxImage::~wxImage
wxImage::AddHandler
wxImage::CleanUpHandlers
wxImage::ConvertToBitmap
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::GetWidth
wxImage::HasMask
wxImage::InitStandardHandlers
wxImage::InsertHandler
wxImage::LoadFile
wxImage::Ok
wxImage::RemoveHandler
wxImage::SaveFile
wxImage::Scale
wxImage::SetData
wxImage::SetMask
wxImage::SetMaskColour
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(const wxString& name, long type = wxBITMAP_TYPE_PNG)

Loads an image from a file.

wxImage(wxInputStream& stream, long type = wxBITMAP_TYPE_PNG)

Loads an image from an input stream.

Parameters

width

height

name

stream

type

Note : you must call wxImage::AddHandler(new wxJPEGHandler) during application initialization in order to work with JPEGs.

See also

wxImage::LoadFile


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

See also

wxImageHandler


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


wxImage::Create

bool Create(int width, int height)

Creates a fresh image.

Parameters

width

height

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.

name

extension

imageType

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::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()

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.

This function is called by wxWindows on startup.

See also

wxImageHandler


wxImage::InsertHandler

static void InsertHandler(wxImageHandler* handler)

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

handler

See also

wxImageHandler


wxImage::LoadFile

bool LoadFile(const wxString& name, long type)

Loads an image from a file.

bool LoadFile(wxInputStream& stream, long type)

Loads an image from an input stream.

Parameters

name

stream

type

Return value

TRUE if the operation succeeded, FALSE otherwise.

See also

wxImage::SaveFile


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

Return value

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

See also

wxImageHandler


wxImage::SaveFile

bool SaveFile(const wxString& name, int type)

Saves a image in the named file.

bool SaveFile(wxOutputStream& stream, int type)

Saves a image in the given stream.

Parameters

name

stream

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


wxImage::Scale

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


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::SetRGB

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

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


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

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

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

Return value

Returns TRUE if the images were unequal, FALSE otherwise.