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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.Mask:
==========================================================================================================================================
|phoenix_title| **wx.Mask**
==========================================================================================================================================
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.
.. note::
A mask can be associated also with a bitmap with an alpha channel but drawing such bitmaps under wxMSW may be slow so using them should be avoided if drawing performance is an important factor.
.. seealso:: :ref:`wx.Bitmap`, :meth:`wx.DC.Blit` , :ref:`wx.MemoryDC`
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html
<div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
<img id="toggleBlock-trigger" src="_static/images/closed.png"/>
Inheritance diagram for class <strong>Mask</strong>:
</div>
<div id="toggleBlock-summary" style="display:block;"></div>
<div id="toggleBlock-content" style="display:none;">
<p class="graphviz">
<center><img src="_static/images/inheritance/wx.Mask_inheritance.png" alt="Inheritance diagram of Mask" usemap="#dummy" class="inheritance"/></center>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.Mask.html" title="wx.Mask" alt="" coords="9,83,88,112"/> <area shape="rect" id="node2" href="wx.Object.html" title="wx.Object" alt="" coords="5,5,92,35"/> </map>
</p>
</div>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.Mask.__init__` Default constructor.
:meth:`~wx.Mask.GetBitmap` Returns the mask as a monochrome bitmap.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.Mask.Bitmap` See :meth:`~wx.Mask.GetBitmap`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.Mask(Object)
**Possible constructors**::
Mask()
Mask(bitmap, index)
Mask(bitmap)
Mask(bitmap, colour)
This class encapsulates a monochrome mask bitmap, where the masked
area is black and the unmasked area is white.
.. method:: __init__(self, *args, **kw)
|overload| Overloaded Implementations:
:html:`<hr class="overloadsep" /><br />`
**__init__** `(self)`
Default constructor.
:html:`<hr class="overloadsep" /><br />`
**__init__** `(self, bitmap, index)`
Constructs a mask from a bitmap and a palette index that indicates the background.
Not implemented for GTK.
:param `bitmap`: A valid bitmap.
:type `bitmap`: wx.Bitmap
:param `index`: Index into a palette, specifying the transparency colour.
:type `index`: int
:html:`<hr class="overloadsep" /><br />`
**__init__** `(self, bitmap)`
Constructs a mask from a monochrome bitmap.
:param `bitmap`:
:type `bitmap`: wx.Bitmap
:html:`<hr class="overloadsep" /><br />`
**__init__** `(self, bitmap, colour)`
Constructs a mask from a bitmap and a colour that indicates the background.
:param `bitmap`:
:type `bitmap`: wx.Bitmap
:param `colour`:
:type `colour`: wx.Colour
:html:`<hr class="overloadsep" /><br />`
.. method:: GetBitmap(self)
Returns the mask as a monochrome bitmap.
Currently this method is implemented in wxMSW, wxGTK and wxOSX.
:rtype: :ref:`wx.Bitmap`
.. versionadded:: 2.9.5
.. attribute:: Bitmap
See :meth:`~wx.Mask.GetBitmap`
|
