wxImage

wxImage

Creation Parameters
Creates an image from given data with the given width and height. If data is set and flag is true, then wxImage will not delete the actual image data in its destructor, otherwise it will free it by calling free(). If data is not set and flag is true, the new image will be initialized to black. Otherwise, the image data will be uninitialized.
Functions/Procedures
Supertopics

wxImage

[func]
blur
( atom image, atom blurRadius )

Category: wxImage

Blurs the image in both horizontal and vertical directions by the specified pixel blurRadius. This should not be used when using a single mask colour for transparency.


wxImage

[func]
blur_horizontal
( atom image, atom blurRadius )

Category: wxImage

Blurs the image in the horizontal direction only. This should not be used when using a single mask colour for transparency.


wxImage

[func]
blur_vertical
( atom image, atom blurRadius )

Category: wxImage

Blurs the image in the vertical direction only. This should not be used when using a single mask colour for transparency.


wxImage

[func]
convert_to_greyscale
( atom image )

Category: wxImage

Returns a greyscale version of the image. The returned image uses the luminance component of the original to calculate the greyscale.


wxImage

[func]
convert_to_mono
( atom image, object rgb )

Category: wxImage

Returns monochromatic version of the image. The returned image has white colour where the original has (r,g,b) colour and black colour everywhere else.


wxImage

[func]
get_alpha
( object params )

Category: wxImage

Returns the alpha intensity of { wxImage, x, y }.


wxImage

[func]
get_blue
( atom color )

Category: wxImage

Returns the blue intensity of a wxColour or { wxImage, x, y }.


wxImage

[func]
get_green
( atom color )

Category: wxImage

Returns the green intensity of a wxColour or { wxImage, x, y }.


wxImage

[func]
get_option
( atom image, object name )

Category: wxImage

Gets a user-defined option. The function is case-insensitive to name.

For example, when saving as a JPEG file, the option quality is used, which is a number between 0 and 100 (0 is terrible, 100 is very good).


wxImage

[func]
get_option_int
( atom image, object name )

Category: wxImage

Gets a user-defined option as an integer. The function is case-insensitive to name.

If the given option is not present, the function returns 0. Use has_option as 0 is a possibly valid value for the option.


wxImage

[func]
get_red
( object params )

Category: wxImage

Returns the red intensity of a wxColour or { wxImage, x, y }.


wxImage

[func]
has_option
( atom image, object name )

Category: wxImage

Returns true if the given option is present. The function is case-insensitive to name.


wxImage

[func]
mirror
( atom image, atom horizontal )

Category: wxImage

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


wxImage

[func]
rescale
( atom image, atom width, atom height, atom quality )

Category: wxImage

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.

For a description of the quality parameter, see the scale function.

Returns the (modified) image itself.


wxImage

[func]
resize
( atom image, object size, object pos )

Category: wxImage

Changes the size of the image in-place without scaling it by adding either a border with the given colour or cropping as necessary. The image is pasted into a new image with the given size and background colour at the position pos relative to the upper left of the new image.


wxImage

[func]
rotate
( atom image, object angle, object center, atom interpolating, object offset )

Category: wxImage

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

[func]
rotate_90
( atom image, atom clockwise )

Category: wxImage

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


wxImage

[proc]
set_option
( atom image, object name, object value )

Category: wxImage

Sets a user-defined option. The function is case-insensitive to name.

For example, when saving as a JPEG file, the option quality is used, which is a number between 0 and 100 (0 is terrible, 100 is very good).