Mask

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.

See also

Bitmap, DC.Blit , MemoryDC

Inheritance Diagram

Inheritance diagram for class Mask

Methods Summary

__init__	Default constructor.
Create	Constructs a mask from a bitmap and a palette index that indicates the background.

Class API

---

class Mask(Object)

This class encapsulates a monochrome mask bitmap, where the masked area is black and the unmasked area is white.

Possible constructors:

Mask()

Mask(bitmap, index)

Mask(bitmap)

Mask(bitmap, colour)

Methods

---

__init__(self, *args, **kw)

Overloaded Implementations:

---

__init__ (self)

Default constructor.

---

__init__ (self, bitmap, index)

Constructs a mask from a bitmap and a palette index that indicates the background.

Not yet implemented for GTK.

Parameters:

• bitmap (Bitmap) – A valid bitmap.
• index (int) – Index into a palette, specifying the transparency colour.

---

__init__ (self, bitmap)

Constructs a mask from a monochrome bitmap.

Parameters:bitmap (Bitmap) –

---

__init__ (self, bitmap, colour)

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

Parameters:

• bitmap (Bitmap) –
• colour (Colour) –

---

---

Create(self, *args, **kw)

Overloaded Implementations:

---

Create (self, bitmap, index)

Constructs a mask from a bitmap and a palette index that indicates the background.

Not yet implemented for GTK.

Parameters:

• bitmap (Bitmap) – A valid bitmap.
• index (int) – Index into a palette, specifying the transparency colour.

Return type:

bool

---

Create (self, bitmap)

Constructs a mask from a monochrome bitmap.

Parameters:bitmap (Bitmap) – Return type:bool

---

Create (self, bitmap, colour)

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

Parameters:

• bitmap (Bitmap) –
• colour (Colour) –

Return type:

bool

---