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{Remarks}
  11
  12 A mask may be associated with a \helpref{wxBitmap}{wxbitmap}. It is used in \helpref{wxDC::Blit}{wxdcblit} when
  13 the source device context is a \helpref{wxMemoryDC}{wxmemorydc} with wxBitmap selected into it that
  14 contains a mask.
  15
  16 \wxheading{See also}
  17
  18 \helpref{wxBitmap}{wxbitmap}, \helpref{wxDC::Blit}{wxdcblit}, \helpref{wxMemoryDC}{wxmemorydc}
  19
  20 \latexignore{\rtfignore{\wxheading{Members}}}
  21
  22 \membersection{wxMask::wxMask}\label{wxmaskconstr}
  23
  24 \func{}{wxMask}{\void}
  25
  26 Default constructor.
  27
  28 \func{}{wxMask}{\param{const wxBitmap\& }{bitmap}}
  29
  30 Constructs a mask from a monochrome bitmap.
  31
  32 \func{}{wxMask}{\param{const wxBitmap\& }{bitmap}, \param{const wxColour\& }{colour}}
  33
  34 Constructs a mask from a bitmap and a colour that indicates the background.
  35
  36 \func{}{wxMask}{\param{const wxBitmap\& }{bitmap}, \param{int}{ index}}
  37
  38 Constructs a mask from a bitmap and a palette index that indicates the background.
  39
  40 \wxheading{Parameters}
  41
  42 \docparam{bitmap}{A valid bitmap.}
  43
  44 \docparam{colour}{A colour specifying the transparency RGB values.}
  45
  46 \docparam{index}{Index into a palette, specifying the transparency colour.}
  47
  48 \membersection{wxMask::\destruct{wxMask}}
  49
  50 \func{}{\destruct{wxMask}}{\void}
  51
  52 Destroys the wxMask object and the underlying bitmap data.
  53
  54 \membersection{wxMask::Create}\label{wxmaskcreate}
  55
  56 \func{bool}{Create}{\param{const wxBitmap\& }{bitmap}}
  57
  58 Constructs a mask from a monochrome bitmap.
  59
  60 \func{bool}{Create}{\param{const wxBitmap\& }{bitmap}, \param{const wxColour\& }{colour}}
  61
  62 Constructs a mask from a bitmap and a colour that indicates the background.
  63
  64 \func{bool}{Create}{\param{const wxBitmap\& }{bitmap}, \param{int}{ index}}
  65
  66 Constructs a mask from a bitmap and a palette index that indicates the background.
  67
  68 \wxheading{Parameters}
  69
  70 \docparam{bitmap}{A valid bitmap.}
  71
  72 \docparam{colour}{A colour specifying the transparency RGB values.}
  73
  74 \docparam{index}{Index into a palette, specifying the transparency colour.}
  75
  76