phoenix_title wx.BufferedDC

This class provides a simple way to avoid flicker: when drawing on it, everything is in fact first drawn on an in-memory buffer (a wx.Bitmap) and then copied to the screen, using the associated wx.DC, only once, when this object is destroyed.

wx.BufferedDC itself is typically associated with wx.ClientDC, if you want to use it in your EVT_PAINT handler, you should look at wx.BufferedPaintDC instead.

When used like this, a valid DC must be specified in the constructor while the buffer bitmap doesn’t have to be explicitly provided, by default this class will allocate the bitmap of required size itself. However using a dedicated bitmap can speed up the redrawing process by eliminating the repeated creation and destruction of a possibly big bitmap. Otherwise, wx.BufferedDC can be used in the same way as any other device context.

Another possible use for wx.BufferedDC is to use it to maintain a backing store for the window contents. In this case, the associated DC may be None but a valid backing store bitmap should be specified.

Finally, please note that GTK+ 2.0 as well as OS X provide double buffering themselves natively. You can either use wx.Window.IsDoubleBuffered to determine whether you need to use buffering or not, or use wx.AutoBufferedPaintDC to avoid needless double buffering on the systems which already do it automatically.


class_hierarchy Class Hierarchy

Inheritance diagram for class BufferedDC:

sub_classes Known Subclasses

wx.BufferedPaintDC


method_summary Methods Summary

__init__

Default constructor.

GetStyle

Get the style.

Init

Initializes the object created using the default constructor.

SetStyle

Set the style.

UnMask

Blits the buffer to the dc, and detaches the dc from the buffer (so it can be effectively used once only).


property_summary Properties Summary

Style

See GetStyle and SetStyle


api Class API

class wx.BufferedDC(MemoryDC)

Possible constructors:

BufferedDC()

BufferedDC(dc, area, style=BUFFER_CLIENT_AREA)

BufferedDC(dc, buffer=NullBitmap, style=BUFFER_CLIENT_AREA)

This class provides a simple way to avoid flicker: when drawing on it, everything is in fact first drawn on an in-memory buffer (a Bitmap) and then copied to the screen, using the associated DC, only once, when this object is destroyed.


Methods

__init__(self, *args, **kw)

overload Overloaded Implementations:



__init__ (self)

Default constructor.

You must call one of the Init methods later in order to use the device context.



__init__ (self, dc, area, style=BUFFER_CLIENT_AREA)

Creates a buffer for the provided dc.

Init must not be called when using this constructor.

Parameters
  • dc (wx.DC) – The underlying DC: everything drawn to this object will be flushed to this DC when this object is destroyed. You may pass None in order to just initialize the buffer, and not flush it.

  • area (wx.Size) – The size of the bitmap to be used for buffering (this bitmap is created internally when it is not given explicitly).

  • style (int) – wx.BUFFER_CLIENT_AREA to indicate that just the client area of the window is buffered, or wx.BUFFER_VIRTUAL_AREA to indicate that the buffer bitmap covers the virtual area.



__init__ (self, dc, buffer=NullBitmap, style=BUFFER_CLIENT_AREA)

Creates a buffer for the provided dc.

Init must not be called when using this constructor.

Parameters
  • dc (wx.DC) – The underlying DC: everything drawn to this object will be flushed to this DC when this object is destroyed. You may pass None in order to just initialize the buffer, and not flush it.

  • buffer (wx.Bitmap) – Explicitly provided bitmap to be used for buffering: this is the most efficient solution as the bitmap doesn’t have to be recreated each time but it also requires more memory as the bitmap is never freed. The bitmap should have appropriate size, anything drawn outside of its bounds is clipped.

  • style (int) – wx.BUFFER_CLIENT_AREA to indicate that just the client area of the window is buffered, or wx.BUFFER_VIRTUAL_AREA to indicate that the buffer bitmap covers the virtual area.





GetStyle(self)

Get the style.

Return type

int



Init(self, *args, **kw)

Initializes the object created using the default constructor.

Please see the constructors for parameter details.

overload Overloaded Implementations:



Init (self, dc, area, style=BUFFER_CLIENT_AREA)

Parameters



Init (self, dc, buffer=NullBitmap, style=BUFFER_CLIENT_AREA)

Parameters





SetStyle(self, style)

Set the style.

Parameters

style (int) –



UnMask(self)

Blits the buffer to the dc, and detaches the dc from the buffer (so it can be effectively used once only).

Usually only called in the destructor or by the destructor of derived classes if the BufferedDC must blit before the derived class (which may own the dc it’s blitting to) is destroyed.


Properties

Style

See GetStyle and SetStyle