wx.Mask Class Reference

Inheritance diagram for wx.Mask:

wx.Object

List of all members.

Public Member Functions

bool Create (Bitmap bitmap)
bool Create (Bitmap bitmap, int paletteIndex)
bool Create (Bitmap bitmap, Colour colour)
 Mask (IntPtr wxObject)
 Mask (Bitmap bitmap)
 Mask (Bitmap bitmap, int paletteIndex)
 Mask (Bitmap bitmap, Colour colour)
 Mask ()


Detailed Description

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.

A mask may be associated with a wx.Bitmap. It is used in wx.DC.Blit when the source device context is a wx.MemoryDC with wx.Bitmap selected into it that contains a mask.


Constructor & Destructor Documentation

wx.Mask.Mask (  ) 

Default constructor.

wx.Mask.Mask ( Bitmap  bitmap,
Colour  colour 
)

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

Parameters:
bitmap The bitmap that this ctor will create a mask for.
colour The colour that indicates the background of the bitmap.

wx.Mask.Mask ( Bitmap  bitmap,
int  paletteIndex 
)

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

Parameters:
bitmap The bitmap that this ctor will create a mask for.
paletteIndex The colour that indicates the background of the bitmap specified as an index in the palette used by the bitmap.

wx.Mask.Mask ( Bitmap  bitmap  ) 

Constructs the mask from a monochrome bitmap.

Parameters:
bitmap A bitmap that shall be monochrome.

wx.Mask.Mask ( IntPtr  wxObject  ) 


Member Function Documentation

bool wx.Mask.Create ( Bitmap  bitmap  ) 

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

Parameters:
bitmap The bitmap that this ctor will create a mask for.
colour The colour that indicates the background of the bitmap.

bool wx.Mask.Create ( Bitmap  bitmap,
int  paletteIndex 
)

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

Parameters:
bitmap The bitmap that this ctor will create a mask for.
paletteIndex The colour that indicates the background of the bitmap specified as an index in the palette used by the bitmap.

bool wx.Mask.Create ( Bitmap  bitmap,
Colour  colour 
)


Manual of the wx.NET   (c) 2003-2011 the wx.NET project at   Get wx.NET at SourceForge.net. Fast, secure and Free Open Source software downloads