<?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>
    <holder>Ericsson AB. All Rights Reserved.</holder></copyright>
  <legalnotice>
      Licensed under the Apache License, Version 2.0 (the "License");
      you may not use this file except in compliance with the License.
      You may obtain a copy of the License at

          http://www.apache.org/licenses/LICENSE-2.0

      Unless required by applicable law or agreed to in writing, software
      distributed under the License is distributed on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      See the License for the specific language governing permissions and
      limitations under the License.

  </legalnotice>
  <title>wxBufferedPaintDC</title>
</header>
<module>wxBufferedPaintDC</module>
<modulesummary>Functions for wxBufferedPaintDC class</modulesummary>
<description><p>This is a subclass of <seeerl marker="wxBufferedDC"><c>wxBufferedDC</c></seeerl> which can be used inside of an <c>EVT_PAINT()</c> event handler to achieve double-buffered drawing. Just use this class instead of <seeerl marker="wxPaintDC"><c>wxPaintDC</c></seeerl> and make sure <seemfa marker="wxWindow#setBackgroundStyle/2"><c>wxWindow:setBackgroundStyle/2</c></seemfa> is called with wxBG_STYLE_PAINT somewhere in the class initialization code, and that's all you have to do to (mostly) avoid flicker. The only thing to watch out for is that if you are using this class together with <c>wxScrolled</c> (not implemented in wx), you probably do <c>not</c> want to call <seemfa marker="wxScrolledWindow#prepareDC/2"><c>wxScrolledWindow:prepareDC/2</c></seemfa> on it as it already does this internally for the real underlying <seeerl marker="wxPaintDC"><c>wxPaintDC</c></seeerl>.
      </p><p>See: <seeerl marker="wxDC"><c>wxDC</c></seeerl>, <seeerl marker="wxBufferedDC"><c>wxBufferedDC</c></seeerl>, <c>wxAutoBufferedPaintDC</c> (not implemented in wx), <seeerl marker="wxPaintDC"><c>wxPaintDC</c></seeerl>
      </p>
  <p>This class is derived (and can use functions) from: 
    <seeerl marker="wxBufferedDC"><c>wxBufferedDC</c></seeerl> <seeerl marker="wxMemoryDC"><c>wxMemoryDC</c></seeerl> <seeerl marker="wxDC"><c>wxDC</c></seeerl></p>
  
  <p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_buffered_paint_d_c.html">wxBufferedPaintDC</url></p>
  </description>
<datatypes><datatype><name name="wxBufferedPaintDC"/></datatype></datatypes>

<funcs>
  <func>
    <name name="new" arity="1" clause_i="1" since=""/>
    <fsummary>See: <c>new/2</c></fsummary>
  </func>
  
  <func>
    <name name="new" arity="2" clause_i="1" since=""/>
  
    <name name="new" arity="2" clause_i="2" since=""/>
    <fsummary/>
    <desc/>
  </func>
  
  <func>
    <name name="new" arity="3" clause_i="1" since=""/>
    <fsummary>As with <c>wxBufferedDC</c>, you may either provide the bitmap to be used for buffering or let this object create one internally (in the latter case, the size of the client part of the window is used). </fsummary>
    <desc><p>As with <seeerl marker="wxBufferedDC"><c>wxBufferedDC</c></seeerl>, you may either provide the bitmap to be used for buffering or let this object create one internally (in the latter case, the size of the client part of the window is used). 
      </p><p>Pass wxBUFFER_CLIENT_AREA for the <c>style</c> parameter to indicate that just the client area of the window is buffered, or wxBUFFER_VIRTUAL_AREA to indicate that the buffer bitmap covers the virtual area. 
      </p></desc>
  </func>
  
  <func>
    <name name="destroy" arity="1" clause_i="1" since=""/>
    <fsummary>Copies everything drawn on the DC so far to the window associated with this object, using a <c>wxPaintDC</c>. </fsummary>
    <desc><p>Copies everything drawn on the DC so far to the window associated with this object, using a <seeerl marker="wxPaintDC"><c>wxPaintDC</c></seeerl>. 
      </p></desc>
  </func>
  </funcs>
</erlref>
