/////////////////////////////////////////////////////////////////////////////

// Name: _bitmap.i

// Purpose: SWIG interface for wxBitmap and wxMask

//

// Author: Robin Dunn

//

// Created: 7-July-1997

// RCS-ID: $Id$

// Copyright: (c) 2003 by Total Control Software

// Licence: wxWindows license

/////////////////////////////////////////////////////////////////////////////

// Not a %module

%{

#include <wx/rawbmp.h>

%}

// Turn off the aquisition of the Global Interpreter Lock for the classes and

// functions in this file

%threadWrapperOff

//---------------------------------------------------------------------------

%{

// See http://tinyurl.com/e5adr for what premultiplying alpha means. wxMSW and

// wxMac want to have the values premultiplied by the alpha value, but the

// other platforms don't. These macros help keep the code clean.

#if defined(__WXMSW__) || defined(__WXMAC__)

#define wxPy_premultiply(p, a) ((p) * (a) / 0xff)

#define wxPy_unpremultiply(p, a) ((a) ? ((p) * 0xff / (a)) : (p))

#else

#define wxPy_premultiply(p, a) (p)

#define wxPy_unpremultiply(p, a) (p)

#endif

%}

//---------------------------------------------------------------------------

%{

#include <wx/image.h>

static char** ConvertListOfStrings(PyObject* listOfStrings) {

wxPyThreadBlocker blocker;

char** cArray = NULL;

int count;

if (!PyList_Check(listOfStrings)) {

wxPyErr_SetString(PyExc_TypeError, "Expected a list of strings.");

return NULL;

}

count = PyList_Size(listOfStrings);

cArray = new char*[count];

for(int x=0; x<count; x++) {

PyObject* item = PyList_GET_ITEM(listOfStrings, x);

if (!PyString_Check(item)) {

wxPyErr_SetString(PyExc_TypeError, "Expected a list of strings.");

delete [] cArray;

return NULL;

}

cArray[x] = PyString_AsString(item);

}

return cArray;

}

%}

//---------------------------------------------------------------------------

// Helper functions for copying bitmap data to/from buffers

enum wxBitmapBufferFormat {

wxBitmapBufferFormat_RGB,

wxBitmapBufferFormat_RGBA,

wxBitmapBufferFormat_RGB32,

wxBitmapBufferFormat_ARGB32

};

%{

enum wxBitmapBufferFormat {

wxBitmapBufferFormat_RGB,

wxBitmapBufferFormat_RGBA,

wxBitmapBufferFormat_RGB32,

wxBitmapBufferFormat_ARGB32,

};

void wxPyCopyBitmapFromBuffer(wxBitmap* bmp,

buffer data, int DATASIZE,

wxBitmapBufferFormat format, int stride=-1)

{

int height = bmp->GetHeight();

int width = bmp->GetWidth();

switch (format) {

// A simple sequence of RGB bytes

case wxBitmapBufferFormat_RGB:

{

if (DATASIZE < width * height * 3) {

wxPyErr_SetString(PyExc_ValueError, "Invalid data buffer size.");

return;

}

wxNativePixelData pixData(*bmp, wxPoint(0,0), wxSize(width, height));

if (! pixData) {

// raise an exception...

wxPyErr_SetString(PyExc_RuntimeError,

"Failed to gain raw access to bitmap data.");

return;

}

wxNativePixelData::Iterator p(pixData);

for (int y=0; y<height; y++) {

wxNativePixelData::Iterator rowStart = p;

for (int x=0; x<width; x++) {

p.Red() = *(data++);

p.Green() = *(data++);

p.Blue() = *(data++);

++p;

}

p = rowStart;

p.OffsetY(pixData, 1);

}

break;

}

// A simple sequence of RGBA bytes

case wxBitmapBufferFormat_RGBA:

{

if (DATASIZE < width * height * 4) {

wxPyErr_SetString(PyExc_ValueError, "Invalid data buffer size.");

return;

}

wxAlphaPixelData pixData(*bmp, wxPoint(0,0), wxSize(width, height));

if (! pixData) {

// raise an exception...

wxPyErr_SetString(PyExc_RuntimeError,

"Failed to gain raw access to bitmap data.");

return;

}

wxAlphaPixelData::Iterator p(pixData);

for (int y=0; y<height; y++) {

wxAlphaPixelData::Iterator rowStart = p;

for (int x=0; x<width; x++) {

byte a = data[3];

p.Red() = wxPy_premultiply(*(data++), a);

p.Green() = wxPy_premultiply(*(data++), a);

p.Blue() = wxPy_premultiply(*(data++), a);

p.Alpha() = a; data++;

++p;

}

p = rowStart;

p.OffsetY(pixData, 1);

}

break;

}

// A sequence of 32-bit values in native endian order,

// where the alpha is in the upper 8 bits, then red, then

// green, then blue. The stride is the distance in bytes

// from the beginning of one row of the image data to the

// beginning of the next row. This may not be the same as

// width*4 if alignment or platform specific optimizations

// have been utilized.

// NOTE: This is normally used with Cairo, which seems to

// already have the values premultiplied. Should we have

// a way to optionally do it anyway?

case wxBitmapBufferFormat_RGB32:

case wxBitmapBufferFormat_ARGB32:

{

bool useAlpha = (format == wxBitmapBufferFormat_ARGB32);

byte* rowStart = data;

wxUint32* bufptr;

wxUint32 value;

if (stride == -1)

stride = width * 4;

if (DATASIZE < stride * height) {

wxPyErr_SetString(PyExc_ValueError, "Invalid data buffer size.");

return;

}

wxAlphaPixelData pixData(*bmp, wxPoint(0,0), wxSize(width,height));

if (! pixData) {

// raise an exception...

wxPyErr_SetString(PyExc_RuntimeError,

"Failed to gain raw access to bitmap data.");

return;

}

wxAlphaPixelData::Iterator pix(pixData);

for (int y=0; y<height; y++) {

pix.MoveTo(pixData, 0, y);

bufptr = (wxUint32*)rowStart;

for (int x=0; x<width; x++) {

value = *bufptr;

pix.Alpha() = useAlpha ? (value >> 24) & 0xFF : 255;

pix.Red() = (value >> 16) & 0xFF;

pix.Green() = (value >> 8) & 0xFF;

pix.Blue() = (value >> 0) & 0xFF;

++pix;

++bufptr;

}

rowStart += stride;

}

break;

}

}

}

void wxPyCopyBitmapToBuffer(wxBitmap* bmp,

buffer data, int DATASIZE,

wxBitmapBufferFormat format, int stride=-1)

{

// Some helper macros used below to help declutter the code

#define MAKE_PIXDATA(type) \

type pixData(*bmp, wxPoint(0,0), wxSize(width, height)); \

if (! pixData) { \

wxPyErr_SetString(PyExc_RuntimeError, "Failed to gain raw access to bitmap data."); \

return; \

} \

type::Iterator p(pixData); \

type::Iterator rowStart

#define CHECK_BUFFERSIZE(size_needed) \

if (DATASIZE < size_needed) { \

wxPyErr_SetString(PyExc_ValueError, "Invalid data buffer size."); \

return; \

}

int height = bmp->GetHeight();

int width = bmp->GetWidth();

int depth = bmp->GetDepth();

// images loaded from a file may not have set the depth, at least on Mac...

if (depth == -1) {

if (bmp->HasAlpha())

depth = 32;

else

depth = 24;

}

switch (format) {

// A simple sequence of RGB bytes

case wxBitmapBufferFormat_RGB:

{

CHECK_BUFFERSIZE(width * height * 3);

if (depth == 24) {

MAKE_PIXDATA(wxNativePixelData);

for (int y=0; y<height; y++) {

rowStart = p;

for (int x=0; x<width; x++) {

*(data++) = p.Red();

*(data++) = p.Green();

*(data++) = p.Blue();

++p;

}

p = rowStart;

p.OffsetY(pixData, 1);

}

}

if (depth == 32) {

// Source has alpha, but we won't be using it because the

// destination buffer doesn't

MAKE_PIXDATA(wxAlphaPixelData);

for (int y=0; y<height; y++) {

rowStart = p;

for (int x=0; x<width; x++) {

*(data++) = p.Red();

*(data++) = p.Green();

*(data++) = p.Blue();

++p;

}

p = rowStart;

p.OffsetY(pixData, 1);

}

}

break;

}

// A simple sequence of RGBA bytes

case wxBitmapBufferFormat_RGBA:

{

CHECK_BUFFERSIZE(width * height * 4);

if (depth == 24) {

MAKE_PIXDATA(wxNativePixelData);

for (int y=0; y<height; y++) {

rowStart = p;

for (int x=0; x<width; x++) {

byte a = wxALPHA_OPAQUE;

*(data++) = wxPy_unpremultiply(p.Red(), a);

*(data++) = wxPy_unpremultiply(p.Green(), a);

*(data++) = wxPy_unpremultiply(p.Blue(), a);

*(data++) = a;

++p;

}

p = rowStart;

p.OffsetY(pixData, 1);

}

}

if (depth == 32) {

MAKE_PIXDATA(wxAlphaPixelData);

for (int y=0; y<height; y++) {

rowStart = p;

for (int x=0; x<width; x++) {

byte a = p.Alpha();

*(data++) = wxPy_unpremultiply(p.Red(), a);

*(data++) = wxPy_unpremultiply(p.Green(), a);

*(data++) = wxPy_unpremultiply(p.Blue(), a);

*(data++) = a;

++p;

}

p = rowStart;

p.OffsetY(pixData, 1);

}

}

break;

}

// A sequence of 32-bit values in native endian order,

// where the alpha is in the upper 8 bits, then red, then

// green, then blue. The stride is the distance in bytes

// from the beginning of one row of the image data to the

// beginning of the next row. This may not be the same as

// width*4 if alignment or platform specific optimizations

// have been utilized.

// NOTE: This is normally used with Cairo, which seems to

// already have the values premultiplied. Should we have

// a way to optionally do it anyway?

case wxBitmapBufferFormat_RGB32:

case wxBitmapBufferFormat_ARGB32:

{

bool useAlpha = (format == wxBitmapBufferFormat_ARGB32);

byte* dataRow = data;

wxUint32* bufptr;

wxUint32 value;

if (stride == -1)

stride = width * 4;

CHECK_BUFFERSIZE(stride * height);

if (useAlpha && depth == 32) {

MAKE_PIXDATA(wxAlphaPixelData);

for (int y=0; y<height; y++) {

p.MoveTo(pixData, 0, y);

bufptr = (wxUint32*)dataRow;

for (int x=0; x<width; x++) {

value =

(p.Alpha() << 24) |

(p.Red() << 16) |

(p.Green() << 8) |

(p.Blue());

*bufptr = value;

++p;

++bufptr;

}

dataRow += stride;

}

}

else // if (!useAlpha /*depth == 24*/)

{

MAKE_PIXDATA(wxNativePixelData);

for (int y=0; y<height; y++) {

p.MoveTo(pixData, 0, y);

bufptr = (wxUint32*)dataRow;

for (int x=0; x<width; x++) {

value =

(wxALPHA_OPAQUE << 24) |

(p.Red() << 16) |

(p.Green() << 8) |

(p.Blue());

*bufptr = value;

++p;

++bufptr;

}

dataRow += stride;

}

}

break;

}

}

}

%}

//---------------------------------------------------------------------------

enum {

wxBITMAP_SCREEN_DEPTH

};

DocStr(wxBitmap,

"The wx.Bitmap class encapsulates the concept of a platform-dependent

bitmap. It can be either monochrome or colour, and either loaded from

a file or created dynamically. A bitmap can be selected into a memory

device context (instance of `wx.MemoryDC`). This enables the bitmap to

be copied to a window or memory device context using `wx.DC.Blit`, or

to be used as a drawing surface.", "

The BMP and XMP image file formats are supported on all platforms by

wx.Bitmap. Other formats are automatically loaded by `wx.Image` and

converted to a wx.Bitmap, so any image file format supported by

`wx.Image` can be used.

:todo: Find a way to do very efficient PIL Image <--> wx.Bitmap

converstions.

:see: `wx.EmptyBitmap`, `wx.BitmapFromIcon`, `wx.BitmapFromImage`,

`wx.BitmapFromXPMData`, `wx.BitmapFromBits`, `wx.BitmapFromBuffer`,

`wx.BitmapFromBufferRGBA`, `wx.Image`

");

MustHaveApp(wxBitmap);

class wxBitmap : public wxGDIObject

{

public:

DocCtorStr(

wxBitmap(const wxString& name, wxBitmapType type=wxBITMAP_TYPE_ANY),

"Loads a bitmap from a file.",

"

:param name: Name of the file to load the bitmap from.

:param type: The type of image to expect. Can be one of the following

constants (assuming that the neccessary `wx.Image` handlers are

loaded):

* wx.BITMAP_TYPE_ANY

* wx.BITMAP_TYPE_BMP

* wx.BITMAP_TYPE_ICO

* wx.BITMAP_TYPE_CUR

* wx.BITMAP_TYPE_XBM

* wx.BITMAP_TYPE_XPM

* wx.BITMAP_TYPE_TIF

* wx.BITMAP_TYPE_GIF

* wx.BITMAP_TYPE_PNG

* wx.BITMAP_TYPE_JPEG

* wx.BITMAP_TYPE_PNM

* wx.BITMAP_TYPE_PCX

* wx.BITMAP_TYPE_PICT

* wx.BITMAP_TYPE_ICON

* wx.BITMAP_TYPE_ANI

* wx.BITMAP_TYPE_IFF

:see: Alternate constructors `wx.EmptyBitmap`, `wx.BitmapFromIcon`,

`wx.BitmapFromImage`, `wx.BitmapFromXPMData`, `wx.BitmapFromBits`,

`wx.BitmapFromBuffer`, `wx.BitmapFromBufferRGBA`,

");

~wxBitmap();

DocCtorStrName(

wxBitmap(int width, int height, int depth=wxBITMAP_SCREEN_DEPTH),

"Creates a new bitmap of the given size. A depth of -1 indicates the

depth of the current screen or visual. Some platforms only support 1

for monochrome and -1 for the current display depth.", "",

EmptyBitmap);

DocCtorStrName(

wxBitmap(const wxIcon& icon),

"Create a new bitmap from a `wx.Icon` object.", "",

BitmapFromIcon);

DocCtorStrName(

wxBitmap(const wxImage& image, int depth=wxBITMAP_SCREEN_DEPTH),

"Creates bitmap object from a `wx.Image`. This has to be done to

actually display a `wx.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 screen colour depth if depth is -1) which entails

that a colour reduction may have to take place.", "",

BitmapFromImage);

%extend {

%RenameDocCtor(

BitmapFromXPMData,

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

wxBitmap(PyObject* listOfStrings))

{

char** cArray = NULL;

wxBitmap* bmp;

cArray = ConvertListOfStrings(listOfStrings);

if (! cArray)

return NULL;

bmp = new wxBitmap(cArray);

delete [] cArray;

return bmp;

}

%RenameDocCtor(

BitmapFromBits,

"Creates a bitmap from an array of 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 as a data

string. For other bit depths, the behaviour is platform dependent.", "",

wxBitmap(PyObject* bits, int width, int height, int depth=1 ))

{

char* buf = 0;

{

wxPyThreadBlocker blocker;

Py_ssize_t length;

if (! PyString_Check(bits)) {

wxPyErr_SetString(PyExc_TypeError, "String required for bits data");

return NULL;

}

PyString_AsStringAndSize(bits, &buf, &length);

}

return new wxBitmap(buf, width, height, depth);

}

}

// wxGDIImage methods

#ifdef __WXMSW__

long GetHandle();

%extend {

void SetHandle(long handle) { self->SetHandle((WXHANDLE)handle); }

}

#endif

bool IsOk();

%pythoncode { Ok = IsOk }

DocDeclStr(

int , GetWidth(),

"Gets the width of the bitmap in pixels.", "");

DocDeclStr(

int , GetHeight(),

"Gets the height of the bitmap in pixels.", "");

DocDeclStr(

int , GetDepth(),

"Gets the colour depth of the bitmap. A value of 1 indicates a

monochrome bitmap.", "");

DocDeclStr(

wxSize , GetSize() const,

"Get the size of the bitmap.", "");

DocDeclStr(

virtual wxImage , ConvertToImage() const,

"Creates a platform-independent 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.", "");

DocDeclStr(

virtual wxMask* , GetMask() const,

"Gets the associated mask (if any) which may have been loaded from a

file or explpicitly set for the bitmap.

:see: `SetMask`, `wx.Mask`

", "");

// MSW only? wxBitmap GetMaskBitmap() const;

%disownarg(wxMask*);

DocDeclStr(

virtual void , SetMask(wxMask* mask),

"Sets the mask for this bitmap.

:see: `GetMask`, `wx.Mask`

", "");

%cleardisown(wxMask*);

%extend {

DocStr(SetMaskColour,

"Create a Mask based on a specified colour in the Bitmap.", "");

void SetMaskColour(const wxColour& colour) {

wxMask *mask = new wxMask(*self, colour);

self->SetMask(mask);

}

}

DocDeclStr(

virtual wxBitmap , GetSubBitmap(const wxRect& rect) const,

"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.", "");

// Convert to disabled (dimmed) bitmap.

#ifdef __WXMSW__

%extend {

wxBitmap ConvertToDisabled(byte brightness = 255) const {

wxImage image = self->ConvertToImage();

wxBitmap bmp = wxBitmap(image.ConvertToDisabled(brightness));

return bmp;

}

}

#else

wxBitmap ConvertToDisabled(byte brightness = 255) const;

#endif

DocDeclStr(

virtual bool , SaveFile(const wxString &name, wxBitmapType type,

wxPalette *palette = NULL),

"Saves a bitmap in the named file. See `__init__` for a description of

the ``type`` parameter.", "");

DocDeclStr(

virtual bool , LoadFile(const wxString &name, wxBitmapType type),

"Loads a bitmap from a file. See `__init__` for a description of the

``type`` parameter.", "");

virtual wxPalette *GetPalette() const;

#ifdef __WXMSW__

virtual void SetPalette(const wxPalette& palette);

#endif

virtual bool CopyFromIcon(const wxIcon& icon);

DocDeclStr(

virtual void , SetHeight(int height),

"Set the height property (does not affect the existing bitmap data).", "");

DocDeclStr(

virtual void , SetWidth(int width),

"Set the width property (does not affect the existing bitmap data).", "");

DocDeclStr(

virtual void , SetDepth(int depth),

"Set the depth property (does not affect the existing bitmap data).", "");

%extend {

DocStr(SetSize, "Set the bitmap size (does not affect the existing bitmap data).", "");

void SetSize(const wxSize& size) {

self->SetWidth(size.x);

self->SetHeight(size.y);

}

}

#ifdef __WXMSW__

bool CopyFromCursor(const wxCursor& cursor);

#endif

%extend {

DocStr(CopyFromBuffer,

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

Default format is plain RGB, but other formats are now supported as

well. The following symbols are used to specify the format of the

bytes 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.

============================= ================================

", "");

void CopyFromBuffer(buffer data, int DATASIZE,

wxBitmapBufferFormat format=wxBitmapBufferFormat_RGB,

int stride=-1)

{

wxPyCopyBitmapFromBuffer(self, data, DATASIZE, format, stride);

}

}

%pythoncode {

def CopyFromBufferRGBA(self, buffer):

"""

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

data. This method is now just a compatibility wrapper around

CopyFromBuffer.

"""

self.CopyFromBuffer(buffer, wx.BitmapBufferFormat_RGBA)

}

%extend {

DocStr(CopyToBuffer,

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

format details.", "");

void CopyToBuffer(buffer data, int DATASIZE,

wxBitmapBufferFormat format=wxBitmapBufferFormat_RGB,

int stride=-1)

{

wxPyCopyBitmapToBuffer(self, data, DATASIZE, format, stride);

}

}

// (these functions are internal and shouldn't be used, they risk to

// disappear in the future)

bool HasAlpha() const;

%pythoncode { def __nonzero__(self): return self.IsOk() }

// TODO: Should these just be removed since the C++ operators are

// gone? Or is using IsSameAs for wxPython ok?

%extend {

bool __eq__(const wxBitmap* other) { return other ? self->IsSameAs(*other) : false; }

bool __ne__(const wxBitmap* other) { return other ? !self->IsSameAs(*other) : true; }

}

%property(Depth, GetDepth, SetDepth, doc="See `GetDepth` and `SetDepth`");

%property(Height, GetHeight, SetHeight, doc="See `GetHeight` and `SetHeight`");

%property(Mask, GetMask, SetMask, doc="See `GetMask` and `SetMask`");

%property(Palette, GetPalette, doc="See `GetPalette`");

%property(Size, GetSize, SetSize, doc="See `GetSize` and `SetSize`");

%property(Width, GetWidth, SetWidth, doc="See `GetWidth` and `SetWidth`");

};

//---------------------------------------------------------------------------

// Factory functions for creating wxBitmaps from Python buffer objects. They

// use the Abstract Pixel API to be able to set RGB and A bytes directly into

// the wxBitmap's pixel buffer.

%newobject _BitmapFromBufferAlpha;

%newobject _BitmapFromBuffer;

%inline %{

wxBitmap* _BitmapFromBufferAlpha(int width, int height,

buffer data, int DATASIZE,

buffer alpha, int ALPHASIZE)

{

if (DATASIZE < width*height*3) {

wxPyErr_SetString(PyExc_ValueError, "Invalid data buffer size.");

return NULL;

}

if (ALPHASIZE < width*height) {

wxPyErr_SetString(PyExc_ValueError, "Invalid alpha buffer size.");

return NULL;

}

wxBitmap* bmp = new wxBitmap(width, height, 32);

wxAlphaPixelData pixData(*bmp, wxPoint(0,0), wxSize(width,height));

if (! pixData) {

// raise an exception...

wxPyErr_SetString(PyExc_RuntimeError,

"Failed to gain raw access to bitmap data.");

return NULL;

}

wxAlphaPixelData::Iterator p(pixData);

for (int y=0; y<height; y++) {

wxAlphaPixelData::Iterator rowStart = p;

for (int x=0; x<width; x++) {

byte a = *(alpha++);

p.Red() = wxPy_premultiply(*(data++), a);

p.Green() = wxPy_premultiply(*(data++), a);

p.Blue() = wxPy_premultiply(*(data++), a);

p.Alpha() = a;

++p;

}

p = rowStart;

p.OffsetY(pixData, 1);

}

return bmp;

}

wxBitmap* _BitmapFromBuffer(int width, int height, buffer data, int DATASIZE)

{

wxBitmap* bmp = new wxBitmap(width, height, 24);

wxPyCopyBitmapFromBuffer(bmp, data, DATASIZE, wxBitmapBufferFormat_RGB);

if (PyErr_Occurred()) {

delete bmp;

bmp = NULL;

}

return bmp;

}

%}

%pythoncode {

def BitmapFromBuffer(width, height, dataBuffer, alphaBuffer=None):

"""

Creates a `wx.Bitmap` from the data in dataBuffer. The dataBuffer

parameter must be a Python object that implements the buffer

interface, such as a string, array, etc. The dataBuffer object is

expected to contain a series of RGB bytes and be width*height*3

bytes long. A buffer object can optionally be supplied for the

image's alpha channel data, and it is expected to be width*height

bytes long. On Windows and Mac the RGB values are 'premultiplied'

by the alpha values. (The other platforms do the multiplication

themselves.)

Unlike `wx.ImageFromBuffer` the bitmap created with this function

does not share the memory buffer with the buffer object. This is

because the native pixel buffer format varies on different

platforms, and so instead an efficient as possible copy of the

data is made from the buffer objects to the bitmap's native pixel

buffer. For direct access to a bitmap's pixel buffer see

`wx.NativePixelData` and `wx.AlphaPixelData`.

:see: `wx.Bitmap`, `wx.BitmapFromBufferRGBA`, `wx.NativePixelData`,

`wx.AlphaPixelData`, `wx.ImageFromBuffer`

"""

if alphaBuffer is not None:

return _gdi_._BitmapFromBufferAlpha(width, height, dataBuffer, alphaBuffer)

else:

return _gdi_._BitmapFromBuffer(width, height, dataBuffer)

}

%newobject _BitmapFromBufferRGBA;

%inline %{

wxBitmap* _BitmapFromBufferRGBA(int width, int height, buffer data, int DATASIZE)

{

wxBitmap* bmp = new wxBitmap(width, height, 32);

wxPyCopyBitmapFromBuffer(bmp, data, DATASIZE, wxBitmapBufferFormat_RGBA);

if (PyErr_Occurred()) {

delete bmp;

bmp = NULL;

}

return bmp;

}

%}

%pythoncode {

def BitmapFromBufferRGBA(width, height, dataBuffer):

"""

Creates a `wx.Bitmap` from the data in dataBuffer. The dataBuffer

parameter must be a Python object that implements the buffer

interface, such as a string, array, etc. The dataBuffer object is

expected to contain a series of RGBA bytes (red, green, blue and

alpha) and be width*height*4 bytes long. On Windows and Mac the

RGB values are 'premultiplied' by the alpha values. (The other

platforms do the multiplication themselves.)

Unlike `wx.ImageFromBuffer` the bitmap created with this function

does not share the memory buffer with the buffer object. This is

because the native pixel buffer format varies on different

platforms, and so instead an efficient as possible copy of the

data is made from the buffer object to the bitmap's native pixel

buffer. For direct access to a bitmap's pixel buffer see

`wx.NativePixelData` and `wx.AlphaPixelData`.

:see: `wx.Bitmap`, `wx.BitmapFromBuffer`, `wx.NativePixelData`,

`wx.AlphaPixelData`, `wx.ImageFromBuffer`

"""

return _gdi_._BitmapFromBufferRGBA(width, height, dataBuffer)

}

%newobject _EmptyBitmapRGBA;

%inline %{

wxBitmap* _EmptyBitmapRGBA(int width, int height,

byte red, byte green, byte blue, byte alpha)

{

if ( !(width > 0 && height > 0) ) {

wxPyErr_SetString(PyExc_ValueError, "Width and height must be greater than zero");

return NULL;

}

wxBitmap* bmp = new wxBitmap(width, height, 32);

wxAlphaPixelData pixData(*bmp, wxPoint(0,0), wxSize(width,height));

if (! pixData) {

// raise an exception...

wxPyErr_SetString(PyExc_RuntimeError,

"Failed to gain raw access to bitmap data.");

return NULL;

}

wxAlphaPixelData::Iterator p(pixData);

for (int y=0; y<height; y++) {

wxAlphaPixelData::Iterator rowStart = p;

for (int x=0; x<width; x++) {

p.Red() = wxPy_premultiply(red, alpha);

p.Green() = wxPy_premultiply(green, alpha);

p.Blue() = wxPy_premultiply(blue, alpha);

p.Alpha() = alpha;

++p;

}

p = rowStart;

p.OffsetY(pixData, 1);

}

return bmp;

}

%}

%pythoncode {

def EmptyBitmapRGBA(width, height, red=0, green=0, blue=0, alpha=0):

"""

Returns a new empty 32-bit bitmap where every pixel has been

initialized with the given RGBA values.

"""

return _gdi_._EmptyBitmapRGBA(width, height, red, green, blue, alpha)

}

//---------------------------------------------------------------------------

class wxPixelDataBase

{

public:

// origin of the rectangular region we represent

wxPoint GetOrigin() const { return m_ptOrigin; }

// width and height of the region we represent

int GetWidth() const { return m_width; }

int GetHeight() const { return m_height; }

wxSize GetSize() const { return wxSize(m_width, m_height); }

// the distance between two rows

int GetRowStride() const { return m_stride; }

%property(Height, GetHeight, doc="See `GetHeight`");

%property(Origin, GetOrigin, doc="See `GetOrigin`");

%property(RowStride, GetRowStride, doc="See `GetRowStride`");

%property(Size, GetSize, doc="See `GetSize`");

%property(Width, GetWidth, doc="See `GetWidth`");

};

// Both wxNativePixelData and wxAlphaPixelData have the same interface, so

// make a macro to declare them both.

%define PIXELDATA(PixelData)

%{

typedef PixelData##::Iterator PixelData##_Accessor;

%}

class PixelData##_Accessor;

class PixelData : public wxPixelDataBase

{

public:

%nokwargs PixelData;

PixelData(wxBitmap& bmp);

PixelData(wxBitmap& bmp, const wxRect& rect);

PixelData(wxBitmap& bmp, const wxPoint& pt, const wxSize& sz);

~PixelData();

PixelData##_Accessor GetPixels() const;

%pythoncode {

def UseAlpha(self): pass

UseAlpha = wx.deprecated(UseAlpha)

}

%extend {

bool __nonzero__() { return self->operator bool(); }

}

%pythoncode {

def __iter__(self):

"""

Create and return an iterator object for this pixel data

object. (It's really a generator but I won't tell if you

don't tell.)

"""

width = self.GetWidth()

height = self.GetHeight()

pixels = self.GetPixels()

# This class is a facade over the pixels object (using the one

# in the enclosing scope) that only allows Get() and Set() to

# be called.

class PixelFacade(object):

def Get(self):

return pixels.Get()

def Set(self, *args, **kw):

return pixels.Set(*args, **kw)