1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: wxBufferedDC class
4 // Author: Ron Lee <ron@debian.org>
5 // Modified by: Vadim Zeitlin (refactored, added bg preservation)
8 // Copyright: (c) Ron Lee
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 #ifndef _WX_DCBUFFER_H_
13 #define _WX_DCBUFFER_H_
15 #include "wx/dcmemory.h"
16 #include "wx/dcclient.h"
17 #include "wx/window.h"
19 // ----------------------------------------------------------------------------
20 // Double buffering helper.
21 // ----------------------------------------------------------------------------
23 class wxBufferedDC
: public wxMemoryDC
26 // Default ctor, must subsequently call Init for two stage construction.
27 wxBufferedDC() : m_dc( 0 )
31 // Construct a wxBufferedDC using a user supplied buffer.
32 wxBufferedDC(wxDC
*dc
, const wxBitmap
&buffer
)
39 // Construct a wxBufferedDC with an internal buffer of 'area'
40 // (where area is usually something like the size of the window
42 wxBufferedDC(wxDC
*dc
, const wxSize
&area
)
44 m_buffer( area
.GetWidth(), area
.GetHeight() )
49 // default copy ctor ok.
51 // The usually desired action in the dtor is to blit the buffer.
52 virtual ~wxBufferedDC()
57 // These reimplement the actions of the ctors for two stage creation, but
58 // are not used by the ctors themselves to save a few cpu cycles.
59 void Init(wxDC
*dc
, const wxBitmap
&buffer
)
61 wxASSERT_MSG( m_dc
== 0 && m_buffer
== wxNullBitmap
,
62 _T("wxBufferedDC already initialised") );
68 void Init(wxDC
*dc
, const wxSize
&area
)
70 Init(dc
, wxBitmap(area
.GetWidth(), area
.GetHeight()));
73 // Blits the buffer to the dc, and detaches the dc from the buffer (so it
74 // can be effectively used once only).
76 // Usually called in the dtor or by the dtor of derived classes if the
77 // BufferedDC must blit before the derived class (which may own the dc it's
78 // blitting to) is destroyed.
81 wxASSERT_MSG( m_dc
!= 0,
82 _T("No underlying DC associated with wxBufferedDC (anymore)") );
85 GetDeviceOrigin(& x
, & y
);
88 m_buffer
.GetWidth(), m_buffer
.GetHeight(), this,
94 // check that the bitmap is valid and use it
97 wxASSERT_MSG( m_buffer
.Ok(), _T("invalid bitmap in wxBufferedDC") );
99 SelectObject(m_buffer
);
102 // the underlying DC to which we copy everything drawn on this one in
105 // NB: Without the existence of a wxNullDC, this must be a pointer, else it
106 // could probably be a reference.
109 // the buffer (selected in this DC)
112 DECLARE_NO_COPY_CLASS(wxBufferedDC
)
116 // ----------------------------------------------------------------------------
117 // Double buffered PaintDC.
118 // ----------------------------------------------------------------------------
120 // Creates a double buffered wxPaintDC, optionally allowing the
121 // user to specify their own buffer to use.
122 class wxBufferedPaintDC
: public wxBufferedDC
125 // If no bitmap is supplied by the user, a temporary one wil; be created.
126 wxBufferedPaintDC(wxWindow
*window
, const wxBitmap
& buffer
= wxNullBitmap
)
129 if( buffer
!= wxNullBitmap
)
130 Init(&m_paintdc
, buffer
);
132 Init(&m_paintdc
, window
->GetClientSize());
135 // default copy ctor ok.
137 virtual ~wxBufferedPaintDC()
139 // We must UnMask here, else by the time the base class
140 // does it, the PaintDC will have already been destroyed.
147 DECLARE_NO_COPY_CLASS(wxBufferedPaintDC
)
150 #endif // _WX_DCBUFFER_H_