X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/23324ae1c7938ba904770fc456d3c07764b9c5e9..7c0d297a1f761de31d3a4ac924fa2080b5bbaf41:/interface/dcmemory.h diff --git a/interface/dcmemory.h b/interface/dcmemory.h index d8c0520a6a..5b3d9b97db 100644 --- a/interface/dcmemory.h +++ b/interface/dcmemory.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: dcmemory.h -// Purpose: documentation for wxMemoryDC class +// Purpose: interface of wxMemoryDC // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -9,18 +9,17 @@ /** @class wxMemoryDC @wxheader{dcmemory.h} - + A memory device context provides a means to draw graphics onto a bitmap. When drawing in to a mono-bitmap, using @c wxWHITE, @c wxWHITE_PEN and @c wxWHITE_BRUSH will draw the background colour (i.e. 0) whereas all other colours will draw the foreground colour (i.e. 1). - + @library{wxcore} @category{dc} - - @seealso - wxBitmap, wxDC + + @see wxBitmap, wxDC */ class wxMemoryDC : public wxDC { @@ -33,7 +32,7 @@ public: in creating a usable device context. */ wxMemoryDC(); - wxMemoryDC(wxBitmap& bitmap); + wxMemoryDC(wxBitmap& bitmap); //@} /** @@ -41,17 +40,15 @@ public: this is the function you should use when you select a bitmap because you want to modify it, e.g. drawing on this DC. - Using SelectObjectAsSource() when modifying the bitmap may incurr some problems related to wxBitmap being a reference counted object (see @ref overview_trefcount "reference counting overview"). - Also, before using the updated bitmap data, make sure to select it out of context first (for example by selecting wxNullBitmap into the device context). - - @sa wxDC::DrawBitmap + + @see wxDC::DrawBitmap */ void SelectObject(wxBitmap& bitmap); @@ -61,7 +58,6 @@ public: the DC (and therefore the bitmap) and also to use wxDC::Blit to copy the bitmap to a window. For this purpose, you may find wxDC::DrawIcon easier to use instead. - If the argument is wxNullBitmap (or some other uninitialised wxBitmap) the current bitmap is selected out of the device context, and the original bitmap restored, allowing @@ -70,3 +66,4 @@ public: */ void SelectObjectAsSource(const wxBitmap& bitmap); }; +