]>
Commit | Line | Data |
---|---|---|
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 | \func{}{wxMask}{\param{const wxBitmap\& }{bitmap}, \param{const wxColour\& }{colour}} | |
37 | ||
38 | Constructs a mask from a bitmap and a colour that indicates the background. | |
39 | ||
40 | \func{}{wxMask}{\param{const wxBitmap\& }{bitmap}, \param{int}{ index}} | |
41 | ||
42 | Constructs a mask from a bitmap and a palette index that indicates the background. | |
43 | ||
44 | \wxheading{Parameters} | |
45 | ||
46 | \docparam{bitmap}{A valid bitmap.} | |
47 | ||
48 | \docparam{colour}{A colour specifying the transparency RGB values.} | |
49 | ||
50 | \docparam{index}{Index into a palette, specifying the transparency colour.} | |
51 | ||
52 | \membersection{wxMask::\destruct{wxMask}} | |
53 | ||
54 | \func{}{\destruct{wxMask}}{\void} | |
55 | ||
56 | Destroys the wxMask object and the underlying bitmap data. | |
57 | ||
58 | \membersection{wxMask::Create}\label{wxmaskcreate} | |
59 | ||
60 | \func{bool}{Create}{\param{const wxBitmap\& }{bitmap}} | |
61 | ||
62 | Constructs a mask from a monochrome bitmap. | |
63 | ||
64 | \func{bool}{Create}{\param{const wxBitmap\& }{bitmap}, \param{const wxColour\& }{colour}} | |
65 | ||
66 | Constructs a mask from a bitmap and a colour that indicates the background. | |
67 | ||
68 | \func{bool}{Create}{\param{const wxBitmap\& }{bitmap}, \param{int}{ index}} | |
69 | ||
70 | Constructs a mask from a bitmap and a palette index that indicates the background. | |
71 | ||
72 | \wxheading{Parameters} | |
73 | ||
74 | \docparam{bitmap}{A valid bitmap.} | |
75 | ||
76 | \docparam{colour}{A colour specifying the transparency RGB values.} | |
77 | ||
78 | \docparam{index}{Index into a palette, specifying the transparency colour.} | |
79 | ||
80 |