Erlang logo
User's Guide
Reference Manual
Release Notes
PDF
Top

wxErlang
Reference Manual
Version 1.7


Expand All
Contract All

Table of Contents

wxImage

MODULE

wxImage

MODULE SUMMARY

See external documentation: wxImage.

DESCRIPTION

See external documentation: wxImage.

All (default) image handlers are initialized.

DATA TYPES

wxImage()

An object reference, The representation is internal and can be changed without notice. It can't be used for comparsion stored on disc or distributed for use on other nodes.

EXPORTS

new() -> wxImage()

new(Name) -> wxImage()

Types:

Name = chardata() (see module unicode)

Equivalent to new(Name, []).

new(Width, Height) -> wxImage()

Types:

Width = integer()
Height = integer()

See external documentation.
Also:
new(Name, [Option]) -> wxImage() when
Name::unicode:chardata(),
Option :: {'type', integer()}
| {'index', integer()}.

new(Width, Height, Data) -> wxImage()

Types:

Width = integer()
Height = integer()
Data = binary()

See external documentation.
Also:
new(Width, Height, [Option]) -> wxImage() when
Width::integer(), Height::integer(),
Option :: {'clear', boolean()};
(Name, Mimetype, [Option]) -> wxImage() when
Name::unicode:chardata(), Mimetype::unicode:chardata(),
Option :: {'index', integer()}.

new(Width, Height, Data, Alpha) -> wxImage()

Types:

Width = integer()
Height = integer()
Data = binary()
Alpha = binary()

See external documentation.
Also:
new(Width, Height, Data, [Option]) -> wxImage() when
Width::integer(), Height::integer(), Data::binary(),
Option :: {'static_data', boolean()}.

new(Width, Height, Data, Alpha, Options::[Option]) -> wxImage()

Types:

Width = integer()
Height = integer()
Data = binary()
Alpha = binary()
Option = {static_data, boolean()}

blur(This, Radius) -> wxImage()

Types:

This = wxImage()
Radius = integer()

blurHorizontal(This, Radius) -> wxImage()

Types:

This = wxImage()
Radius = integer()

blurVertical(This, Radius) -> wxImage()

Types:

This = wxImage()
Radius = integer()

convertAlphaToMask(This) -> boolean()

Types:

This = wxImage()

convertAlphaToMask(This, Options::[Option]) -> boolean()

Types:

This = wxImage()
Option = {threshold, integer()}

convertToGreyscale(This) -> wxImage()

Types:

This = wxImage()

convertToGreyscale(This, Options::[Option]) -> wxImage()

Types:

This = wxImage()
Option = {lr, number()} | {lg, number()} | {lb, number()}

convertToMono(This, R, G, B) -> wxImage()

Types:

This = wxImage()
R = integer()
G = integer()
B = integer()

copy(This) -> wxImage()

Types:

This = wxImage()

create(This, Width, Height) -> boolean()

Types:

This = wxImage()
Width = integer()
Height = integer()

create(This, Width, Height, Data) -> boolean()

Types:

This = wxImage()
Width = integer()
Height = integer()
Data = binary()

See external documentation.
Also:
create(This, Width, Height, [Option]) -> boolean() when
This::wxImage(), Width::integer(), Height::integer(),
Option :: {'clear', boolean()}.

create(This, Width, Height, Data, Alpha) -> boolean()

Types:

This = wxImage()
Width = integer()
Height = integer()
Data = binary()
Alpha = binary()

See external documentation.
Also:
create(This, Width, Height, Data, [Option]) -> boolean() when
This::wxImage(), Width::integer(), Height::integer(), Data::binary(),
Option :: {'static_data', boolean()}.

create(This, Width, Height, Data, Alpha, Options::[Option]) -> boolean()

Types:

This = wxImage()
Width = integer()
Height = integer()
Data = binary()
Alpha = binary()
Option = {static_data, boolean()}

Destroy(This) -> ok

Types:

This = wxImage()

findFirstUnusedColour(This) -> Result

Types:

Result = {Res::boolean(), R::integer(), G::integer(), B::integer()}
This = wxImage()

findFirstUnusedColour(This, Options::[Option]) -> Result

Types:

Result = {Res::boolean(), R::integer(), G::integer(), B::integer()}
This = wxImage()
Option = {startR, integer()} | {startG, integer()} | {startB, integer()}

getImageExtWildcard() -> charlist() (see module unicode)

getAlpha(This) -> binary()

Types:

This = wxImage()

getAlpha(This, X, Y) -> integer()

Types:

This = wxImage()
X = integer()
Y = integer()

getBlue(This, X, Y) -> integer()

Types:

This = wxImage()
X = integer()
Y = integer()

getData(This) -> binary()

Types:

This = wxImage()

getGreen(This, X, Y) -> integer()

Types:

This = wxImage()
X = integer()
Y = integer()

getImageCount(Name) -> integer()

Types:

Name = chardata() (see module unicode)

Equivalent to getImageCount(Name, []).

getImageCount(Name, Options::[Option]) -> integer()

Types:

Name = chardata() (see module unicode)
Option = {type, wx_enum() (see module wx)}

See external documentation.
Type = ?wxBITMAP_TYPE_INVALID | ?wxBITMAP_TYPE_BMP | ?wxBITMAP_TYPE_BMP_RESOURCE | ?wxBITMAP_TYPE_RESOURCE | ?wxBITMAP_TYPE_ICO | ?wxBITMAP_TYPE_ICO_RESOURCE | ?wxBITMAP_TYPE_CUR | ?wxBITMAP_TYPE_CUR_RESOURCE | ?wxBITMAP_TYPE_XBM | ?wxBITMAP_TYPE_XBM_DATA | ?wxBITMAP_TYPE_XPM | ?wxBITMAP_TYPE_XPM_DATA | ?wxBITMAP_TYPE_TIF | ?wxBITMAP_TYPE_TIF_RESOURCE | ?wxBITMAP_TYPE_GIF | ?wxBITMAP_TYPE_GIF_RESOURCE | ?wxBITMAP_TYPE_PNG | ?wxBITMAP_TYPE_PNG_RESOURCE | ?wxBITMAP_TYPE_JPEG | ?wxBITMAP_TYPE_JPEG_RESOURCE | ?wxBITMAP_TYPE_PNM | ?wxBITMAP_TYPE_PNM_RESOURCE | ?wxBITMAP_TYPE_PCX | ?wxBITMAP_TYPE_PCX_RESOURCE | ?wxBITMAP_TYPE_PICT | ?wxBITMAP_TYPE_PICT_RESOURCE | ?wxBITMAP_TYPE_ICON | ?wxBITMAP_TYPE_ICON_RESOURCE | ?wxBITMAP_TYPE_ANI | ?wxBITMAP_TYPE_IFF | ?wxBITMAP_TYPE_TGA | ?wxBITMAP_TYPE_MACCURSOR | ?wxBITMAP_TYPE_MACCURSOR_RESOURCE | ?wxBITMAP_TYPE_ANY

getHeight(This) -> integer()

Types:

This = wxImage()

getMaskBlue(This) -> integer()

Types:

This = wxImage()

getMaskGreen(This) -> integer()

Types:

This = wxImage()

getMaskRed(This) -> integer()

Types:

This = wxImage()

getOrFindMaskColour(This) -> Result

Types:

Result = {Res::boolean(), R::integer(), G::integer(), B::integer()}
This = wxImage()

getPalette(This) -> wxPalette() (see module wxPalette)

Types:

This = wxImage()

getRed(This, X, Y) -> integer()

Types:

This = wxImage()
X = integer()
Y = integer()

getSubImage(This, Rect) -> wxImage()

Types:

This = wxImage()
Rect = {X::integer(), Y::integer(), W::integer(), H::integer()}

getWidth(This) -> integer()

Types:

This = wxImage()

hasAlpha(This) -> boolean()

Types:

This = wxImage()

hasMask(This) -> boolean()

Types:

This = wxImage()

getOption(This, Name) -> charlist() (see module unicode)

Types:

This = wxImage()
Name = chardata() (see module unicode)

getOptionInt(This, Name) -> integer()

Types:

This = wxImage()
Name = chardata() (see module unicode)

hasOption(This, Name) -> boolean()

Types:

This = wxImage()
Name = chardata() (see module unicode)

initAlpha(This) -> ok

Types:

This = wxImage()

initStandardHandlers() -> ok

isTransparent(This, X, Y) -> boolean()

Types:

This = wxImage()
X = integer()
Y = integer()

isTransparent(This, X, Y, Options::[Option]) -> boolean()

Types:

This = wxImage()
X = integer()
Y = integer()
Option = {threshold, integer()}

loadFile(This, Name) -> boolean()

Types:

This = wxImage()
Name = chardata() (see module unicode)

Equivalent to loadFile(This, Name, []).

loadFile(This, Name, Options::[Option]) -> boolean()

Types:

This = wxImage()
Name = chardata() (see module unicode)
Option = {type, integer()} | {index, integer()}

loadFile(This, Name, Mimetype, Options::[Option]) -> boolean()

Types:

This = wxImage()
Name = chardata() (see module unicode)
Mimetype = chardata() (see module unicode)
Option = {index, integer()}

ok(This) -> boolean()

Types:

This = wxImage()

removeHandler(Name) -> boolean()

Types:

Name = chardata() (see module unicode)

mirror(This) -> wxImage()

Types:

This = wxImage()

Equivalent to mirror(This, []).

mirror(This, Options::[Option]) -> wxImage()

Types:

This = wxImage()
Option = {horizontally, boolean()}

replace(This, R1, G1, B1, R2, G2, B2) -> ok

Types:

This = wxImage()
R1 = integer()
G1 = integer()
B1 = integer()
R2 = integer()
G2 = integer()
B2 = integer()

rescale(This, Width, Height) -> wxImage()

Types:

This = wxImage()
Width = integer()
Height = integer()

rescale(This, Width, Height, Options::[Option]) -> wxImage()

Types:

This = wxImage()
Width = integer()
Height = integer()
Option = {quality, wx_enum() (see module wx)}

See external documentation.
Quality = integer

resize(This, Size, Pos) -> wxImage()

Types:

This = wxImage()
Size = {W::integer(), H::integer()}
Pos = {X::integer(), Y::integer()}

resize(This, Size, Pos, Options::[Option]) -> wxImage()

Types:

This = wxImage()
Size = {W::integer(), H::integer()}
Pos = {X::integer(), Y::integer()}
Option = {r, integer()} | {g, integer()} | {b, integer()}

rotate(This, Angle, Centre_of_rotation) -> wxImage()

Types:

This = wxImage()
Angle = number()
Centre_of_rotation = {X::integer(), Y::integer()}

rotate(This, Angle, Centre_of_rotation, Options::[Option]) -> wxImage()

Types:

This = wxImage()
Angle = number()
Centre_of_rotation = {X::integer(), Y::integer()}
Option = {interpolating, boolean()} | {offset_after_rotation, {X::integer(), Y::integer()}}

rotateHue(This, Angle) -> ok

Types:

This = wxImage()
Angle = number()

rotate90(This) -> wxImage()

Types:

This = wxImage()

Equivalent to rotate90(This, []).

rotate90(This, Options::[Option]) -> wxImage()

Types:

This = wxImage()
Option = {clockwise, boolean()}

saveFile(This, Name) -> boolean()

Types:

This = wxImage()
Name = chardata() (see module unicode)

saveFile(This, Name, Type) -> boolean()

Types:

This = wxImage()
Name = chardata() (see module unicode)
Type = integer()

See external documentation.
Also:
saveFile(This, Name, Mimetype) -> boolean() when
This::wxImage(), Name::unicode:chardata(), Mimetype::unicode:chardata().

scale(This, Width, Height) -> wxImage()

Types:

This = wxImage()
Width = integer()
Height = integer()

scale(This, Width, Height, Options::[Option]) -> wxImage()

Types:

This = wxImage()
Width = integer()
Height = integer()
Option = {quality, wx_enum() (see module wx)}

See external documentation.
Quality = integer

size(This, Size, Pos) -> wxImage()

Types:

This = wxImage()
Size = {W::integer(), H::integer()}
Pos = {X::integer(), Y::integer()}

Equivalent to size(This, Size, Pos, []).

size(This, Size, Pos, Options::[Option]) -> wxImage()

Types:

This = wxImage()
Size = {W::integer(), H::integer()}
Pos = {X::integer(), Y::integer()}
Option = {r, integer()} | {g, integer()} | {b, integer()}

setAlpha(This, Alpha) -> ok

Types:

This = wxImage()
Alpha = binary()

Equivalent to setAlpha(This, Alpha, []).

setAlpha(This, Alpha, Options::[Option]) -> ok

Types:

This = wxImage()
Alpha = binary()
Option = {static_data, boolean()}

setAlpha(This, X, Y, Alpha) -> ok

Types:

This = wxImage()
X = integer()
Y = integer()
Alpha = integer()

setData(This, Data) -> ok

Types:

This = wxImage()
Data = binary()

Equivalent to setData(This, Data, []).

setData(This, Data, Options::[Option]) -> ok

Types:

This = wxImage()
Data = binary()
Option = {static_data, boolean()}

setData(This, Data, New_width, New_height) -> ok

Types:

This = wxImage()
Data = binary()
New_width = integer()
New_height = integer()

setData(This, Data, New_width, New_height, Options::[Option]) -> ok

Types:

This = wxImage()
Data = binary()
New_width = integer()
New_height = integer()
Option = {static_data, boolean()}

setMask(This) -> ok

Types:

This = wxImage()

Equivalent to setMask(This, []).

setMask(This, Options::[Option]) -> ok

Types:

This = wxImage()
Option = {mask, boolean()}

setMaskColour(This, R, G, B) -> ok

Types:

This = wxImage()
R = integer()
G = integer()
B = integer()

setMaskFromImage(This, Mask, Mr, Mg, Mb) -> boolean()

Types:

This = wxImage()
Mask = wxImage()
Mr = integer()
Mg = integer()
Mb = integer()

setOption(This, Name, Value) -> ok

Types:

This = wxImage()
Name = chardata() (see module unicode)
Value = integer()

See external documentation.
Also:
setOption(This, Name, Value) -> 'ok' when
This::wxImage(), Name::unicode:chardata(), Value::unicode:chardata().

setPalette(This, Palette) -> ok

Types:

This = wxImage()
Palette = wxPalette() (see module wxPalette)

setRGB(This, Rect, R, G, B) -> ok

Types:

This = wxImage()
Rect = {X::integer(), Y::integer(), W::integer(), H::integer()}
R = integer()
G = integer()
B = integer()

setRGB(This, X, Y, R, G, B) -> ok

Types:

This = wxImage()
X = integer()
Y = integer()
R = integer()
G = integer()
B = integer()

destroy(This::wxImage()) -> ok

Destroys this object, do not use object again