X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/a660d684eda27638bca0384b2058911a31c8e845..a84ece11fffdde5d1bbd254ba58ac3cee79c2e77:/docs/latex/wx/mask.tex?ds=sidebyside diff --git a/docs/latex/wx/mask.tex b/docs/latex/wx/mask.tex index 7f004df69e..86e80d898d 100644 --- a/docs/latex/wx/mask.tex +++ b/docs/latex/wx/mask.tex @@ -1,12 +1,17 @@ \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} \helpref{wxObject}{wxobject} +\wxheading{Include files} + + + \wxheading{Remarks} A mask may be associated with a \helpref{wxBitmap}{wxbitmap}. It is used in \helpref{wxDC::Blit}{wxdcblit} when @@ -25,17 +30,23 @@ contains a mask. Default constructor. -\func{}{wxMask}{\param{const wxBitmap\& }{bitmap}} +\func{}{wxMask}{\param{const \helpref{wxBitmap}{wxbitmap}\& }{bitmap}} Constructs a mask from a monochrome bitmap. -\func{}{wxMask}{\param{const wxBitmap\& }{bitmap}, \param{const wxColour\& }{colour}} +\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. +Constructs a mask from a bitmap and a palette index that indicates the background. Not +yet implemented for GTK. \wxheading{Parameters} @@ -63,7 +74,8 @@ 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. +Constructs a mask from a bitmap and a palette index that indicates the background. Not +yet implemented for GTK. \wxheading{Parameters}