1wxMask(3)                  Erlang Module Definition                  wxMask(3)
2
3
4

NAME

6       wxMask - Functions for wxMask class
7

DESCRIPTION

9       This class encapsulates a monochrome mask bitmap, where the masked area
10       is black and the unmasked area is white.
11
12       When associated with a bitmap and drawn in a device  context,  the  un‐
13       masked  area  of the bitmap will be drawn, and the masked area will not
14       be drawn.
15
16       Note: A mask can be associated also with a bitmap with an alpha channel
17       but  drawing  such bitmaps under wxMSW may be slow so using them should
18       be avoided if drawing performance is an important factor.
19
20       See: wxBitmap, wxDC:blit/6, wxMemoryDC
21
22       wxWidgets docs: wxMask
23

DATA TYPES

25       wxMask() = wx:wx_object()
26

EXPORTS

28       new() -> wxMask()
29
30              Default constructor.
31
32       new(Bitmap) -> wxMask()
33
34              Types:
35
36                 Bitmap = wxBitmap:wxBitmap()
37
38              Constructs a mask from a monochrome bitmap.
39
40       new(Bitmap, Index) -> wxMask()
41
42       new(Bitmap, Colour) -> wxMask()
43
44              Types:
45
46                 Bitmap = wxBitmap:wxBitmap()
47                 Colour = wx:wx_colour()
48
49              Constructs a mask from a bitmap and a colour that indicates  the
50              background.
51
52       destroy(This :: wxMask()) -> ok
53
54              Destroys the wxMask object and the underlying bitmap data.
55
56       create(This, Bitmap) -> boolean()
57
58              Types:
59
60                 This = wxMask()
61                 Bitmap = wxBitmap:wxBitmap()
62
63              Constructs a mask from a monochrome bitmap.
64
65       create(This, Bitmap, Index) -> boolean()
66
67       create(This, Bitmap, Colour) -> boolean()
68
69              Types:
70
71                 This = wxMask()
72                 Bitmap = wxBitmap:wxBitmap()
73                 Colour = wx:wx_colour()
74
75              Constructs  a mask from a bitmap and a colour that indicates the
76              background.
77
78
79
80wxWidgets team.                     wx 2.1                           wxMask(3)