d3c7cfeba9
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@9031 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
89 lines
2.6 KiB
TeX
89 lines
2.6 KiB
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. 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.
|
|
|
|
\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 \helpref{wxBitmap}{wxbitmap}\& }{bitmap}}
|
|
|
|
Constructs a mask from a monochrome bitmap.
|
|
|
|
\pythonnote{This is the default constructor for wxMask in wxPython.}
|
|
|
|
\func{}{wxMask}{\param{const \helpref{wxBitmap}{wxbitmap}\& }{bitmap}, \param{const \helpref{wxColour}{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.}
|
|
|
|
|