wxmask

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.

derived from

wxobject

include files

<wx/bitmap.h>

remarks

a mask may be associated with a wxbitmap. it is used in wxdc::blit when the source device context is a wxmemorydc with wxbitmap selected into it that contains a mask.

see also

wxbitmap, wxdc::blit, wxmemorydc

members

wxmask::wxmask
wxmask::~wxmask
wxmask::create

wxmask::wxmask

wxmask()

default constructor.

wxmask(const wxbitmap& bitmap)

constructs a mask from a monochrome bitmap.

wxpython note: this is the default constructor for wxmask in wxpython.

wxmask(const wxbitmap& bitmap, const wxcolour& colour)

constructs a mask from a bitmap and a colour that indicates the background.

wxpython note: wxpython has an alternate wxmask constructor matching this form called wxmaskcolour.

wxmask(const wxbitmap& bitmap, int index)

constructs a mask from a bitmap and a palette index that indicates the background. not yet implemented for gtk.

parameters

bitmap

a valid bitmap.

colour

a colour specifying the transparency rgb values.

index

index into a palette, specifying the transparency colour.

wxmask::~wxmask

~wxmask()

destroys the wxmask object and the underlying bitmap data.

wxmask::create

bool create(const wxbitmap& bitmap)

constructs a mask from a monochrome bitmap.

bool create(const wxbitmap& bitmap, const wxcolour& colour)

constructs a mask from a bitmap and a colour that indicates the background.

bool create(const wxbitmap& bitmap, int index)

constructs a mask from a bitmap and a palette index that indicates the background. not yet implemented for gtk.

parameters

bitmap

a valid bitmap.

colour

a colour specifying the transparency rgb values.

index

index into a palette, specifying the transparency colour.