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
|
<HTML>
<head><title>wxMask</title></head>
<BODY BGCOLOR=#FFFFFF>
<A NAME="wxmask"></A><CENTER>
<A HREF="wx.htm"><img align=center src="contents.gif" BORDER=0 ALT="Contents"></A> <A HREF="wx22.htm#classref"><img align=center src="up.gif" BORDER=0 ALT="Up"></A> <A HREF="wx132.htm#wxlog"><img align=center src="back.gif" BORDER=0 ALT="Previous"></A> <A HREF="wx134.htm#wxmdichildframe"><img align=center src="forward.gif" BORDER=0 ALT="Next"></A> </CENTER><HR>
<H2>wxMask</H2>
<P>
This class encapsulates a monochrome mask bitmap, where the masked area is black and
the unmasked area is white.<P>
<B><FONT COLOR="#FF0000">Derived from</FONT></B><P>
<A HREF="wx158.htm#wxobject">wxObject</A><P>
<B><FONT COLOR="#FF0000">Include files</FONT></B><P>
<wx/bitmap.h><P>
<B><FONT COLOR="#FF0000">Remarks</FONT></B><P>
A mask may be associated with a <A HREF="wx32.htm#wxbitmap">wxBitmap</A>. It is used in <A HREF="wx65.htm#wxdcblit">wxDC::Blit</A> when
the source device context is a <A HREF="wx137.htm#wxmemorydc">wxMemoryDC</A> with wxBitmap selected into it that
contains a mask.<P>
<B><FONT COLOR="#FF0000">See also</FONT></B><P>
<A HREF="wx32.htm#wxbitmap">wxBitmap</A>, <A HREF="wx65.htm#wxdcblit">wxDC::Blit</A>, <A HREF="wx137.htm#wxmemorydc">wxMemoryDC</A><P>
<B><FONT COLOR="#FF0000">Members</FONT></B><P>
<A HREF="#wxmaskconstr">wxMask::wxMask</A><BR>
<A HREF="#topic549">wxMask::~wxMask</A><BR>
<A HREF="#wxmaskcreate">wxMask::Create</A><BR>
<P>
<HR>
<A NAME="wxmaskconstr"></A>
<H3>wxMask::wxMask</H3>
<P>
<B></B> <B>wxMask</B>()<P>
Default constructor.<P>
<B></B> <B>wxMask</B>(<B>const wxBitmap& </B><I>bitmap</I>)<P>
Constructs a mask from a monochrome bitmap.<P>
<B></B> <B>wxMask</B>(<B>const wxBitmap& </B><I>bitmap</I>, <B>const wxColour& </B><I>colour</I>)<P>
Constructs a mask from a bitmap and a colour that indicates the background.<P>
<B></B> <B>wxMask</B>(<B>const wxBitmap& </B><I>bitmap</I>, <B>int</B><I> index</I>)<P>
Constructs a mask from a bitmap and a palette index that indicates the background.<P>
<B><FONT COLOR="#FF0000">Parameters</FONT></B><P>
<I>bitmap</I><UL><UL>
A valid bitmap.</UL></UL>
<P>
<I>colour</I><UL><UL>
A colour specifying the transparency RGB values.</UL></UL>
<P>
<I>index</I><UL><UL>
Index into a palette, specifying the transparency colour.</UL></UL>
<P>
<HR>
<A NAME="topic549"></A>
<H3>wxMask::~wxMask</H3>
<P>
<B></B> <B>~wxMask</B>()<P>
Destroys the wxMask object and the underlying bitmap data.<P>
<HR>
<A NAME="wxmaskcreate"></A>
<H3>wxMask::Create</H3>
<P>
<B>bool</B> <B>Create</B>(<B>const wxBitmap& </B><I>bitmap</I>)<P>
Constructs a mask from a monochrome bitmap.<P>
<B>bool</B> <B>Create</B>(<B>const wxBitmap& </B><I>bitmap</I>, <B>const wxColour& </B><I>colour</I>)<P>
Constructs a mask from a bitmap and a colour that indicates the background.<P>
<B>bool</B> <B>Create</B>(<B>const wxBitmap& </B><I>bitmap</I>, <B>int</B><I> index</I>)<P>
Constructs a mask from a bitmap and a palette index that indicates the background.<P>
<B><FONT COLOR="#FF0000">Parameters</FONT></B><P>
<I>bitmap</I><UL><UL>
A valid bitmap.</UL></UL>
<P>
<I>colour</I><UL><UL>
A colour specifying the transparency RGB values.</UL></UL>
<P>
<I>index</I><UL><UL>
Index into a palette, specifying the transparency colour.</UL></UL>
<P>
</BODY></HTML>
|
