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