X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/a66f2f42f5a31702624f6fccbd3b9ad37e1993c8..59720690dfa73732d165642d6e9cb8330a92549b:/include/wx/dcbuffer.h diff --git a/include/wx/dcbuffer.h b/include/wx/dcbuffer.h index 7cf03a4a66..1b12cc6f05 100644 --- a/include/wx/dcbuffer.h +++ b/include/wx/dcbuffer.h @@ -12,56 +12,84 @@ #ifndef _WX_DCBUFFER_H_ #define _WX_DCBUFFER_H_ -#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) - #pragma interface "dcbuffer.h" -#endif - #include "wx/dcmemory.h" #include "wx/dcclient.h" +#include "wx/window.h" + +// Split platforms into two groups - those which have well-working +// double-buffering by default, and those which do not. +#if defined(__WXMAC__) || defined(__WXGTK20__) || defined(__WXDFB__) + #define wxALWAYS_NATIVE_DOUBLE_BUFFER 1 +#else + #define wxALWAYS_NATIVE_DOUBLE_BUFFER 0 +#endif -// flags for wxBufferedDC ctor/Init() -enum -{ - // this is more efficient and hence default - wxBUFFER_DC_OVERWRITE_BG = 0, - - // preserve the old background: more time consuming - wxBUFFER_DC_PRESERVE_BG = 1, - - - // flags used by default - wxBUFFER_DC_DEFAULT = wxBUFFER_DC_PRESERVE_BG -}; // ---------------------------------------------------------------------------- // Double buffering helper. // ---------------------------------------------------------------------------- -class WXDLLIMPEXP_ADV wxBufferedDC : public wxMemoryDC +// Assumes the buffer bitmap covers the entire scrolled window, +// and prepares the window DC accordingly +#define wxBUFFER_VIRTUAL_AREA 0x01 + +// Assumes the buffer bitmap only covers the client area; +// does not prepare the window DC +#define wxBUFFER_CLIENT_AREA 0x02 + +class WXDLLEXPORT wxBufferedDC : public wxMemoryDC { public: // Default ctor, must subsequently call Init for two stage construction. - wxBufferedDC() : m_dc( 0 ) + wxBufferedDC() + : m_dc(NULL), + m_style(0) { } // Construct a wxBufferedDC using a user supplied buffer. - wxBufferedDC(wxDC *dc, const wxBitmap &buffer); + wxBufferedDC(wxDC *dc, + const wxBitmap& buffer = wxNullBitmap, + int style = wxBUFFER_CLIENT_AREA) + : m_dc(NULL) + { + Init(dc, buffer, style); + } // Construct a wxBufferedDC with an internal buffer of 'area' // (where area is usually something like the size of the window // being buffered) - wxBufferedDC(wxDC *dc, const wxSize &area, int flags = wxBUFFER_DC_DEFAULT); - - // default copy ctor ok. + wxBufferedDC(wxDC *dc, const wxSize& area, int style = wxBUFFER_CLIENT_AREA) + : m_dc(NULL) + { + Init(dc, area, style); + } // The usually desired action in the dtor is to blit the buffer. - virtual ~wxBufferedDC() { if ( m_dc ) UnMask(); } + virtual ~wxBufferedDC() + { + if ( m_dc ) + UnMask(); + } - // These reimplement the actions of the ctors for two stage creation, but - // are not used by the ctors themselves to save a few cpu cycles. - void Init(wxDC *dc, const wxBitmap &bitmap); - void Init(wxDC *dc, const wxSize &area, int flags = wxBUFFER_DC_DEFAULT); + // These reimplement the actions of the ctors for two stage creation + void Init(wxDC *dc, + const wxBitmap& buffer = wxNullBitmap, + int style = wxBUFFER_CLIENT_AREA) + { + InitCommon(dc, style); + + m_buffer = buffer; + + UseBuffer(); + } + + void Init(wxDC *dc, const wxSize &area, int style = wxBUFFER_CLIENT_AREA) + { + InitCommon(dc, style); + + UseBuffer(area.x, area.y); + } // Blits the buffer to the dc, and detaches the dc from the buffer (so it // can be effectively used once only). @@ -69,32 +97,57 @@ public: // Usually called in the dtor or by the dtor of derived classes if the // BufferedDC must blit before the derived class (which may own the dc it's // blitting to) is destroyed. - void UnMask(); - -private: - // check that the bitmap is valid and use it - void UseBuffer() + void UnMask() { - wxASSERT_MSG( m_buffer.Ok(), _T("invalid bitmap in wxBufferedDC") ); + wxCHECK_RET( m_dc, _T("no underlying wxDC?") ); + wxASSERT_MSG( m_buffer.IsOk(), _T("invalid backing store") ); + + wxCoord x = 0, + y = 0; + + if ( m_style & wxBUFFER_CLIENT_AREA ) + GetDeviceOrigin(&x, &y); - SelectObject(m_buffer); + m_dc->Blit(0, 0, m_buffer.GetWidth(), m_buffer.GetHeight(), + this, -x, -y ); + m_dc = NULL; } - // preserve the background if necessary - void SaveBg(const wxSize& area, int flags) + // Set and get the style + void SetStyle(int style) { m_style = style; } + int GetStyle() const { return m_style; } + +private: + // common part of Init()s + void InitCommon(wxDC *dc, int style) { - if ( flags & wxBUFFER_DC_PRESERVE_BG ) - { - Blit(0, 0, area.GetWidth(), area.GetHeight(), m_dc, 0, 0); - } + wxASSERT_MSG( !m_dc, _T("wxBufferedDC already initialised") ); + + m_dc = dc; + m_style = style; + + // inherit the same layout direction as the original DC + if (dc && dc->IsOk()) + SetLayoutDirection(dc->GetLayoutDirection()); } - // Without the existence of a wxNullDC, this must be - // a pointer, else it could probably be a reference. - wxDC *m_dc; + // check that the bitmap is valid and use it + void UseBuffer(wxCoord w = -1, wxCoord h = -1); + + // the underlying DC to which we copy everything drawn on this one in + // UnMask() + // + // NB: Without the existence of a wxNullDC, this must be a pointer, else it + // could probably be a reference. + wxDC *m_dc; - wxBitmap m_buffer; + // the buffer (selected in this DC), initially invalid + wxBitmap m_buffer; + // the buffering style + int m_style; + + DECLARE_DYNAMIC_CLASS(wxBufferedDC) DECLARE_NO_COPY_CLASS(wxBufferedDC) }; @@ -105,25 +158,32 @@ private: // Creates a double buffered wxPaintDC, optionally allowing the // user to specify their own buffer to use. -class WXDLLIMPEXP_ADV wxBufferedPaintDC : public wxBufferedDC +class WXDLLEXPORT wxBufferedPaintDC : public wxBufferedDC { public: - // this ctor creates a bitmap of the size of the window for buffering - wxBufferedPaintDC(wxWindow *window, int flags = wxBUFFER_DC_DEFAULT) + // If no bitmap is supplied by the user, a temporary one will be created. + wxBufferedPaintDC(wxWindow *window, const wxBitmap& buffer, int style = wxBUFFER_CLIENT_AREA) : m_paintdc(window) { - Prepare(window); - - Init(&m_paintdc, window->GetClientSize(), flags); + // If we're buffering the virtual window, scale the paint DC as well + if (style & wxBUFFER_VIRTUAL_AREA) + window->PrepareDC( m_paintdc ); + + if( buffer != wxNullBitmap ) + Init(&m_paintdc, buffer, style); + else + Init(&m_paintdc, window->GetClientSize(), style); } - // the bitmap must be valid here - wxBufferedPaintDC(wxWindow *window, const wxBitmap& buffer) + // If no bitmap is supplied by the user, a temporary one will be created. + wxBufferedPaintDC(wxWindow *window, int style = wxBUFFER_CLIENT_AREA) : m_paintdc(window) { - Prepare(window); + // If we're using the virtual window, scale the paint DC as well + if (style & wxBUFFER_VIRTUAL_AREA) + window->PrepareDC( m_paintdc ); - Init(&m_paintdc, buffer); + Init(&m_paintdc, window->GetClientSize(), style); } // default copy ctor ok. @@ -136,16 +196,71 @@ public: } private: - // prepare the underlying DC - void Prepare(wxWindow *window) + wxPaintDC m_paintdc; + + DECLARE_ABSTRACT_CLASS(wxBufferedPaintDC) + DECLARE_NO_COPY_CLASS(wxBufferedPaintDC) +}; + + + +// +// wxAutoBufferedPaintDC is a wxPaintDC in toolkits which have double- +// buffering by default. Otherwise it is a wxBufferedPaintDC. Thus, +// you can only expect it work with a simple constructor that +// accepts single wxWindow* argument. +// +#if wxALWAYS_NATIVE_DOUBLE_BUFFER + #define wxAutoBufferedPaintDCBase wxPaintDC +#else + #define wxAutoBufferedPaintDCBase wxBufferedPaintDC +#endif + + +#ifdef __WXDEBUG__ + +class wxAutoBufferedPaintDC : public wxAutoBufferedPaintDCBase +{ +public: + + wxAutoBufferedPaintDC(wxWindow* win) + : wxAutoBufferedPaintDCBase(win) { - window->PrepareDC(m_paintdc); + TestWinStyle(win); } - wxPaintDC m_paintdc; + virtual ~wxAutoBufferedPaintDC() { } - DECLARE_NO_COPY_CLASS(wxBufferedPaintDC) +private: + + void TestWinStyle(wxWindow* win) + { + // Help the user to get the double-buffering working properly. + wxASSERT_MSG( win->GetBackgroundStyle() == wxBG_STYLE_CUSTOM, + wxT("In constructor, you need to call SetBackgroundStyle(wxBG_STYLE_CUSTOM), ") + wxT("and also, if needed, paint the background manually in the paint event handler.")); + } + + DECLARE_NO_COPY_CLASS(wxAutoBufferedPaintDC) }; -#endif // _WX_DCBUFFER_H_ +#else // !__WXDEBUG__ + +// In release builds, just use typedef +typedef wxAutoBufferedPaintDCBase wxAutoBufferedPaintDC; + +#endif + +// Check if the window is natively double buffered and will return a wxPaintDC +// if it is, a wxBufferedPaintDC otherwise. It is the caller's responsibility +// to delete the wxDC pointer when finished with it. +inline wxDC* wxAutoBufferedPaintDCFactory(wxWindow* window) +{ + if ( window->IsDoubleBuffered() ) + return new wxPaintDC(window); + else + return new wxBufferedPaintDC(window); +} + +#endif // _WX_DCBUFFER_H_