wxBitmap — wx v2.5.4

Search documentation of wx

# wxBitmap (wx v2.5.4)

View Source

This class encapsulates the concept of a platform-dependent bitmap, either monochrome or colour or colour with alpha channel support.

If you need direct access the bitmap data instead going through drawing to it using `wxMemoryDC` you need to use the `wxPixelData` (not implemented in wx) class (either wxNativePixelData for RGB bitmaps or wxAlphaPixelData for bitmaps with an additionally alpha channel).

Note that many `wxBitmap` functions take a `type` parameter, which is a value of the ?wxBitmapType enumeration. The validity of those values depends however on the platform where your program is running and from the wxWidgets configuration. If all possible wxWidgets settings are used:

- wxMSW supports BMP and ICO files, BMP and ICO resources;

- wxGTK supports any file supported by gdk-pixbuf;

- wxMac supports PICT resources;

- wxX11 supports XPM files, XPM data, XBM data;

In addition, `wxBitmap` can load and save all formats that `wxImage` can; see `wxImage` for more info. Of course, you must have loaded the `wxImage` handlers (see ?wxInitAllImageHandlers() and `wxImage::AddHandler` (not implemented in wx)). Note that all available wxBitmapHandlers for a given wxWidgets port are automatically loaded at startup so you won't need to use `wxBitmap::AddHandler` (not implemented in wx).

More on the difference between `wxImage` and `wxBitmap`: `wxImage` is just a buffer of RGB bytes with an optional buffer for the alpha bytes. It is all generic, platform independent and image file format independent code. It includes generic code for scaling, resizing, clipping, and other manipulations of the image data. OTOH, `wxBitmap` is intended to be a wrapper of whatever is the native image format that is quickest/easiest to draw to a DC or to be the target of the drawing operations performed on a `wxMemoryDC`. By splitting the responsibilities between wxImage/wxBitmap like this then it's easier to use generic code shared by all platforms and image types for generic operations and platform specific code where performance or compatibility is needed.

Predefined objects (include wx.hrl): ?wxNullBitmap

See:

- Overview bitmap

- Overview bitmap

- `wxDC:blit/6`

- `wxIcon`

- `wxCursor`

- `wxMemoryDC`

- `wxImage`

wxWidgets docs: wxBitmap

# Summary

## Types

wxBitmap()

## Functions

convertToImage(This)

Creates an image from a platform-dependent bitmap.

copyFromIcon(This, Icon)

Creates the bitmap from an icon.

create(This, Sz)

Equivalent to `create(This, Sz, [])`.

create/3

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

create/4

Create a bitmap compatible with the given DC, inheriting its magnification factor.

destroy(This)

Destroys the object

getDepth(This)

Gets the colour depth of the bitmap.

getHeight(This)

Gets the height of the bitmap in pixels.

getMask(This)

Gets the associated mask (if any) which may have been loaded from a file or set for the bitmap.

getPalette(This)

Gets the associated palette (if any) which may have been loaded from a file or set for the bitmap.

getSubBitmap(This, Rect)

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

getWidth(This)

Gets the width of the bitmap in pixels.

isOk(This)

Returns true if bitmap data is present.

loadFile(This, Name)

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

loadFile/3

Loads a bitmap from a file or resource.

new()

Default constructor.

new/1
new/2

Creates this bitmap object from the given image.

new/3

Creates a new bitmap.

new(Bits, Width, Height, Options)

Creates a bitmap from the given array `bits`.

ok(This)

Equivalent to: `isOk/1`

saveFile(This, Name, Type)

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

saveFile/4

Saves a bitmap in the named file.

setDepth(This, Depth)

Deprecated

setHeight(This, Height)

Deprecated

setMask(This, Mask)

Sets the mask for this bitmap.

setPalette(This, Palette)

Sets the associated palette.

setWidth(This, Width)

Deprecated

# Types

# wxBitmap()

    -type wxBitmap() :: wx:wx_object().

# Functions

# convertToImage(This)

    -spec convertToImage(This) -> wxImage:wxImage() when This :: wxBitmap().

Creates an image from a platform-dependent bitmap.

This preserves mask information so that bitmaps and images can be converted back and forth without loss in that respect.

# copyFromIcon(This, Icon)

    -spec copyFromIcon(This, Icon) -> boolean() when This :: wxBitmap(), Icon :: wxIcon:wxIcon().

Creates the bitmap from an icon.

# create(This, Sz)

    -spec create(This, Sz) -> boolean() when This :: wxBitmap(), Sz :: {W :: integer(), H :: integer()}.

Equivalent to `create(This, Sz, [])`.

# create/3

    -spec create(This, Width, Height) -> boolean()
                    when This :: wxBitmap(), Width :: integer(), Height :: integer();
                (This, Sz, [Option]) -> boolean()
                    when
                        This :: wxBitmap(),
                        Sz :: {W :: integer(), H :: integer()},
                        Option :: {depth, integer()}.

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

# create/4

    -spec create(This, Width, Height, [Option]) -> boolean()
                    when
                        This :: wxBitmap(),
                        Width :: integer(),
                        Height :: integer(),
                        Option :: {depth, integer()};
                (This, Width, Height, Dc) -> boolean()
                    when This :: wxBitmap(), Width :: integer(), Height :: integer(), Dc :: wxDC:wxDC().

Create a bitmap compatible with the given DC, inheriting its magnification factor.

Return: true if the creation was successful.

Since: 3.1.0

# destroy(This)

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

Destroys the object

# getDepth(This)

    -spec getDepth(This) -> integer() when This :: wxBitmap().

Gets the colour depth of the bitmap.

A value of 1 indicates a monochrome bitmap.

# getHeight(This)

    -spec getHeight(This) -> integer() when This :: wxBitmap().

Gets the height of the bitmap in pixels.

See: `getWidth/1`

# getMask(This)

    -spec getMask(This) -> wxMask:wxMask() when This :: wxBitmap().

Gets the associated mask (if any) which may have been loaded from a file or set for the bitmap.

See:

- `setMask/2`

- `wxMask`

# getPalette(This)

    -spec getPalette(This) -> wxPalette:wxPalette() when This :: wxBitmap().

Gets the associated palette (if any) which may have been loaded from a file or set for the bitmap.

See: `wxPalette`

# getSubBitmap(This, Rect)

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

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

This function preserves bit depth and mask information.

# getWidth(This)

    -spec getWidth(This) -> integer() when This :: wxBitmap().

Gets the width of the bitmap in pixels.

See: `getHeight/1`

# isOk(This)

    -spec isOk(This) -> boolean() when This :: wxBitmap().

Returns true if bitmap data is present.

# loadFile(This, Name)

    -spec loadFile(This, Name) -> boolean() when This :: wxBitmap(), Name :: unicode:chardata().

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

# loadFile/3

    -spec loadFile(This, Name, [Option]) -> boolean()
                      when This :: wxBitmap(), Name :: unicode:chardata(), Option :: {type, wx:wx_enum()}.

Loads a bitmap from a file or resource.

Return: true if the operation succeeded, false otherwise.

Remark: A palette may be associated with the bitmap if one exists (especially for colour Windows bitmaps), and if the code supports it. You can check if one has been created by using the `getPalette/1` member.

See: `saveFile/4`

# new()

    -spec new() -> wxBitmap().

Default constructor.

Constructs a bitmap object with no data; an assignment or another member function such as `create/4` or `loadFile/3` must be called subsequently.

# new/1

    -spec new(Name) -> wxBitmap() when Name :: unicode:chardata();
             (Sz) -> wxBitmap() when Sz :: {W :: integer(), H :: integer()};
             (Img) -> wxBitmap() when Img :: wxImage:wxImage() | wxBitmap:wxBitmap().

# new/2

    -spec new(Width, Height) -> wxBitmap() when Width :: integer(), Height :: integer();
             (Name, [Option]) -> wxBitmap() when Name :: unicode:chardata(), Option :: {type, wx:wx_enum()};
             (Sz, [Option]) -> wxBitmap()
                 when Sz :: {W :: integer(), H :: integer()}, Option :: {depth, integer()};
             (Img, [Option]) -> wxBitmap() when Img :: wxImage:wxImage(), Option :: {depth, integer()}.

Creates this bitmap object from the given image.

This has to be done to actually display an image as you cannot draw an image directly on a window.

The resulting bitmap will use the provided colour depth (or that of the current system if depth is ?wxBITMAP_SCREEN_DEPTH) which entails that a colour reduction may take place.

On Windows, if there is a palette present (set with SetPalette), it will be used when creating the `wxBitmap` (most useful in 8-bit display mode). On other platforms, the palette is currently ignored.

# new/3

    -spec new(Bits, Width, Height) -> wxBitmap()
                 when Bits :: binary(), Width :: integer(), Height :: integer();
             (Width, Height, [Option]) -> wxBitmap()
                 when Width :: integer(), Height :: integer(), Option :: {depth, integer()}.

Creates a new bitmap.

A depth of ?wxBITMAP_SCREEN_DEPTH indicates the depth of the current screen or visual.

Some platforms only support 1 for monochrome and ?wxBITMAP_SCREEN_DEPTH for the current colour setting.

A depth of 32 including an alpha channel is supported under MSW, Mac and GTK+.

# new(Bits, Width, Height, Options)

    -spec new(Bits, Width, Height, [Option]) -> wxBitmap()
                 when
                     Bits :: binary(), Width :: integer(), Height :: integer(), Option :: {depth, integer()}.

Creates a bitmap from the given array `bits`.

You should only use this function for monochrome bitmaps (depth 1) in portable programs: in this case the bits parameter should contain an XBM image.

For other bit depths, the behaviour is platform dependent: under Windows, the data is passed without any changes to the underlying CreateBitmap() API. Under other platforms, only monochrome bitmaps may be created using this constructor and `wxImage` should be used for creating colour bitmaps from static data.

# ok(This)

    -spec ok(This) -> boolean() when This :: wxBitmap().

Equivalent to: `isOk/1`

# saveFile(This, Name, Type)

    -spec saveFile(This, Name, Type) -> boolean()
                      when This :: wxBitmap(), Name :: unicode:chardata(), Type :: wx:wx_enum().

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

# saveFile/4

    -spec saveFile(This, Name, Type, [Option]) -> boolean()
                      when
                          This :: wxBitmap(),
                          Name :: unicode:chardata(),
                          Type :: wx:wx_enum(),
                          Option :: {palette, wxPalette:wxPalette()}.

Saves a bitmap in the named file.

Return: true if the operation succeeded, false otherwise.

Remark: Depending on how wxWidgets has been configured, not all formats may be available.

See: `loadFile/3`

# setDepth(This, Depth)

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

Deprecated:

This function is deprecated since version 3.1.2, dimensions and depth can only be set at construction time.

Sets the depth member (does not affect the bitmap data).

# setHeight(This, Height)

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

Deprecated:

This function is deprecated since version 3.1.2, dimensions and depth can only be set at construction time.

Sets the height member (does not affect the bitmap data).

# setMask(This, Mask)

    -spec setMask(This, Mask) -> ok when This :: wxBitmap(), Mask :: wxMask:wxMask().

Sets the mask for this bitmap.

Remark: The bitmap object owns the mask once this has been called.

Note: A mask can be set also for bitmap with an alpha channel but doing so under wxMSW is not recommended because performance of drawing such bitmap is not very good.

See:

- `getMask/1`

- `wxMask`

# setPalette(This, Palette)

    -spec setPalette(This, Palette) -> ok when This :: wxBitmap(), Palette :: wxPalette:wxPalette().

Sets the associated palette.

(Not implemented under GTK+).

See: `wxPalette`

# setWidth(This, Width)

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

Deprecated:

This function is deprecated since version 3.1.2, dimensions and depth can only be set at construction time.

Sets the width member (does not affect the bitmap data).