wxImage

Implements methods from the following classes

• wxObject

Methods

• wxImage
  Creates an image with the given size and clears it if requested.
• Blur
  Blurs the image in both horizontal and vertical directions by the specified pixel blurRadius.
• BlurHorizontal
  Blurs the image in the horizontal direction only.
• BlurVertical
  Blurs the image in the vertical direction only.
• Clear
  Initialize the image data with zeroes (the default) or with the byte value given as value.
• ClearAlpha
  Removes the alpha channel from the image.
• ConvertAlphaToMask
  If the image has alpha channel, this method converts it to mask using the specified colour as the mask colour.
• ConvertToDisabled
  Returns disabled (dimmed) version of the image.
• ConvertToGreyscale
  Returns a greyscale version of the image.
• ConvertToMono
  Returns monochromatic version of the image.
• Copy
  Returns an identical copy of this image.
• Create
  This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
• Destroy
  Destroys the image data.
• FindFirstUnusedColour
  Finds the first colour that is never used in the image.
• GetAlpha
  Return alpha value at given pixel location.
• GetBlue
  Returns the blue intensity at the given coordinate.
• GetData
  Returns the image data as an array.
• GetGreen
  Returns the green intensity at the given coordinate.
• GetHeight
  Gets the height of the image in pixels.
• GetMaskBlue
  Gets the blue value of the mask colour.
• GetMaskGreen
  Gets the green value of the mask colour.
• GetMaskRed
  Gets the red value of the mask colour.
• GetOption
  Gets a user-defined string-valued option.
• GetOptionInt
  Gets a user-defined integer-valued option.
• GetOrFindMaskColour
  Get the current mask colour or find a suitable unused colour that could be used as a mask colour.
• GetPalette
  Returns the palette associated with the image.
• GetRed
  Returns the red intensity at the given coordinate.
• GetSize
  Returns the size of the image in pixels.
• GetSubImage
  Returns a sub image of the current one as long as the rect belongs entirely to the image.
• GetType
  Gets the type of image found by LoadFile() or specified with SaveFile().
• GetWidth
  Gets the width of the image in pixels.
• HasAlpha
  Returns true if this image has alpha channel, false otherwise.
• HasMask
  Returns true if there is a mask active, false otherwise.
• HasOption
  Returns true if the given option is present.
• InitAlpha
  Initializes the image alpha channel data.
• IsOk
  Returns true if image data is present.
• IsTransparent
  Returns true if the given pixel is transparent, i.e. either has the mask colour if this image has a mask or if this image has alpha channel and alpha value of this pixel is strictly less than threshold.
• LoadFile
  Loads an image from an input stream.
• Mirror
  Returns a mirrored copy of the image.
• Paste
  Copy the data of the given image to the specified position in this image.
• Replace
  Replaces the colour specified by r1,g1,b1 by the colour r2,g2,b2.
• Rescale
  Changes the size of the image in-place by scaling it: after a call to this function,the image will have the given width and height.
• Resize
  Changes the size of the image in-place without scaling it by adding either a border with the given colour or cropping as necessary.
• Rotate
  Rotates the image about the given point, by angle radians.
• Rotate180
  Returns a copy of the image rotated by 180 degrees.
• Rotate90
  Returns a copy of the image rotated 90 degrees in the direction indicated by clockwise.
• RotateHue
  Rotates the hue of each pixel in the image by angle, which is a double in the range of -1.0 to +1.0, where -1.0 corresponds to -360 degrees and +1.0 corresponds to +360 degrees.
• SaveFile
  Saves an image in the given stream.
• Scale
  Returns a scaled version of the image.
• SetAlpha
  Sets the alpha value for the given pixel.
• SetData
  This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
• SetMask
  Specifies whether there is a mask or not.
• SetMaskColour
  Sets the mask colour for this image (and tells the image to use the mask).
• SetMaskFromImage
  Sets image's mask so that the pixels that have RGB value of mr,mg,mb in mask will be masked in the image.
• SetOption
  This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
• SetPalette
  Associates a palette with the image.
• SetRGB
  Sets the colour of the pixels within the given rectangle.
• SetType
  Set the type of image returned by GetType().
• Size
  Returns a resized version of this image without scaling it by adding either a border with the given colour or cropping as necessary.

Static Methods

• AddHandler
  Register an image handler.
• CanRead
  Returns true if at least one of the available image handlers can read the data in the given stream.
• CleanUpHandlers
  Deletes all image handlers.
• FindHandler
  Finds the handler associated with the given image type.
• FindHandlerMime
  Finds the handler associated with the given MIME type.
• GetImageCount
  If the image file contains more than one image and the image handler is capable of retrieving these individually, this function will return the number of available images.
• GetImageExtWildcard
  Iterates all registered wxImageHandler objects, and returns a string containing file extension masks suitable for passing to file open/save dialog boxes.
• InitStandardHandlers
  Internal use only.
• InsertHandler
  Adds a handler at the start of the static list of format handlers.
• RemoveHandler
  Finds the handler with the given name, and removes it.

wxImage

wxImage ( integer $width, integer $height, bool $clear=true )

Creates an image with the given size and clears it if requested.
wxImage ( )

Creates an empty wxImage object without an alpha channel.
wxImage ( wxSize $sz, bool $clear=true )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
wxImage ( string $name, wxBitmapType $type=wxBITMAP_TYPE_ANY, integer $index=-1 )

Creates an image from a file.
wxImage ( string $name, string $mimetype, integer $index=-1 )

Creates an image from a file using MIME-types to specify the type.
wxImage ( wxInputStream &$stream, wxBitmapType $type=wxBITMAP_TYPE_ANY, integer $index=-1 )

Creates an image from a stream.
wxImage ( wxInputStream &$stream, string $mimetype, integer $index=-1 )

Creates an image from a stream using MIME-types to specify the type.
wxImage ( wxSize $sz, integer &$data, integer &$alpha, bool $static_data=false )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
wxImage ( integer $width, integer $height, integer &$data, integer &$alpha, bool $static_data=false )

Creates an image from data in memory.
wxImage ( wxSize $sz, integer &$data, bool $static_data=false )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
wxImage ( integer $width, integer $height, integer &$data, bool $static_data=false )

Creates an image from data in memory.

AddHandler

static AddHandler ( wxImageHandler &$handler )

Register an image handler.

Blur

wxImage Blur ( integer $blurRadius )

Blurs the image in both horizontal and vertical directions by the specified pixel blurRadius.

BlurHorizontal

wxImage BlurHorizontal ( integer $blurRadius )

Blurs the image in the horizontal direction only.

BlurVertical

wxImage BlurVertical ( integer $blurRadius )

Blurs the image in the vertical direction only.

CanRead

static bool CanRead ( wxInputStream &$stream )

Returns true if at least one of the available image handlers can read the data in the given stream.
static bool CanRead ( string $filename )

Returns true if at least one of the available image handlers can read the file with the given name.

CleanUpHandlers

static CleanUpHandlers ( )

Deletes all image handlers.

Clear

Clear ( integer $value )

Initialize the image data with zeroes (the default) or with the byte value given as value.

ClearAlpha

ClearAlpha ( )

Removes the alpha channel from the image.

ConvertAlphaToMask

bool ConvertAlphaToMask ( integer $mr, integer $mg, integer $mb, integer $threshold=wxIMAGE_ALPHA_THRESHOLD )

If the image has alpha channel, this method converts it to mask using the specified colour as the mask colour.
bool ConvertAlphaToMask ( integer $threshold=wxIMAGE_ALPHA_THRESHOLD )

If the image has alpha channel, this method converts it to mask.

ConvertToDisabled

wxImage ConvertToDisabled ( integer $brightness=255 )

Returns disabled (dimmed) version of the image.

ConvertToGreyscale

wxImage ConvertToGreyscale ( )

Returns a greyscale version of the image.
wxImage ConvertToGreyscale ( float $weight_r, float $weight_g, float $weight_b )

Returns a greyscale version of the image.

ConvertToMono

wxImage ConvertToMono ( integer $r, integer $g, integer $b )

Returns monochromatic version of the image.

Copy

wxImage Copy ( )

Returns an identical copy of this image.

Create

bool Create ( wxSize $sz, integer &$data, integer &$alpha, bool $static_data=false )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool Create ( integer $width, integer $height, integer &$data, integer &$alpha, bool $static_data=false )

Creates a fresh image.
bool Create ( wxSize $sz, integer &$data, bool $static_data=false )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool Create ( integer $width, integer $height, integer &$data, bool $static_data=false )

Creates a fresh image.
bool Create ( wxSize $sz, bool $clear=true )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool Create ( integer $width, integer $height, bool $clear=true )

Creates a fresh image.

Destroy

Destroy ( )

Destroys the image data.

FindFirstUnusedColour

bool FindFirstUnusedColour ( integer &$r, integer &$g, integer &$b, integer $startR=1, integer $startG, integer $startB )

Finds the first colour that is never used in the image.

FindHandler

static wxImageHandler& FindHandler ( wxBitmapType $imageType )

Finds the handler associated with the given image type.
static wxImageHandler& FindHandler ( string $extension, wxBitmapType $imageType )

Finds the handler associated with the given extension and type.
static wxImageHandler& FindHandler ( string $name )

Finds the handler with the given name.

FindHandlerMime

static wxImageHandler& FindHandlerMime ( string $mimetype )

Finds the handler associated with the given MIME type.

GetAlpha

integer GetAlpha ( integer $x, integer $y )

Return alpha value at given pixel location.
integer& GetAlpha ( )

Returns pointer to the array storing the alpha values for this image.

GetBlue

integer GetBlue ( integer $x, integer $y )

Returns the blue intensity at the given coordinate.

GetData

integer& GetData ( )

Returns the image data as an array.

GetGreen

integer GetGreen ( integer $x, integer $y )

Returns the green intensity at the given coordinate.

GetHeight

integer GetHeight ( )

Gets the height of the image in pixels.

GetImageCount

static integer GetImageCount ( wxInputStream &$stream, wxBitmapType $type=wxBITMAP_TYPE_ANY )

If the image file contains more than one image and the image handler is capable of retrieving these individually, this function will return the number of available images.
static integer GetImageCount ( string $filename, wxBitmapType $type=wxBITMAP_TYPE_ANY )

If the image file contains more than one image and the image handler is capable of retrieving these individually, this function will return the number of available images.

GetImageExtWildcard

static string GetImageExtWildcard ( )

Iterates all registered wxImageHandler objects, and returns a string containing file extension masks suitable for passing to file open/save dialog boxes.

GetMaskBlue

integer GetMaskBlue ( )

Gets the blue value of the mask colour.

GetMaskGreen

integer GetMaskGreen ( )

Gets the green value of the mask colour.

GetMaskRed

integer GetMaskRed ( )

Gets the red value of the mask colour.

GetOption

string GetOption ( string $name )

Gets a user-defined string-valued option.

GetOptionInt

integer GetOptionInt ( string $name )

Gets a user-defined integer-valued option.

GetOrFindMaskColour

bool GetOrFindMaskColour ( integer &$r, integer &$g, integer &$b )

Get the current mask colour or find a suitable unused colour that could be used as a mask colour.

GetPalette

wxPalette GetPalette ( )

Returns the palette associated with the image.

GetRed

integer GetRed ( integer $x, integer $y )

Returns the red intensity at the given coordinate.

GetSize

wxSize GetSize ( )

Returns the size of the image in pixels.

GetSubImage

wxImage GetSubImage ( wxRect $rect )

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

GetType

wxBitmapType GetType ( )

Gets the type of image found by LoadFile() or specified with SaveFile().

GetWidth

integer GetWidth ( )

Gets the width of the image in pixels.

HasAlpha

bool HasAlpha ( )

Returns true if this image has alpha channel, false otherwise.

HasMask

bool HasMask ( )

Returns true if there is a mask active, false otherwise.

HasOption

bool HasOption ( string $name )

Returns true if the given option is present.

InitAlpha

InitAlpha ( )

Initializes the image alpha channel data.

InitStandardHandlers

static InitStandardHandlers ( )

Internal use only.

InsertHandler

static InsertHandler ( wxImageHandler &$handler )

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

IsOk

bool IsOk ( )

Returns true if image data is present.

IsTransparent

bool IsTransparent ( integer $x, integer $y, integer $threshold=wxIMAGE_ALPHA_THRESHOLD )

Returns true if the given pixel is transparent, i.e. either has the mask colour if this image has a mask or if this image has alpha channel and alpha value of this pixel is strictly less than threshold.

LoadFile

bool LoadFile ( wxInputStream &$stream, string $mimetype, integer $index=-1 )

Loads an image from an input stream.
bool LoadFile ( string $name, string $mimetype, integer $index=-1 )

Loads an image from a file.
bool LoadFile ( string $name, wxBitmapType $type=wxBITMAP_TYPE_ANY, integer $index=-1 )

Loads an image from a file.
bool LoadFile ( wxInputStream &$stream, wxBitmapType $type=wxBITMAP_TYPE_ANY, integer $index=-1 )

Loads an image from an input stream.

Mirror

wxImage Mirror ( bool $horizontally=true )

Returns a mirrored copy of the image.

Paste

Paste ( wxImage $image, integer $x, integer $y )

Copy the data of the given image to the specified position in this image.

RemoveHandler

static bool RemoveHandler ( string $name )

Finds the handler with the given name, and removes it.

Replace

Replace ( integer $r1, integer $g1, integer $b1, integer $r2, integer $g2, integer $b2 )

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

Rescale

wxImage& Rescale ( integer $width, integer $height, wxImageResizeQuality $quality=wxIMAGE_QUALITY_NORMAL )

Changes the size of the image in-place by scaling it: after a call to this function,the image will have the given width and height.

Resize

wxImage& Resize ( wxSize $size, wxPoint $pos, integer $red=-1, integer $green=-1, integer $blue=-1 )

Changes the size of the image in-place without scaling it by adding either a border with the given colour or cropping as necessary.

Rotate

wxImage Rotate ( float $angle, wxPoint $rotationCentre, bool $interpolating=true, wxPoint &$offsetAfterRotation=NULL )

Rotates the image about the given point, by angle radians.

Rotate180

wxImage Rotate180 ( )

Returns a copy of the image rotated by 180 degrees.

Rotate90

wxImage Rotate90 ( bool $clockwise=true )

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

RotateHue

RotateHue ( float $angle )

Rotates the hue of each pixel in the image by angle, which is a double in the range of -1.0 to +1.0, where -1.0 corresponds to -360 degrees and +1.0 corresponds to +360 degrees.

SaveFile

bool SaveFile ( wxOutputStream &$stream, wxBitmapType $type )

Saves an image in the given stream.
bool SaveFile ( string $name )

Saves an image in the named file.
bool SaveFile ( string $name, wxBitmapType $type )

Saves an image in the named file.
bool SaveFile ( wxOutputStream &$stream, string $mimetype )

Saves an image in the given stream.
bool SaveFile ( string $name, string $mimetype )

Saves an image in the named file.

Scale

wxImage Scale ( integer $width, integer $height, wxImageResizeQuality $quality=wxIMAGE_QUALITY_NORMAL )

Returns a scaled version of the image.

SetAlpha

SetAlpha ( integer $x, integer $y, integer $alpha )

Sets the alpha value for the given pixel.
SetAlpha ( integer &$alpha=NULL, bool $static_data=false )

This function is similar to SetData() and has similar restrictions.

SetData

SetData ( integer &$data, integer $new_width, integer $new_height, bool $static_data=false )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
SetData ( integer &$data, bool $static_data=false )

Sets the image data without performing checks.

SetMask

SetMask ( bool $hasMask=true )

Specifies whether there is a mask or not.

SetMaskColour

SetMaskColour ( integer $red, integer $green, integer $blue )

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

SetMaskFromImage

bool SetMaskFromImage ( wxImage $mask, integer $mr, integer $mg, integer $mb )

Sets image's mask so that the pixels that have RGB value of mr,mg,mb in mask will be masked in the image.

SetOption

SetOption ( string $name, integer $value )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
SetOption ( string $name, string $value )

Sets a user-defined option.

SetPalette

SetPalette ( wxPalette $palette )

Associates a palette with the image.

SetRGB

SetRGB ( wxRect $rect, integer $red, integer $green, integer $blue )

Sets the colour of the pixels within the given rectangle.

SetType

SetType ( wxBitmapType $type )

Set the type of image returned by GetType().

Size

wxImage Size ( wxSize $size, wxPoint $pos, integer $red=-1, integer $green=-1, integer $blue=-1 )

Returns a resized version of this image without scaling it by adding either a border with the given colour or cropping as necessary.