phoenix_title wx.MemoryDC

A memory device context provides a means to draw graphics onto a bitmap.

When drawing in to a mono-bitmap, using WHITE , WHITE_PEN and WHITE_BRUSH will draw the background colour (i.e. 0) whereas all other colours will draw the foreground colour (i.e. 1).

A bitmap must be selected into the new memory DC before it may be used for anything. Typical usage is as follows:

# Create a memory DC
temp_dc = wx.MemoryDC()
temp_dc.SelectObject(test_bitmap)

# We can now draw into the memory DC...
# Copy from this DC to another DC.
old_dc.Blit(250, 50, BITMAP_WIDTH, BITMAP_HEIGHT, temp_dc, 0, 0)

Note that the memory DC must be deleted (or the bitmap selected out of it) before a bitmap can be reselected into another memory DC.

And, before performing any other operations on the bitmap data, the bitmap must be selected out of the memory DC:

temp_dc.SelectObject(wx.NullBitmap)

This happens automatically when wx.MemoryDC object goes out of scope.

See also

wx.Bitmap, wx.DC


class_hierarchy Class Hierarchy

Inheritance diagram for class MemoryDC:

sub_classes Known Subclasses

wx.BufferedDC


method_summary Methods Summary

__init__

Constructs a new memory device context.

GetSelectedBitmap

SelectObject

Works exactly like SelectObjectAsSource but this is the function you should use when you select a bitmap because you want to modify it, e.g.

SelectObjectAsSource

Selects the given bitmap into the device context, to use as the memory bitmap.


property_summary Properties Summary

SelectedBitmap

See GetSelectedBitmap


api Class API

class wx.MemoryDC(DC)

Possible constructors:

MemoryDC()

MemoryDC(dc)

MemoryDC(bitmap)

A memory device context provides a means to draw graphics onto a bitmap.


Methods

__init__(self, *args, **kw)

overload Overloaded Implementations:



__init__ (self)

Constructs a new memory device context.

Use the wx.DC.IsOk member to test whether the constructor was successful in creating a usable device context. Don’t forget to select a bitmap into the DC before drawing on it.



__init__ (self, dc)

Constructs a new memory device context having the same characteristics as the given existing device context.

This constructor creates a memory device context compatible with dc in wxMSW, the argument is ignored in the other ports. If dc is None, a device context compatible with the screen is created, just as with the default constructor.

Parameters

dc (wx.DC) –



__init__ (self, bitmap)

Constructs a new memory device context and calls SelectObject with the given bitmap.

Use the wx.DC.IsOk member to test whether the constructor was successful in creating a usable device context.

Parameters

bitmap (wx.Bitmap) –





GetSelectedBitmap(self)
Return type

wx.Bitmap



SelectObject(self, bitmap)

Works exactly like SelectObjectAsSource but 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 incur some problems related to wx.Bitmap being a reference counted object (see Reference Counting).

Before using the updated bitmap data, make sure to select it out of context first either by selecting wx.NullBitmap into the device context or destroying the device context entirely.

If the bitmap is already selected in this device context, nothing is done. If it is selected in another context, the function asserts and drawing on the bitmap won’t work correctly.

Parameters

bitmap (wx.Bitmap) –

See also

wx.DC.DrawBitmap



SelectObjectAsSource(self, bitmap)

Selects the given bitmap into the device context, to use as the memory bitmap.

Selecting the bitmap into a memory DC allows you to draw into the DC (and therefore the bitmap) and also to use wx.DC.Blit to copy the bitmap to a window. For this purpose, you may find wx.DC.DrawIcon easier to use instead.

If the argument is wx.NullBitmap (or some other uninitialised wx.Bitmap) the current bitmap is selected out of the device context, and the original bitmap restored, allowing the current bitmap to be destroyed safely.

Parameters

bitmap (wx.Bitmap) –


Properties

SelectedBitmap

See GetSelectedBitmap