.\" This is a wxWidgets manpage page generated from the XML docs
.TH wxMask 3wx 2005-02-15 "wxWidgets" "wxWidgets class documentation"
.SH NAME
wxMask \- 
  Represents a mask to be used with a bitmap for transparent drawing
 
.SH 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.
  
 
.SH 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.
  
 
.SH "PARENTS"

  wxObject
 
.SH "INCLUDE FILES"
wx/bitmap.h
.SH MEMBERS

  
.SS  wxMask ()

     


      Default constructor.
     
    
.SS  wxMask (const wxBitmap& bitmap)

     


      Constructs a mask from a monochrome bitmap.
     
    
.SS  wxMask (const wxBitmap& bitmapconst wxColour& colour)

     


      Constructs a mask from a bitmap and a colour that indicates the
      background.
     
    
.SS  wxMask (const wxBitmap& bitmapint index)

     


      Constructs a mask from a bitmap and a palette index that indicates the
      background. Not yet implemented for GTK.
     
    
   
  
.SS  ~wxMask ()

     


      Destroys the wxMask object and the underlying bitmap data.
     
    
   
  
.SS bool Create (const wxBitmap& bitmap)

     


      Constructs a mask from a monochrome bitmap.
     
    
.SS bool Create (const wxBitmap& bitmapconst wxColour& colour)

     


      Constructs a mask from a bitmap and a colour that indicates the
      background.
     
    
.SS bool Create (const wxBitmap& bitmapint index)

     


      Constructs a mask from a bitmap and a palette index that indicates the
      background. Not yet implemented for GTK.
     
    
 
.SH "SEE ALSO"

  wxObject
 
  wxBitmap
  wxDC::Blit
  wxMemoryDC
 
.SH "AUTHORS"
Documentation content by Julian Smart, Robert Roebling, Vadim Zeitlin, Robin Dunn, et al

Conversion to manpage format by Arnout Engelen (http://bzzt.net), bugreports welcome.