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.
   5
   6 \wxheading{Derived from}
   7
   8 \helpref{wxObject}{wxobject}
   9
  10 \wxheading{Include files}
  11
  12 <wx/bitmap.h>
  13
  14 \wxheading{Remarks}
  15
  16 A mask may be associated with a \helpref{wxBitmap}{wxbitmap}. It is used in \helpref{wxDC::Blit}{wxdcblit} when
  17 the source device context is a \helpref{wxMemoryDC}{wxmemorydc} with wxBitmap selected into it that
  18 contains a mask.
  19
  20 \wxheading{See also}
  21
  22 \helpref{wxBitmap}{wxbitmap}, \helpref{wxDC::Blit}{wxdcblit}, \helpref{wxMemoryDC}{wxmemorydc}
  23
  24 \latexignore{\rtfignore{\wxheading{Members}}}
  25
  26 \membersection{wxMask::wxMask}\label{wxmaskconstr}
  27
  28 \func{}{wxMask}{\void}
  29
  30 Default constructor.
  31
  32 \func{}{wxMask}{\param{const wxBitmap\& }{bitmap}}
  33
  34 Constructs a mask from a monochrome bitmap.
  35
  36 \pythonnote{This is the default constructor for wxMask in wxPython.}
  37
  38 \func{}{wxMask}{\param{const wxBitmap\& }{bitmap}, \param{const wxColour\& }{colour}}
  39
  40 Constructs a mask from a bitmap and a colour that indicates the background. Not
  41 yet implemented for GTK.
  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}}
  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. Not
  74 yet implemented for GTK.
  75
  76 \func{bool}{Create}{\param{const wxBitmap\& }{bitmap}, \param{int}{ index}}
  77
  78 Constructs a mask from a bitmap and a palette index that indicates the background. Not
  79 yet implemented for GTK.
  80
  81 \wxheading{Parameters}
  82
  83 \docparam{bitmap}{A valid bitmap.}
  84
  85 \docparam{colour}{A colour specifying the transparency RGB values.}
  86
  87 \docparam{index}{Index into a palette, specifying the transparency colour.}
  88
  89