This class encapsulates the concept of a platform-dependent bitmap, either monochrome or colour or colour with alpha channel support.

If you need direct access the bitmap data instead going through drawing to it usingwx.MemoryDC you need to use the PixelDataclass (either NativePixelData for RGB bitmaps or AlphaPixelData for bitmaps with an additionally alpha channel).

Note that manywx.Bitmap functions take a type parameter, which is a value of thewx.BitmapType enumeration. The validity of those values depends however on the platform where your program is running and from the wxWidgets configuration. If all possible wxWidgets settings are used:

wxMSW supports BMP and ICO files, BMP and ICO resources;

wxGTK supports any file supported by gdk-pixbuf;

Mac supports PICT resources;

X11 supports XPM files, XPM data, XBM data;

In addition,wx.Bitmap can load and save all formats thatwx.Image can; seewx.Image for more info. Of course, you must have loaded thewx.Image handlers (see wx.InitAllImageHandlersand wx.Image.AddHandler ). Note that all available BitmapHandlers for a given wxWidgets port are automatically loaded at startup so you won’t need to use wx.Bitmap.AddHandler .

More on the difference betweenwx.Image andwx.Bitmap:wx.Image is just a buffer of RGB bytes with an optional buffer for the alpha bytes. It is all generic, platform independent and image file format independent code. It includes generic code for scaling, resizing, clipping, and other manipulations of the image data. OTOH,wx.Bitmap is intended to be a wrapper of whatever is the native image format that is quickest/easiest to draw to a DC or to be the target of the drawing operations performed on awx.MemoryDC. By splitting the responsibilities between Image/wxBitmap like this then it’s easier to use generic code shared by all platforms and image types for generic operations and platform specific code where performance or compatibility is needed.

See also

Bitmaps and Icons, Supported Bitmap File Formats, wx.DC.Blit ,wx.Icon,wx.Cursor,wx.MemoryDC,wx.Image, PixelData

__init__

Default constructor.

ConvertToDisabled

Returns disabled (dimmed) version of the bitmap.

ConvertToImage

Creates an image from a platform-dependent bitmap.

CopyFromBuffer

Copy data from a buffer object to replace the bitmap pixel data.

CopyFromIcon

Creates the bitmap from an icon.

CopyToBuffer

Copy pixel data to a buffer object. See CopyFromBuffer for buffer

Create

Creates a fresh bitmap.

CreateScaled

Create a bitmap with a scale factor.

CreateWithDIPSize

Create a bitmap specifying its size in DPI-independent pixels and the scale factor to use.

FromBuffer

Creates a wx.Bitmap from in-memory data. The data parameter

FromBufferAndAlpha

Creates a wx.Bitmap from in-memory data. The data and alpha

FromBufferRGBA

Creates a wx.Bitmap from in-memory data. The data parameter

FromPNGData

Like NewFromPNGData but with a simpler API accepting a Python

FromRGBA

Creates a new empty 32-bit wx.Bitmap where every pixel has been

GetDIPSize

Returns the size of bitmap in DPI-independent units.

GetDepth

Gets the colour depth of the bitmap.

GetHandle

MSW-only method to fetch the windows handle for the bitmap.

GetHeight

Returns the height of the bitmap in physical pixels.

GetLogicalHeight

Returns the height of the bitmap in logical pixels.

GetLogicalSize

Returns the size of the bitmap in logical pixels.

GetLogicalWidth

Returns the width of the bitmap in logical pixels.

GetMask

Gets the associated mask (if any) which may have been loaded from a file or set for the bitmap.

GetPalette

Gets the associated palette (if any) which may have been loaded from a file or set for the bitmap.

GetScaleFactor

Returns the scale factor of this bitmap.

GetScaledHeight

Returns the height of the bitmap in logical pixels.

GetScaledSize

Returns the size of the bitmap in logical pixels.

GetScaledWidth

Returns the width of the bitmap in logical pixels.

GetSize

Returns the size of the bitmap in physical pixels.

GetSubBitmap

Returns a sub bitmap of the current one as long as the rect belongs entirely to the bitmap.

GetWidth

Returns the width of the bitmap in physical pixels.

HasAlpha

Returns True if the bitmap has an alpha channel.

IsOk

Returns True if bitmap data is present.

LoadFile

Loads a bitmap from a file or resource.

NewFromPNGData

Loads a bitmap from the memory containing image data in PNG format.

Rescale

Rescale the given bitmap to the requested size.

ResetAlpha

Remove alpha channel from the bitmap.

SaveFile

Saves a bitmap in the named file.

SetDepth

SetHandle

MSW-only method to set the windows handle for the bitmap.

SetHeight

SetMask

Sets the mask for this bitmap.

SetMaskColour

Create a mask for this bitmap based on the pixels with the given colour.

SetPalette

Sets the associated palette.

SetScaleFactor

Sets the bitmap scale factor.

SetSize

Set the bitmap size (does not alter the existing native bitmap data or image size).

SetWidth

UseAlpha

Enable or disable use of alpha channel in this bitmap.

__bool__

__nonzero__

DIPSize

See GetDIPSize

Depth

See GetDepth and SetDepth

Handle

See GetHandle and SetHandle

Height

See GetHeight and SetHeight

LogicalHeight

See GetLogicalHeight

LogicalSize

See GetLogicalSize

LogicalWidth

See GetLogicalWidth

Mask

See GetMask and SetMask

Palette

See GetPalette and SetPalette

ScaleFactor

See GetScaleFactor and SetScaleFactor

ScaledHeight

See GetScaledHeight

ScaledSize

See GetScaledSize

ScaledWidth

See GetScaledWidth

Size

See GetSize and SetSize

Width

See GetWidth and SetWidth

Possible constructors:

This class encapsulates the concept of a platform-dependent bitmap,either monochrome or colour or colour with alpha channel support.

Overloaded Implementations:

__init__ (self)

Default constructor.

Constructs a bitmap object with no data; an assignment or another member function such as Createor LoadFilemust be called subsequently.

__init__ (self, bitmap)

Copy constructor, uses reference counting.

To make a real copy, you can use:

bitmap (wx.Bitmap) –

__init__ (self, bits, width, height, depth=1)

Creates a bitmap from the given array bits.

You should only use this function for monochrome bitmaps (depth 1) in portable programs: in this case the bits parameter should contain an XBM image.

For other bit depths, the behaviour is platform dependent: under Windows, the data is passed without any changes to the underlying CreateBitmap() API. Under other platforms, only monochrome bitmaps may be created using this constructor andwx.Image should be used for creating colour bitmaps from static data.

bits (string) – Specifies an array of pixel values.

width (int) – Specifies the width of the bitmap.

height (int) – Specifies the height of the bitmap.

depth (int) – Specifies the depth of the bitmap. If this is omitted, then a value of 1 (monochrome bitmap) is used.

__init__ (self, width, height, depth=BITMAP_SCREEN_DEPTH)

Creates a new bitmap.

A depth of BITMAP_SCREEN_DEPTH indicates the depth of the current screen or visual.

Some platforms only support 1 for monochrome and BITMAP_SCREEN_DEPTH for the current colour setting.

A depth of 32 including an alpha channel is supported under MSW, Mac and GTK+.

width (int) – The width of the bitmap in pixels, must be strictly positive.

height (int) – The height of the bitmap in pixels, must be strictly positive.

depth (int) – The number of bits used to represent each bitmap pixel.

__init__ (self, sz, depth=BITMAP_SCREEN_DEPTH)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

sz (wx.Size) –

depth (int) –

__init__ (self, width, height, dc)

Create a bitmap compatible with the given DC, inheriting its magnification factor.

width (int) – The width of the bitmap in pixels, must be strictly positive.

height (int) – The height of the bitmap in pixels, must be strictly positive.

dc (wx.DC) – DC from which the scaling factor is inherited

New in version 4.1/wxWidgets-3.1.7: (previously available only in wxMSW and wxOSX ports).

__init__ (self, name, type=BITMAP_TYPE_ANY)

Loads a bitmap from a file or resource.

name (string) – This can refer to a resource name or a filename under MS Windows and X. Its meaning is determined by the type parameter.

type (BitmapType) – May be one of thewx.BitmapType values and indicates which type of bitmap should be loaded. See the note in the class detailed description. Note that the BITMAP_DEFAULT_TYPE constant has different value under different wxWidgets ports. See the bitmap.h header for the value it takes for a specific port.

See also

LoadFile

__init__ (self, img, depth=BITMAP_SCREEN_DEPTH)

Creates this bitmap object from the given image.

This has to be done to actually display an image as you cannot draw an image directly on a window.

The resulting bitmap will use the provided colour depth (or that of the current system if depth is BITMAP_SCREEN_DEPTH) which entails that a colour reduction may take place.

On Windows, if there is a palette present (set with SetPalette), it will be used when creating thewx.Bitmap (most useful in 8-bit display mode). On other platforms, the palette is currently ignored.

img (wx.Image) – Platform-independentwx.Image object.

depth (int) – Specifies the depth of the bitmap. If this is omitted, the display depth of the screen is used.

__init__ (self, img, dc)

Creates a bitmap compatible with the given DC from the given image.

This constructor initializes the bitmap with the data of the given image, which must be valid, but inherits the scaling factor from the given device context instead of simply using the default factor of 1.

img (wx.Image) – Platform-independentwx.Image object.

dc (wx.DC) – DC from which the scaling factor is inherited

New in version 4.1/wxWidgets-3.1.7: (previously this constructor overload was only available in wxMSW port)

__init__ (self, listOfBytes)

Construct a Bitmap from a list of strings formatted as XPM data.

Returns disabled (dimmed) version of the bitmap.

This method is not available when USE_IMAGE == 0 .

brightness (int) –

wx.Bitmap

New in version 2.9.0.

Creates an image from a platform-dependent bitmap.

This preserves mask information so that bitmaps and images can be converted back and forth without loss in that respect.

wx.Image

Copy data from a buffer object to replace the bitmap pixel data.Default format is plain RGB, but other formats are now supported aswell. The following symbols are used to specify the format of thebytes in the buffer:

wx.BitmapBufferFormat_RGB

A simple sequence of RGB bytes

wx.BitmapBufferFormat_RGBA

A simple sequence of RGBA bytes

wx.BitmapBufferFormat_ARGB32

A sequence of 32-bit values in native endian order, with alpha in the upper 8 bits, followed by red, green, and blue.

wx.BitmapBufferFormat_RGB32

Same as above but the alpha byte is ignored.

Creates the bitmap from an icon.

icon (wx.Icon) –

bool

Copy pixel data to a buffer object. See CopyFromBuffer for bufferformat details.

Overloaded Implementations:

Create (self, width, height, depth=BITMAP_SCREEN_DEPTH)

Creates a fresh bitmap.

If the final argument is omitted, the display depth of the screen is used.

width (int) – The width of the bitmap in pixels, must be strictly positive.

height (int) – The height of the bitmap in pixels, must be strictly positive.

depth (int) – The number of bits used to represent each bitmap pixel.

bool

True if the creation was successful.

Create (self, sz, depth=BITMAP_SCREEN_DEPTH)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

sz (wx.Size) –

depth (int) –

bool

Create (self, width, height, dc)

Create a bitmap compatible with the given DC, inheriting its magnification factor.

width (int) – The width of the bitmap in pixels, must be strictly positive.

height (int) – The height of the bitmap in pixels, must be strictly positive.

dc (wx.DC) – DC from which the scaling factor is inherited

bool

True if the creation was successful.

New in version 4.1/wxWidgets-3.1.0.

Create a bitmap with a scale factor.

This is an older synonym for CreateWithDIPSize , use the new function in the new code.

width (int) – The width of the bitmap in pixels, must be strictly positive.

height (int) – The height of the bitmap in pixels, must be strictly positive.

depth (int) – The number of bits used to represent each bitmap pixel.

logicalScale (float) – Scale factor used by the bitmap, see SetScaleFactor .

bool

True if the creation was successful.

New in version 4.1/wxWidgets-3.1.0.

Overloaded Implementations:

CreateWithDIPSize (self, size, scale, depth=BITMAP_SCREEN_DEPTH)

Create a bitmap specifying its size in DPI-independent pixels and the scale factor to use.

The physical size of the bitmap is obtained by multiplying the given size by scale and rounding it to the closest integer.

After using this function the following postconditions are True:

GetSizereturns size multiplied by scale

GetDIPSizereturns size

GetScaleFactorreturns scale

size (wx.Size) – The size of the bitmap in DPI-independent pixels. Both width and height must be strictly positive.

scale (float) – Scale factor used by the bitmap, see SetScaleFactor .

depth (int) – The number of bits used to represent each bitmap pixel.

bool

True if the creation was successful.

New in version 4.1/wxWidgets-3.1.6.

CreateWithDIPSize (self, width, height, scale, depth=BITMAP_SCREEN_DEPTH)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

width (int) –

height (int) –

scale (float) –

depth (int) –

bool

Creates a wx.Bitmap from in-memory data. The data parametermust be a Python object that implements the buffer interface, suchas a string, bytearray, etc. The data object is expected to containa series of RGB bytes and be at least (width  height  3) bytes long.

Unlike wx.ImageFromBuffer the bitmap created with this functiondoes not share the memory block with the buffer object. This isbecause the native pixel buffer format varies on differentplatforms, and so instead an efficient as possible copy of thedata is made from the buffer object to the bitmap’s native pixelbuffer.

wx.Bitmap

Creates a wx.Bitmap from in-memory data. The data and alphaparameters must be a Python object that implements the bufferinterface, such as a string, bytearray, etc. The data objectis expected to contain a series of RGB bytes and be at least(width  height  3) bytes long, while the alpha object is expectedto be (width  height) bytes long and represents the image’s alphachannel. On Windows and Mac the RGB values will be‘premultiplied’ by the alpha values. (The other platforms dothe multiplication themselves.)

Unlike wx.ImageFromBuffer the bitmap created with this functiondoes not share the memory block with the buffer object. This isbecause the native pixel buffer format varies on differentplatforms, and so instead an efficient as possible copy of thedata is made from the buffer object to the bitmap’s native pixelbuffer.

wx.Bitmap

Creates a wx.Bitmap from in-memory data. The data parametermust be a Python object that implements the buffer interface, suchas a string, bytearray, etc. The data object is expected to containa series of RGBA bytes and be at least (width  height  4) bytes long.On Windows and Mac the RGB values will be ‘premultiplied’ by thealpha values. (The other platforms do the multiplication themselves.)

Unlike wx.ImageFromBuffer the bitmap created with this functiondoes not share the memory block with the buffer object. This isbecause the native pixel buffer format varies on differentplatforms, and so instead an efficient as possible copy of thedata is made from the buffer object to the bitmap’s native pixelbuffer.

wx.Bitmap

Like NewFromPNGData, but with a simpler API accepting a Pythonbuffer-compatible object.

wx.Bitmap

Creates a new empty 32-bit wx.Bitmap where every pixel has beeninitialized with the given RGBA values.

wx.Bitmap

Returns the size of bitmap in DPI-independent units.

This assumes that the bitmap was created using the value of scale factor corresponding to the current DPI (see CreateWithDIPSizeand SetScaleFactor ) and returns its physical size divided by this scale factor.

Unlike GetLogicalSize , this function returns the same value under all platforms and so its result should not be used as window or device context coordinates.

wx.Size

New in version 4.1/wxWidgets-3.1.6.

Gets the colour depth of the bitmap.

A value of 1 indicates a monochrome bitmap.

int

MSW-only method to fetch the windows handle for the bitmap.

long

Returns the height of the bitmap in physical pixels.

int

See also

GetWidth , GetSize , GetLogicalHeight

Returns the height of the bitmap in logical pixels.

See GetLogicalSizefor more information.

float

New in version 4.1/wxWidgets-3.1.6.

See also

GetLogicalWidth , GetWidth

Returns the size of the bitmap in logical pixels.

For the platforms using DPI-independent pixels, i.e. those where HAS_DPI_INDEPENDENT_PIXELSis defined, such as wxOSX or wxGTK 3, this function returns the physical size of the bitmap, as returned by GetSize , divided by its scale factor, as returned by GetScaleFactor , while for the other platforms, it simply returns the same thing as GetSize .

This ensures that the result of this function is always expressed in the pixel coordinates appropriate for the current platform, i.e. its return value is always in logical pixels, used for window andwx.DC coordinates, whether these pixels are the same as physical pixels, which are returned by GetSize , or not.

wx.Size

New in version 2.9.5.

See also

GetLogicalWidth , GetLogicalHeight , GetSize

Returns the width of the bitmap in logical pixels.

See GetLogicalSizefor more information.

float

New in version 4.1/wxWidgets-3.1.6.

See also

GetLogicalHeight , GetWidth

Gets the associated mask (if any) which may have been loaded from a file or set for the bitmap.

wx.Mask

See also

SetMask ,wx.Mask

Gets the associated palette (if any) which may have been loaded from a file or set for the bitmap.

wx.Palette

See also

wx.Palette

Returns the scale factor of this bitmap.

Scale factor is 1 by default, but can be greater to indicate that the size of bitmap in logical, DPI-independent pixels is smaller than its actual size in physical pixels. Bitmaps with scale factor greater than 1 must be used in high DPI to appear sharp on the screen.

Note that the scale factor is only used in the ports where logical pixels are not the same as physical ones, such as wxOSX or GTK3, and this function always returns 1 under the other platforms.

float

New in version 2.9.5.

See also

SetScaleFactor , GetLogicalWidth , GetLogicalHeight , GetLogicalSize

Returns the height of the bitmap in logical pixels.

This is an older synonym for GetLogicalHeight , use the new function in the new code.

float

New in version 2.9.5.

Returns the size of the bitmap in logical pixels.

This is an older synonym for GetLogicalSize , use the new function in the new code.

wx.Size

New in version 2.9.5.

Returns the width of the bitmap in logical pixels.

This is an older synonym for GetLogicalWidth , use the new function in the new code.

float

New in version 2.9.5.

Returns the size of the bitmap in physical pixels.

The return value of this function doesn’t depend on the scale factor, it is always the physical size of the bitmap, i.e. corresponding to the actual number of pixels in it.

wx.Size

New in version 2.9.0.

See also

GetHeight , GetWidth , GetLogicalSize

Returns a sub bitmap of the current one as long as the rect belongs entirely to the bitmap.

This function preserves bit depth and mask information.

rect (wx.Rect) –

wx.Bitmap

Returns the width of the bitmap in physical pixels.

int

See also

GetHeight , GetSize , GetLogicalWidth

Returns True if the bitmap has an alpha channel.

Note that the fact that a bitmap has an alpha channel doesn’t necessarily mean that it has any transparency, as all of its pixels could be using wx.ALPHA_OPAQUE value. To actually examine the alpha values, the bitmap can be converted towx.Image.

bool

Returns True if bitmap data is present.

bool

Loads a bitmap from a file or resource.

name (string) – Either a filename or a Windows resource name. The meaning of name is determined by the type parameter.

type (BitmapType) – One of thewx.BitmapType values; see the note in the class detailed description. Note that the BITMAP_DEFAULT_TYPE constant has different value under different wxWidgets ports. See the bitmap.h header for the value it takes for a specific port.

bool

True if the operation succeeded, False otherwise.

Note

A palette may be associated with the bitmap if one exists (especially for colour Windows bitmaps), and if the code supports it. You can check if one has been created by using the GetPalettemember.

See also

SaveFile

Loads a bitmap from the memory containing image data in PNG format.

This helper function provides the simplest way to create a wx.Bitmap fromin-memory PNG image data.

data –

size (int) –

wx.Bitmap

Rescale the given bitmap to the requested size.

This function is just a convenient wrapper for wx.Image.Rescaleused to resize the given bmp to the requested size. If you need more control over resizing, e.g. to specify the quality option different from IMAGE_QUALITY_NEAREST used by this function, please use thewx.Image function directly instead.

Both the bitmap itself and size must be valid.

bmp (wx.Bitmap) –

sizeNeeded (wx.Size) –

New in version 4.1/wxWidgets-3.1.6.

Remove alpha channel from the bitmap.

This is the same as calling UseAlphawith False argument.

Saves a bitmap in the named file.

name (string) – A filename. The meaning of name is determined by the type parameter.

type (BitmapType) – One of thewx.BitmapType values; see the note in the class detailed description.

palette (wx.Palette) – An optional palette used for saving the bitmap.

bool

True if the operation succeeded, False otherwise.

Note

Depending on how wxWidgets has been configured, not all formats may be available.

See also

LoadFile

Sets the depth member (does not affect the bitmap data).

depth (int) – Bitmap depth.

Deprecated

This function is deprecated since version 3.1.2, dimensions and depth can only be set at construction time.

MSW-only method to set the windows handle for the bitmap.

Sets the height member (does not affect the bitmap data).

height (int) – Bitmap height in pixels.

Deprecated

This function is deprecated since version 3.1.2, dimensions and depth can only be set at construction time.

Sets the mask for this bitmap.

mask (wx.Mask) –

Note

The bitmap object owns the mask once this has been called.

Note

A mask can be set also for bitmap with an alpha channel but doing so under wxMSW is not recommended because performance of drawing such bitmap is not very good.

See also

GetMask ,wx.Mask

Create a mask for this bitmap based on the pixels with the given colour.

Sets the associated palette.

(Not implemented under GTK+).

palette (wx.Palette) – The palette to set.

See also

wx.Palette

Sets the bitmap scale factor.

This doesn’t change the bitmap actual size or its contents, but changes its scale factor, so that it appears in a smaller size when it is drawn on screen: e.g. setting scale to 2 means that the bitmap will be twice smaller (in each direction) when drawn on screen in the ports in which logical and physical pixels differ (i.e. wxOSX and GTK3, but not wxMSW).

When creating a new bitmap, CreateWithDIPSizecan be used to specify the correct scale factor from the beginning.

scale (float) –

New in version 4.1/wxWidgets-3.1.6.

Set the bitmap size (does not alter the existing native bitmap data or image size).

Sets the width member (does not affect the bitmap data).

width (int) – Bitmap width in pixels.

Deprecated

This function is deprecated since version 3.1.2, dimensions and depth can only be set at construction time.

Enable or disable use of alpha channel in this bitmap.

This function is only useful for 32bpp bitmaps and changes their format to use, or not use, the fourth byte of the pixel data for the alpha channel.

It currently is only implemented in wxMSW and wxOSX and simply always returns False under the other platforms.

use (bool) –

True if the operation succeeded, False otherwise, e.g. when trying to enable alpha channel support for a non-32bpp bitmap or if this operation is simply not supported by the current platform.

See also

HasAlpha , ResetAlpha

int

int

See GetDIPSize

See GetDepth and SetDepth

See GetHandle and SetHandle

See GetHeight and SetHeight

See GetLogicalHeight

See GetLogicalSize

See GetLogicalWidth

See GetMask and SetMask

See GetPalette and SetPalette

See GetScaleFactor and SetScaleFactor

See GetScaledHeight

See GetScaledSize

See GetScaledWidth

See GetSize and SetSize

See GetWidth and SetWidth