X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/c91108763b1621be54af24e24b2fab590db87325..c266eff98c5e44012647f54f38a1e29ecabd8759:/docs/latex/wx/mask.tex?ds=inline diff --git a/docs/latex/wx/mask.tex b/docs/latex/wx/mask.tex index e850fb3f16..c5c3cf2eb0 100644 --- a/docs/latex/wx/mask.tex +++ b/docs/latex/wx/mask.tex @@ -1,7 +1,8 @@ \section{\class{wxMask}}\label{wxmask} This class encapsulates a monochrome mask bitmap, where the masked area is black and -the unmasked area is white. +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} @@ -11,6 +12,10 @@ the unmasked area is white. +\wxheading{Library} + +\helpref{wxCore}{librarieslist} + \wxheading{Remarks} A mask may be associated with a \helpref{wxBitmap}{wxbitmap}. It is used in \helpref{wxDC::Blit}{wxdcblit} when @@ -23,19 +28,19 @@ contains a mask. \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxMask::wxMask}\label{wxmaskconstr} +\membersection{wxMask::wxMask}\label{wxmaskctor} \func{}{wxMask}{\void} Default constructor. -\func{}{wxMask}{\param{const wxBitmap\& }{bitmap}} +\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 wxBitmap\& }{bitmap}, \param{const wxColour\& }{colour}} +\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. @@ -55,7 +60,7 @@ yet implemented for GTK. \docparam{index}{Index into a palette, specifying the transparency colour.} -\membersection{wxMask::\destruct{wxMask}} +\membersection{wxMask::\destruct{wxMask}}\label{wxmaskdtor} \func{}{\destruct{wxMask}}{\void}