docs/latex/wx/mask.tex

   1 \section{\class{wxMask}}\label{wxmask}
   2
   3 This class encapsulates a monochrome mask bitmap, where the masked area is black and
   4 the unmasked area is white. When associated with a bitmap and drawn in a device context,
   5 the unmasked area of the bitmap will be drawn, and the masked area will not be drawn.
   6
   7 \wxheading{Derived from}
   8
   9 \helpref{wxObject}{wxobject}
  10
  11 \wxheading{Include files}
  12
  13 <wx/bitmap.h>
  14
  15 \wxheading{Remarks}
  16
  17 A mask may be associated with a \helpref{wxBitmap}{wxbitmap}. It is used in \helpref{wxDC::Blit}{wxdcblit} when
  18 the source device context is a \helpref{wxMemoryDC}{wxmemorydc} with wxBitmap selected into it that
  19 contains a mask.
  20
  21 \wxheading{See also}
  22
  23 \helpref{wxBitmap}{wxbitmap}, \helpref{wxDC::Blit}{wxdcblit}, \helpref{wxMemoryDC}{wxmemorydc}
  24
  25 \latexignore{\rtfignore{\wxheading{Members}}}
  26
  27 \membersection{wxMask::wxMask}\label{wxmaskctor}
  28
  29 \func{}{wxMask}{\void}
  30
  31 Default constructor.
  32
  33 \func{}{wxMask}{\param{const \helpref{wxBitmap}{wxbitmap}\& }{bitmap}}
  34
  35 Constructs a mask from a monochrome bitmap.
  36
  37 \pythonnote{This is the default constructor for wxMask in wxPython.}
  38
  39 \func{}{wxMask}{\param{const \helpref{wxBitmap}{wxbitmap}\& }{bitmap}, \param{const \helpref{wxColour}{wxcolour}\& }{colour}}
  40
  41 Constructs a mask from a bitmap and a colour that indicates the background.
  42
  43 \pythonnote{wxPython has an alternate wxMask constructor matching this
  44 form called {\tt wxMaskColour}.}
  45
  46 \func{}{wxMask}{\param{const wxBitmap\& }{bitmap}, \param{int}{ index}}
  47
  48 Constructs a mask from a bitmap and a palette index that indicates the background. Not
  49 yet implemented for GTK.
  50
  51 \wxheading{Parameters}
  52
  53 \docparam{bitmap}{A valid bitmap.}
  54
  55 \docparam{colour}{A colour specifying the transparency RGB values.}
  56
  57 \docparam{index}{Index into a palette, specifying the transparency colour.}
  58
  59 \membersection{wxMask::\destruct{wxMask}}\label{wxmaskdtor}
  60
  61 \func{}{\destruct{wxMask}}{\void}
  62
  63 Destroys the wxMask object and the underlying bitmap data.
  64
  65 \membersection{wxMask::Create}\label{wxmaskcreate}
  66
  67 \func{bool}{Create}{\param{const wxBitmap\& }{bitmap}}
  68
  69 Constructs a mask from a monochrome bitmap.
  70
  71 \func{bool}{Create}{\param{const wxBitmap\& }{bitmap}, \param{const wxColour\& }{colour}}
  72
  73 Constructs a mask from a bitmap and a colour that indicates the background.
  74
  75 \func{bool}{Create}{\param{const wxBitmap\& }{bitmap}, \param{int}{ index}}
  76
  77 Constructs a mask from a bitmap and a palette index that indicates the background. Not
  78 yet implemented for GTK.
  79
  80 \wxheading{Parameters}
  81
  82 \docparam{bitmap}{A valid bitmap.}
  83
  84 \docparam{colour}{A colour specifying the transparency RGB values.}
  85
  86 \docparam{index}{Index into a palette, specifying the transparency colour.}
  87
  88