]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/latex/wx/memorydc.tex
remove C++ comment
[wxWidgets.git] / docs / latex / wx / memorydc.tex
... / ...
CommitLineData
1\section{\class{wxMemoryDC}}\label{wxmemorydc}
2
3A memory device context provides a means to draw graphics onto a bitmap. When
4drawing in to a mono-bitmap, using {\tt wxWHITE}, {\tt wxWHITE\_PEN} and
5{\tt wxWHITE\_BRUSH}
6will draw the background colour (i.e. 0) whereas all other colours will draw the
7foreground colour (i.e. 1).
8
9\wxheading{Derived from}
10
11\helpref{wxDC}{wxdc}\\
12\helpref{wxObject}{wxobject}
13
14\wxheading{Include files}
15
16<wx/dcmemory.h>
17
18\wxheading{Library}
19
20\helpref{wxCore}{librarieslist}
21
22\wxheading{Remarks}
23
24A bitmap must be selected into the new memory DC before it may be used
25for anything. Typical usage is as follows:
26
27\begin{verbatim}
28 // Create a memory DC
29 wxMemoryDC temp_dc;
30 temp_dc.SelectObject(test_bitmap);
31
32 // We can now draw into the memory DC...
33 // Copy from this DC to another DC.
34 old_dc.Blit(250, 50, BITMAP_WIDTH, BITMAP_HEIGHT, temp_dc, 0, 0);
35\end{verbatim}
36
37Note that the memory DC {\it must} be deleted (or the bitmap selected out of it) before a bitmap
38can be reselected into another memory DC.
39
40\wxheading{See also}
41
42\helpref{wxBitmap}{wxbitmap}, \helpref{wxDC}{wxdc}
43
44\latexignore{\rtfignore{\wxheading{Members}}}
45
46\membersection{wxMemoryDC::wxMemoryDC}\label{wxmemorydcctor}
47
48\func{}{wxMemoryDC}{\void}
49
50Constructs a new memory device context.
51
52Use the \helpref{IsOk}{wxdcisok} member to test whether the constructor was successful
53in creating a usable device context.
54Don't forget to select a bitmap into the DC before drawing on it.
55
56\func{}{wxMemoryDC}{\param{wxBitmap\& }{bitmap}}
57
58Constructs a new memory device context and calls \helpref{SelectObject}{wxmemorydcselectobject}
59with the given bitmap.
60Use the \helpref{IsOk}{wxdcisok} member to test whether the constructor was successful
61in creating a usable device context.
62
63
64\membersection{wxMemoryDC::SelectObject}\label{wxmemorydcselectobject}
65
66\func{void}{SelectObject}{\param{wxBitmap\& }{bitmap}}
67
68Works exactly like \helpref{SelectObjectAsSource}{wxmemorydcselectobjectassource} but
69this is the function you should use when you select a bitmap because you want to modify
70it, e.g. drawing on this DC.
71
72Be careful to use this function and not \helpref{SelectObjectAsSource}{wxmemorydcselectobjectassource}
73when you want to modify the bitmap you are selecting otherwise you may incurr in some
74problems related to wxBitmap being a reference counted object
75(see \helpref{reference counting overview}{trefcount}).
76
77\wxheading{See also}
78
79\helpref{wxDC::DrawBitmap}{wxdcdrawbitmap}
80
81
82
83\membersection{wxMemoryDC::SelectObjectAsSource}\label{wxmemorydcselectobjectassource}
84
85\func{void}{SelectObjectAsSource}{\param{const wxBitmap\& }{bitmap}}
86
87Selects the given bitmap into the device context, to use as the memory
88bitmap. Selecting the bitmap into a memory DC allows you to draw into
89the DC (and therefore the bitmap) and also to use \helpref{wxDC::Blit}{wxdcblit} to copy
90the bitmap to a window. For this purpose, you may find \helpref{wxDC::DrawIcon}{wxdcdrawicon}\rtfsp
91easier to use instead.
92
93If the argument is wxNullBitmap (or some other uninitialised wxBitmap) the current bitmap is
94selected out of the device context, and the original bitmap restored, allowing the current bitmap to
95be destroyed safely.
96
97\wxheading{See also}
98
99\helpref{wxMemoryDC::SelectObject}{wxmemorydcselectobject}
100