/usr/include/wx-3.0/wx/wxPython/i_files/_bitmap.i is in python-wxgtk3.0-dev 3.0.2.0+dfsg-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 | /////////////////////////////////////////////////////////////////////////////
// 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)
def __str__(self):
return str(self.Get())
def __repr__(self):
return 'pixel(%d,%d): %s' % (x,y,self.Get())
X = property(lambda self: x)
Y = property(lambda self: y)
pf = PixelFacade()
for y in xrange(height):
pixels.MoveTo(self, 0, y)
for x in xrange(width):
# We always generate the same pf instance, but it
# accesses the pixels object which we use to iterate
# over the pixel buffer.
yield pf
pixels.nextPixel()
}
%property(Pixels, GetPixels, doc="See `GetPixels`");
};
class PixelData##_Accessor
{
public:
%nokwargs PixelData##_Accessor;
PixelData##_Accessor(PixelData& data);
PixelData##_Accessor(wxBitmap& bmp, PixelData& data);
PixelData##_Accessor();
~PixelData##_Accessor();
void Reset(const PixelData& data);
bool IsOk() const;
%extend {
// PixelData##_Accessor& nextPixel() { return ++(*self); }
void nextPixel() { ++(*self); }
}
void Offset(const PixelData& data, int x, int y);
void OffsetX(const PixelData& data, int x);
void OffsetY(const PixelData& data, int y);
void MoveTo(const PixelData& data, int x, int y);
// NOTE: For now I'm not wrapping the Red, Green, Blue and Alpha
// functions because I can't hide the premultiplying needed on wxMSW
// if only the individual components are wrapped, plus it would mean 3
// or 4 trips per pixel from Python to C++ instead of just one.
// Instead I've added the Set and Get functions and put the
// premultiplying in there.
// %extend {
// byte _get_Red() { return self->Red(); }
// byte _get_Green() { return self->Green(); }
// byte _get_Blue() { return self->Blue(); }
// void _set_Red(byte val) { self->Red() = val; }
// void _set_Green(byte val) { self->Green() = val; }
// void _set_Blue(byte val) { self->Blue() = val; }
// }
// %pythoncode {
// Red = property(_get_Red, _set_Red)
// Green = property(_get_Green, _set_Green)
// Blue = property(_get_Blue, _set_Blue)
// }
};
%enddef
// Make the classes
PIXELDATA(wxNativePixelData)
PIXELDATA(wxAlphaPixelData)
// Add in a few things that are different between the wxNativePixelData and
// wxAlphaPixelData and the iterator classes and so are not included in our
// macro...
%extend wxNativePixelData_Accessor {
void Set(byte red, byte green, byte blue) {
self->Red() = red;
self->Green() = green;
self->Blue() = blue;
}
PyObject* Get() {
PyObject* rv = PyTuple_New(3);
PyTuple_SetItem(rv, 0, PyInt_FromLong(self->Red()));
PyTuple_SetItem(rv, 1, PyInt_FromLong(self->Green()));
PyTuple_SetItem(rv, 2, PyInt_FromLong(self->Blue()));
return rv;
}
}
%extend wxAlphaPixelData_Accessor {
// byte _get_Alpha() { return self->Alpha(); }
// void _set_Alpha(byte val) { self->Alpha() = val; }
// %pythoncode {
// Alpha = property(_get_Alpha, _set_Alpha)
// }
void Set(byte red, byte green, byte blue, byte alpha) {
self->Red() = wxPy_premultiply(red, alpha);
self->Green() = wxPy_premultiply(green, alpha);
self->Blue() = wxPy_premultiply(blue, alpha);
self->Alpha() = alpha;
}
PyObject* Get() {
PyObject* rv = PyTuple_New(4);
int red = self->Red();
int green = self->Green();
int blue = self->Blue();
int alpha = self->Alpha();
PyTuple_SetItem(rv, 0, PyInt_FromLong( wxPy_unpremultiply(red, alpha) ));
PyTuple_SetItem(rv, 1, PyInt_FromLong( wxPy_unpremultiply(green, alpha) ));
PyTuple_SetItem(rv, 2, PyInt_FromLong( wxPy_unpremultiply(blue, alpha) ));
PyTuple_SetItem(rv, 3, PyInt_FromLong( alpha ));
return rv;
}
}
//---------------------------------------------------------------------------
DocStr(wxMask,
"This class encapsulates a monochrome mask bitmap, where the masked
area is black and the unmasked area is white. When associated with a
bitmap and drawn in a device context, the unmasked area of the bitmap
will be drawn, and the masked area will not be drawn.
A mask may be associated with a `wx.Bitmap`. It is used in
`wx.DC.DrawBitmap` or `wx.DC.Blit` when the source device context is a
`wx.MemoryDC` with a `wx.Bitmap` selected into it that contains a
mask.", "");
MustHaveApp(wxMask);
class wxMask : public wxObject {
public:
DocStr(wxMask,
"Constructs a mask from a `wx.Bitmap` and a `wx.Colour` in that bitmap
that indicates the transparent portions of the mask. In other words,
the pixels in ``bitmap`` that match ``colour`` will be the transparent
portions of the mask. If no ``colour`` or an invalid ``colour`` is
passed then BLACK is used.
:see: `wx.Bitmap`, `wx.Colour`", "");
%extend {
wxMask(const wxBitmap& bitmap, const wxColour& colour = wxNullColour) {
if ( !colour.IsOk() )
return new wxMask(bitmap, *wxBLACK);
else
return new wxMask(bitmap, colour);
}
}
~wxMask();
};
%pythoncode { MaskColour = wx.deprecated(Mask, "wx.MaskColour is deprecated, use `wx.Mask` instead.") }
//---------------------------------------------------------------------------
//---------------------------------------------------------------------------
// Turn GIL acquisition back on.
%threadWrapperOn
|