View Source wxMask (wx v2.4.3)
This class encapsulates a monochrome mask bitmap, where the masked area is black and the unmasked area is white.
When associated with a bitmap and drawn in a device context, the unmasked area of the bitmap will be drawn, and the masked area will not be drawn.
Note: A mask can be associated also with a bitmap with an alpha channel but drawing such bitmaps under wxMSW may be slow so using them should be avoided if drawing performance is an important factor.
See:
wxWidgets docs: wxMask
Summary
Functions
Constructs a mask from a monochrome bitmap.
Constructs a mask from a bitmap and a colour that indicates the background.
Destroys the object
Default constructor.
Constructs a mask from a monochrome bitmap.
Constructs a mask from a bitmap and a colour that indicates the background.
Types
-type wxMask() :: wx:wx_object().
Functions
-spec create(This, Bitmap) -> boolean() when This :: wxMask(), Bitmap :: wxBitmap:wxBitmap().
Constructs a mask from a monochrome bitmap.
-spec create(This, Bitmap, Index) -> boolean() when This :: wxMask(), Bitmap :: wxBitmap:wxBitmap(), Index :: integer(); (This, Bitmap, Colour) -> boolean() when This :: wxMask(), Bitmap :: wxBitmap:wxBitmap(), Colour :: wx:wx_colour().
Constructs a mask from a bitmap and a colour that indicates the background.
-spec destroy(This :: wxMask()) -> ok.
Destroys the object
-spec new() -> wxMask().
Default constructor.
-spec new(Bitmap) -> wxMask() when Bitmap :: wxBitmap:wxBitmap().
Constructs a mask from a monochrome bitmap.
-spec new(Bitmap, Index) -> wxMask() when Bitmap :: wxBitmap:wxBitmap(), Index :: integer(); (Bitmap, Colour) -> wxMask() when Bitmap :: wxBitmap:wxBitmap(), Colour :: wx:wx_colour().
Constructs a mask from a bitmap and a colour that indicates the background.