<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE erlref SYSTEM "erlref.dtd">

<!-- THIS FILE IS GENERATED DO NOT EDIT -->


<erlref>
<header>
  <copyright>
    <year>2020</year><year>2021</year>
    <holder>wxWidgets team.</holder></copyright>
  <legalnotice>Licensed under the wxWindows Free Documentation Licence, Version 3
  </legalnotice>
  <title>wxMask</title>
</header>
<module>wxMask</module>
<modulesummary>Functions for wxMask class</modulesummary>
<description><p>This class encapsulates a monochrome mask bitmap, where the masked area is black and the unmasked area is white.
      </p><p>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.
      </p><p>Note: A mask can be associated also with a bitmap with an alpha channel but drawing such bitmaps under wxMSW may be slow so using them should be avoided if drawing performance is an important factor.
      </p><p>See: <seeerl marker="wxBitmap"><c>wxBitmap</c></seeerl>, <seemfa marker="wxDC#blit/6"><c>wxDC:blit/6</c></seemfa>, <seeerl marker="wxMemoryDC"><c>wxMemoryDC</c></seeerl>
      </p>
  <p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_mask.html">wxMask</url></p>
  </description>
<datatypes><datatype><name name="wxMask"/></datatype></datatypes>

<funcs>
  <func>
    <name name="new" arity="0" clause_i="1" since=""/>
    <fsummary>Default constructor. </fsummary>
    <desc><p>Default constructor. 
      </p></desc>
  </func>
  
  <func>
    <name name="new" arity="1" clause_i="1" since=""/>
    <fsummary>Constructs a mask from a monochrome bitmap. </fsummary>
    <desc><p>Constructs a mask from a monochrome bitmap. 
      </p></desc>
  </func>
  
  <func>
    <name name="new" arity="2" clause_i="1" since=""/>
  
    <name name="new" arity="2" clause_i="2" since=""/>
    <fsummary>Constructs a mask from a bitmap and a colour that indicates the background. </fsummary>
    <desc><p>Constructs a mask from a bitmap and a colour that indicates the background. 
      </p></desc>
  </func>
  
  <func>
    <name name="destroy" arity="1" clause_i="1" since=""/>
    <fsummary>Destroys the <c>wxMask</c> object and the underlying bitmap data. </fsummary>
    <desc><p>Destroys the <seeerl marker="wxMask"><c>wxMask</c></seeerl> object and the underlying bitmap data. 
      </p></desc>
  </func>
  
  <func>
    <name name="create" arity="2" clause_i="1" since=""/>
    <fsummary>Constructs a mask from a monochrome bitmap. </fsummary>
    <desc><p>Constructs a mask from a monochrome bitmap. 
      </p></desc>
  </func>
  
  <func>
    <name name="create" arity="3" clause_i="1" since=""/>
  
    <name name="create" arity="3" clause_i="2" since=""/>
    <fsummary>Constructs a mask from a bitmap and a colour that indicates the background. </fsummary>
    <desc><p>Constructs a mask from a bitmap and a colour that indicates the background. 
      </p></desc>
  </func>
  </funcs>
</erlref>
