Overviewerlang logo

Module wxImage

See external documentation: wxImage.

Description

See external documentation: wxImage.

All (default) image handlers are initialized.

Data Types

wxImage()

abstract datatype: 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.

Function Index

'Destroy'/1*See external documentation.
blur/2*See external documentation.
blurHorizontal/2*See external documentation.
blurVertical/2*See external documentation.
convertAlphaToMask/1*Equivalent to convertAlphaToMask(This, []).
convertAlphaToMask/2*See external documentation.
convertToGreyscale/1*Equivalent to convertToGreyscale(This, []).
convertToGreyscale/2*See external documentation.
convertToMono/4*See external documentation.
copy/1*See external documentation.
create/3*Equivalent to create(This, Width, Height, []).
create/4*See external documentation.
create/5*See external documentation.
create/6*See external documentation.
destroy/1*Destroys this object, do not use object again.
findFirstUnusedColour/1*Equivalent to findFirstUnusedColour(This, []).
findFirstUnusedColour/2*See external documentation.
getAlpha/1*See external documentation.
getAlpha/3*See external documentation.
getBlue/3*See external documentation.
getData/1*See external documentation.
getGreen/3*See external documentation.
getHeight/1*See external documentation.
getImageCount/1*Equivalent to getImageCount(Name, []).
getImageCount/2*See external documentation.
getImageExtWildcard/0*See external documentation.
getMaskBlue/1*See external documentation.
getMaskGreen/1*See external documentation.
getMaskRed/1*See external documentation.
getOption/2*See external documentation.
getOptionInt/2*See external documentation.
getOrFindMaskColour/1*See external documentation.
getPalette/1*See external documentation.
getRed/3*See external documentation.
getSubImage/2*See external documentation.
getWidth/1*See external documentation.
hasAlpha/1*See external documentation.
hasMask/1*See external documentation.
hasOption/2*See external documentation.
initAlpha/1*See external documentation.
initStandardHandlers/0*See external documentation.
isTransparent/3*Equivalent to isTransparent(This, X, Y, []).
isTransparent/4*See external documentation.
loadFile/2*Equivalent to loadFile(This, Name, []).
loadFile/3*See external documentation.
loadFile/4*See external documentation.
mirror/1*Equivalent to mirror(This, []).
mirror/2*See external documentation.
new/0*See external documentation.
new/1*Equivalent to new(Name, []).
new/2*See external documentation.
new/3*See external documentation.
new/4*See external documentation.
new/5*See external documentation.
ok/1*See external documentation.
removeHandler/1*See external documentation.
replace/7*See external documentation.
rescale/3*Equivalent to rescale(This, Width, Height, []).
rescale/4*See external documentation.
resize/3*Equivalent to resize(This, Size, Pos, []).
resize/4*See external documentation.
rotate/3*Equivalent to rotate(This, Angle, Centre_of_rotation, []).
rotate/4*See external documentation.
rotate90/1*Equivalent to rotate90(This, []).
rotate90/2*See external documentation.
rotateHue/2*See external documentation.
saveFile/2*See external documentation.
saveFile/3*See external documentation.
scale/3*Equivalent to scale(This, Width, Height, []).
scale/4*See external documentation.
setAlpha/2*Equivalent to setAlpha(This, Alpha, []).
setAlpha/3*See external documentation.
setAlpha/4*See external documentation.
setData/2*Equivalent to setData(This, Data, []).
setData/3*See external documentation.
setData/4*Equivalent to setData(This, Data, New_width, New_height, []).
setData/5*See external documentation.
setMask/1*Equivalent to setMask(This, []).
setMask/2*See external documentation.
setMaskColour/4*See external documentation.
setMaskFromImage/5*See external documentation.
setOption/3*See external documentation.
setPalette/2*See external documentation.
setRGB/5*See external documentation.
setRGB/6*See external documentation.
size/3*Equivalent to size(This, Size, Pos, []).
size/4*See external documentation.

Function Details

'Destroy'/1 *

'Destroy'(This::wxImage()) -> ok

See external documentation.

blur/2 *

blur(This::wxImage(), Radius::integer()) -> wxImage()

See external documentation.

blurHorizontal/2 *

blurHorizontal(This::wxImage(), Radius::integer()) -> wxImage()

See external documentation.

blurVertical/2 *

blurVertical(This::wxImage(), Radius::integer()) -> wxImage()

See external documentation.

convertAlphaToMask/1 *

convertAlphaToMask(This::wxImage()) -> bool()

Equivalent to convertAlphaToMask(This, []).

convertAlphaToMask/2 *

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

See external documentation.

convertToGreyscale/1 *

convertToGreyscale(This::wxImage()) -> wxImage()

Equivalent to convertToGreyscale(This, []).

convertToGreyscale/2 *

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

See external documentation.

convertToMono/4 *

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

See external documentation.

copy/1 *

copy(This::wxImage()) -> wxImage()

See external documentation.

create/3 *

create(This::wxImage(), Width::integer(), Height::integer()) -> bool()

Equivalent to create(This, Width, Height, []).

create/4 *

create(This::wxImage(), Width::integer(), Height::integer(), X::binary() | term()) -> bool()

See external documentation.
Alternatives:

  • create(This::wxImage(), Width::integer(), Height::integer(), Data::binary()) -> create(This,Width,Height,Data, [])
  • create(This::wxImage(), Width::integer(), Height::integer(), [Option]) -> bool()
    Option = {clear, bool()}

    • create/5 *

    create(This::wxImage(), Width::integer(), Height::integer(), Data::binary(), X::binary() | term()) -> bool()

    See external documentation.
    Alternatives:

  • create(This::wxImage(), Width::integer(), Height::integer(), Data::binary(), Alpha::binary()) -> create(This,Width,Height,Data,Alpha, [])
  • create(This::wxImage(), Width::integer(), Height::integer(), Data::binary(), [Option]) -> bool()
    Option = {static_data, bool()}

    • create/6 *

    create(This::wxImage(), Width::integer(), Height::integer(), Data::binary(), Alpha::binary(), Options::[Option]) -> bool()

    See external documentation.

    destroy/1 *

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

    Destroys this object, do not use object again

    findFirstUnusedColour/1 *

    findFirstUnusedColour(This::wxImage()) -> {bool(), R::integer(), G::integer(), B::integer()}

    Equivalent to findFirstUnusedColour(This, []).

    findFirstUnusedColour/2 *

    findFirstUnusedColour(This::wxImage(), Options::[Option]) -> {bool(), R::integer(), G::integer(), B::integer()}

    See external documentation.

    getAlpha/1 *

    getAlpha(This::wxImage()) -> binary()

    See external documentation.

    getAlpha/3 *

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

    See external documentation.

    getBlue/3 *

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

    See external documentation.

    getData/1 *

    getData(This::wxImage()) -> binary()

    See external documentation.

    getGreen/3 *

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

    See external documentation.

    getHeight/1 *

    getHeight(This::wxImage()) -> integer()

    See external documentation.

    getImageCount/1 *

    getImageCount(Name::string()) -> integer()

    Equivalent to getImageCount(Name, []).

    getImageCount/2 *

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

    See external documentation.

    getImageExtWildcard/0 *

    getImageExtWildcard() -> string()

    See external documentation.

    getMaskBlue/1 *

    getMaskBlue(This::wxImage()) -> integer()

    See external documentation.

    getMaskGreen/1 *

    getMaskGreen(This::wxImage()) -> integer()

    See external documentation.

    getMaskRed/1 *

    getMaskRed(This::wxImage()) -> integer()

    See external documentation.

    getOption/2 *

    getOption(This::wxImage(), Name::string()) -> string()

    See external documentation.

    getOptionInt/2 *

    getOptionInt(This::wxImage(), Name::string()) -> integer()

    See external documentation.

    getOrFindMaskColour/1 *

    getOrFindMaskColour(This::wxImage()) -> {bool(), R::integer(), G::integer(), B::integer()}

    See external documentation.

    getPalette/1 *

    getPalette(This::wxImage()) -> wxPalette:wxPalette()

    See external documentation.

    getRed/3 *

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

    See external documentation.

    getSubImage/2 *

    getSubImage(This::wxImage(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}) -> wxImage()

    See external documentation.

    getWidth/1 *

    getWidth(This::wxImage()) -> integer()

    See external documentation.

    hasAlpha/1 *

    hasAlpha(This::wxImage()) -> bool()

    See external documentation.

    hasMask/1 *

    hasMask(This::wxImage()) -> bool()

    See external documentation.

    hasOption/2 *

    hasOption(This::wxImage(), Name::string()) -> bool()

    See external documentation.

    initAlpha/1 *

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

    See external documentation.

    initStandardHandlers/0 *

    initStandardHandlers() -> ok

    See external documentation.

    isTransparent/3 *

    isTransparent(This::wxImage(), X::integer(), Y::integer()) -> bool()

    Equivalent to isTransparent(This, X, Y, []).

    isTransparent/4 *

    isTransparent(This::wxImage(), X::integer(), Y::integer(), Options::[Option]) -> bool()

    See external documentation.

    loadFile/2 *

    loadFile(This::wxImage(), Name::string()) -> bool()

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

    loadFile/3 *

    loadFile(This::wxImage(), Name::string(), Options::[Option]) -> bool()

    See external documentation.

    loadFile/4 *

    loadFile(This::wxImage(), Name::string(), Mimetype::string(), Options::[Option]) -> bool()

    See external documentation.

    mirror/1 *

    mirror(This::wxImage()) -> wxImage()

    Equivalent to mirror(This, []).

    mirror/2 *

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

    See external documentation.

    new/0 *

    new() -> wxImage()

    See external documentation.

    new/1 *

    new(Name::string()) -> wxImage()

    Equivalent to new(Name, []).

    new/2 *

    new(X::integer() | string(), X::integer() | term()) -> wxImage()

    See external documentation.
    Alternatives:

  • new(Width::integer(), Height::integer()) -> new(Width,Height, [])
  • new(Name::string(), [Option]) -> wxImage()
    Option = {type, integer()} | {index, integer()}

    • new/3 *

    new(X::integer() | string(), X::integer() | string(), X::binary() | term()) -> wxImage()

    See external documentation.
    Alternatives:

  • new(Width::integer(), Height::integer(), Data::binary()) -> new(Width,Height,Data, [])
  • new(Width::integer(), Height::integer(), [Option]) -> wxImage()
    Option = {clear, bool()}
  • new(Name::string(), Mimetype::string(), [Option]) -> wxImage()
    Option = {index, integer()}

    • new/4 *

    new(Width::integer(), Height::integer(), Data::binary(), X::binary() | term()) -> wxImage()

    See external documentation.
    Alternatives:

  • new(Width::integer(), Height::integer(), Data::binary(), Alpha::binary()) -> new(Width,Height,Data,Alpha, [])
  • new(Width::integer(), Height::integer(), Data::binary(), [Option]) -> wxImage()
    Option = {static_data, bool()}

    • new/5 *

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

    See external documentation.

    ok/1 *

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

    See external documentation.

    removeHandler/1 *

    removeHandler(Name::string()) -> bool()

    See external documentation.

    replace/7 *

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

    See external documentation.

    rescale/3 *

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

    Equivalent to rescale(This, Width, Height, []).

    rescale/4 *

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

    See external documentation.

    resize/3 *

    resize(This::wxImage(), Size::{W::integer(), H::integer()}, Pos::{X::integer(), Y::integer()}) -> wxImage()

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

    resize/4 *

    resize(This::wxImage(), Size::{W::integer(), H::integer()}, Pos::{X::integer(), Y::integer()}, Options::[Option]) -> wxImage()

    See external documentation.

    rotate/3 *

    rotate(This::wxImage(), Angle::float(), Centre_of_rotation::{X::integer(), Y::integer()}) -> wxImage()

    Equivalent to rotate(This, Angle, Centre_of_rotation, []).

    rotate/4 *

    rotate(This::wxImage(), Angle::float(), Centre_of_rotation::{X::integer(), Y::integer()}, Options::[Option]) -> wxImage()

    See external documentation.

    rotate90/1 *

    rotate90(This::wxImage()) -> wxImage()

    Equivalent to rotate90(This, []).

    rotate90/2 *

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

    See external documentation.

    rotateHue/2 *

    rotateHue(This::wxImage(), Angle::float()) -> ok

    See external documentation.

    saveFile/2 *

    saveFile(This::wxImage(), Name::string()) -> bool()

    See external documentation.

    saveFile/3 *

    saveFile(This::wxImage(), Name::string(), X::integer() | string()) -> bool()

    See external documentation.
    Alternatives:

  • saveFile(This::wxImage(), Name::string(), Type::integer()) -> bool()
  • saveFile(This::wxImage(), Name::string(), Mimetype::string()) -> bool()

    • scale/3 *

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

    Equivalent to scale(This, Width, Height, []).

    scale/4 *

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

    See external documentation.

    setAlpha/2 *

    setAlpha(This::wxImage(), Alpha::binary()) -> ok

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

    setAlpha/3 *

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

    See external documentation.

    setAlpha/4 *

    setAlpha(This::wxImage(), X::integer(), Y::integer(), Alpha::integer()) -> ok

    See external documentation.

    setData/2 *

    setData(This::wxImage(), Data::binary()) -> ok

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

    setData/3 *

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

    See external documentation.

    setData/4 *

    setData(This::wxImage(), Data::binary(), New_width::integer(), New_height::integer()) -> ok

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

    setData/5 *

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

    See external documentation.

    setMask/1 *

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

    Equivalent to setMask(This, []).

    setMask/2 *

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

    See external documentation.

    setMaskColour/4 *

    setMaskColour(This::wxImage(), R::integer(), G::integer(), B::integer()) -> ok

    See external documentation.

    setMaskFromImage/5 *

    setMaskFromImage(This::wxImage(), Mask::wxImage(), Mr::integer(), Mg::integer(), Mb::integer()) -> bool()

    See external documentation.

    setOption/3 *

    setOption(This::wxImage(), Name::string(), X::integer() | string()) -> ok

    See external documentation.
    Alternatives:

  • setOption(This::wxImage(), Name::string(), Value::integer()) -> ok
  • setOption(This::wxImage(), Name::string(), Value::string()) -> ok

    • setPalette/2 *

    setPalette(This::wxImage(), Palette::wxPalette:wxPalette()) -> ok

    See external documentation.

    setRGB/5 *

    setRGB(This::wxImage(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}, R::integer(), G::integer(), B::integer()) -> ok

    See external documentation.

    setRGB/6 *

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

    See external documentation.

    size/3 *

    size(This::wxImage(), Size::{W::integer(), H::integer()}, Pos::{X::integer(), Y::integer()}) -> wxImage()

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

    size/4 *

    size(This::wxImage(), Size::{W::integer(), H::integer()}, Pos::{X::integer(), Y::integer()}, Options::[Option]) -> wxImage()

    See external documentation.

    Overviewerlang logo

    Generated by EDoc, May 26 2008, 12:35:33.