User's Guide
Reference Manual
Release Notes
PDF
Top

wxErlang
Reference Manual
Version 0.98.5

Expand All
Contract All

Table of Contents

# wxBitmap

### MODULE

wxBitmap

### MODULE SUMMARY

See external documentation: wxBitmap.

### DESCRIPTION

See external documentation: wxBitmap.

### DATA TYPES

wxBitmap()

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

See external documentation.

new(X::string() | term()) -> wxBitmap()

See external documentation.
Alternatives:

new(Filename::string()) -> new(Filename, [])

new(Image::wxImage:wxImage()) -> new(Image, [])

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

See external documentation.
Alternatives:

new(Width::integer(), Height::integer()) -> new(Width,Height, [])

new(Filename::string(), [Option]) -> wxBitmap()
Option = {type, WxBitmapType}
WxBitmapType = integer()
WxBitmapType is one of ?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

new(Image::wxImage:wxImage(), [Option]) -> wxBitmap()
Option = {depth, integer()}

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

See external documentation.
Alternatives:

new(Bits::binary(), Width::integer(), Height::integer()) -> new(Bits,Width,Height, [])

new(Width::integer(), Height::integer(), [Option]) -> wxBitmap()
Option = {depth, integer()}

new(Bits::binary(), Width::integer(), Height::integer(), Options::[Option]) -> wxBitmap()

Types:

Option = {depth, integer()}

See external documentation.

convertToImage(This::wxBitmap()) -> wxImage() (see module wxImage)

See external documentation.

copyFromIcon(This::wxBitmap(), Icon::wxIcon() (see module wxIcon)) -> bool()

See external documentation.

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

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

create(This::wxBitmap(), Width::integer(), Height::integer(), Options::[Option]) -> bool()

Types:

Option = {depth, integer()}

See external documentation.

getDepth(This::wxBitmap()) -> integer()

See external documentation.

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

See external documentation.

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

See external documentation.

getMask(This::wxBitmap()) -> wxMask() (see module wxMask)

See external documentation.

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

See external documentation.

getSubBitmap(This::wxBitmap(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}) -> wxBitmap()

See external documentation.

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

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

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

Types:

Option = {type, WxBitmapType}
WxBitmapType = integer()

See external documentation.
WxBitmapType is one of ?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

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

See external documentation.

saveFile(This::wxBitmap(), Name::string(), Type::WxBitmapType) -> bool()

Equivalent to saveFile(This, Name, Type, []).

saveFile(This::wxBitmap(), Name::string(), Type::WxBitmapType, Options::[Option]) -> bool()

Types:

Option = {palette, wxPalette() (see module wxPalette)}
WxBitmapType = integer()

See external documentation.
WxBitmapType is one of ?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

setDepth(This::wxBitmap(), Depth::integer()) -> ok

See external documentation.

setHeight(This::wxBitmap(), Height::integer()) -> ok

See external documentation.

setMask(This::wxBitmap(), Mask::wxMask() (see module wxMask)) -> ok

See external documentation.

setPalette(This::wxBitmap(), Palette::wxPalette() (see module wxPalette)) -> ok

See external documentation.

setWidth(This::wxBitmap(), Width::integer()) -> ok

See external documentation.

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

Destroys this object, do not use object again