[wxWidgets.git] / docs / latex / wx / mask.tex

\section{\class{wxMask}}\label{wxmask}

This class encapsulates a monochrome mask bitmap, where the masked area is black and
the unmasked area is white.

\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{wxmaskconstr}

\func{}{wxMask}{\void}

Default constructor.

\func{}{wxMask}{\param{const wxBitmap\& }{bitmap}}

Constructs a mask from a monochrome bitmap.

\pythonnote{This is the default constructor for wxMask in wxPython.}

\func{}{wxMask}{\param{const wxBitmap\& }{bitmap}, \param{const 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}}

\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.}
Commit	Line	Data
a660d684 KB	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
954b8ae6 JS	10	\wxheading{Include files}
	11
	12	<wx/bitmap.h>
	13
a660d684 KB	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
ac1edf35 RD	36	\pythonnote{This is the default constructor for wxMask in wxPython.}
ac1edf35 RD	37
a660d684 KB	38	\func{}{wxMask}{\param{const wxBitmap\& }{bitmap}, \param{const wxColour\& }{colour}}
a660d684 KB	39
f9ee644e	40	Constructs a mask from a bitmap and a colour that indicates the background.
a660d684	41
ac1edf35	42	\pythonnote{wxPython has an alternate wxMask constructor matching this
c9110876	43	form called {\tt wxMaskColour}.}
ac1edf35	44
a660d684 KB	45	\func{}{wxMask}{\param{const wxBitmap\& }{bitmap}, \param{int}{ index}}
a660d684 KB	46
91b8de8d RR	47	Constructs a mask from a bitmap and a palette index that indicates the background. Not
91b8de8d RR	48	yet implemented for GTK.
a660d684 KB	49
	50	\wxheading{Parameters}
	51
	52	\docparam{bitmap}{A valid bitmap.}
	53
	54	\docparam{colour}{A colour specifying the transparency RGB values.}
	55
	56	\docparam{index}{Index into a palette, specifying the transparency colour.}
	57
	58	\membersection{wxMask::\destruct{wxMask}}
	59
	60	\func{}{\destruct{wxMask}}{\void}
	61
	62	Destroys the wxMask object and the underlying bitmap data.
	63
	64	\membersection{wxMask::Create}\label{wxmaskcreate}
	65
	66	\func{bool}{Create}{\param{const wxBitmap\& }{bitmap}}
	67
	68	Constructs a mask from a monochrome bitmap.
	69
	70	\func{bool}{Create}{\param{const wxBitmap\& }{bitmap}, \param{const wxColour\& }{colour}}
	71
f9ee644e	72	Constructs a mask from a bitmap and a colour that indicates the background.
a660d684 KB	73
	74	\func{bool}{Create}{\param{const wxBitmap\& }{bitmap}, \param{int}{ index}}
	75
91b8de8d RR	76	Constructs a mask from a bitmap and a palette index that indicates the background. Not
91b8de8d RR	77	yet implemented for GTK.
a660d684 KB	78
	79	\wxheading{Parameters}
	80
	81	\docparam{bitmap}{A valid bitmap.}
	82
	83	\docparam{colour}{A colour specifying the transparency RGB values.}
	84
	85	\docparam{index}{Index into a palette, specifying the transparency colour.}
	86
	87