git.saurik.com Git - wxWidgets.git/blame_incremental

... / ...

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