X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/a86960861fb8824b4b39aa62c04c2689a6163f61..4ed51f4d1c02f01489df35b25a96a1d5b25c1478:/wxPython/src/_image.i diff --git a/wxPython/src/_image.i b/wxPython/src/_image.i index d87eae375b..6b315bc824 100644 --- a/wxPython/src/_image.i +++ b/wxPython/src/_image.i @@ -28,6 +28,13 @@ enum { }; +// Constants for wxImage::Scale() for determining the level of quality +enum +{ + wxIMAGE_QUALITY_NORMAL = 0, + wxIMAGE_QUALITY_HIGH = 1 +}; + //--------------------------------------------------------------------------- %newgroup @@ -54,6 +61,11 @@ public: void SetExtension(const wxString& extension); void SetType(long type); void SetMimeType(const wxString& mimetype); + + %property(Extension, GetExtension, SetExtension, doc="See `GetExtension` and `SetExtension`"); + %property(MimeType, GetMimeType, SetMimeType, doc="See `GetMimeType` and `SetMimeType`"); + %property(Name, GetName, SetName, doc="See `GetName` and `SetName`"); + %property(Type, GetType, SetType, doc="See `GetType` and `SetType`"); }; @@ -153,19 +165,6 @@ key value from a RGB tripple.", ""); //--------------------------------------------------------------------------- -%{ - typedef unsigned char* buffer; -%} - -%typemap(in) (buffer data, int DATASIZE) - { if (!PyArg_Parse($input, "t#", &$1, &$2)) SWIG_fail; } - -%typemap(in) (buffer alpha, int ALPHASIZE) - { if (!PyArg_Parse($input, "t#", &$1, &$2)) SWIG_fail; } - -//--------------------------------------------------------------------------- - - DocStr(wxImage, "A platform-independent image class. An image can be created from data, or using `wx.Bitmap.ConvertToImage`, or loaded from a file in a @@ -233,6 +232,7 @@ public: }; + class wxImage : public wxObject { public: %typemap(out) wxImage*; // turn off this typemap @@ -388,37 +388,6 @@ alpha data must be width*height bytes.", " return new wxImage(width, height, dcopy, acopy, false); } - - // NOTE: We need the junk parameter so the compiler will be able - // differentiate from the two functions above. It isn't used for - // anything else. - %RenameDocCtor( - _ImageFromBuffer, ":see: `wx.ImageFromBuffer`", "", - wxImage(int width, int height, buffer data, int DATASIZE, PyObject* junk)) - { - wxUnusedVar(junk); - if (DATASIZE != width*height*3) { - wxPyErr_SetString(PyExc_ValueError, "Invalid data buffer size."); - return NULL; - } - return new wxImage(width, height, data, true); - } - - %RenameDocCtor( - _ImageFromBufferWithAlpha, ":see: `wx.ImageFromBuffer`", "", - wxImage(int width, int height, buffer data, int DATASIZE, buffer alpha, int ALPHASIZE, PyObject* junk)) - { - wxUnusedVar(junk); - 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; - } - return new wxImage(width, height, data, alpha, true); - } } // TODO: wxImage( char** xpmData ); @@ -438,19 +407,60 @@ initialized to black. Otherwise, the image data will be uninitialized.", ""); DocDeclStr( - wxImage , Scale( int width, int height ), + wxImage , Scale( int width, int height, int quality = wxIMAGE_QUALITY_NORMAL ), "Returns a scaled version of the image. This is also useful for scaling bitmaps in general as the only other way to scale bitmaps is to blit a -`wx.MemoryDC` into another `wx.MemoryDC`.", " +`wx.MemoryDC` into another `wx.MemoryDC`. The ``quality`` parameter +specifies what method to use for resampling the image. It can be +either wx.IMAGE_QUALITY_NORMAL, which uses the normal default scaling +method of pixel replication, or wx.IMAGE_QUALITY_HIGH which uses +bicubic and box averaging resampling methods for upsampling and +downsampling respectively.", " + +It should be noted that although using wx.IMAGE_QUALITY_HIGH produces +much nicer looking results it is a slower method. Downsampling will +use the box averaging method which seems to operate very fast. If you +are upsampling larger images using this method you will most likely +notice that it is a bit slower and in extreme cases it will be quite +substantially slower as the bicubic algorithm has to process a lot of +data. + +It should also be noted that the high quality scaling may not work as +expected when using a single mask colour for transparency, as the +scaling will blur the image and will therefore remove the mask +partially. Using the alpha channel will work. :see: `Rescale`"); + + + wxImage ResampleBox(int width, int height) const; + wxImage ResampleBicubic(int width, int height) const; + + DocDeclStr( + wxImage , Blur(int radius), + "Blurs the image in both horizontal and vertical directions by the +specified pixel ``radius``. This should not be used when using a +single mask colour for transparency.", ""); + + DocDeclStr( + wxImage , BlurHorizontal(int radius), + "Blurs the image in the horizontal direction only. This should not be +used when using a single mask colour for transparency. +", ""); + + DocDeclStr( + wxImage , BlurVertical(int radius), + "Blurs the image in the vertical direction only. This should not be +used when using a single mask colour for transparency.", ""); + + DocDeclStr( wxImage , ShrinkBy( int xFactor , int yFactor ) const , "Return a version of the image scaled smaller by the given factors.", ""); DocDeclStr( - wxImage& , Rescale(int width, int height), + wxImage& , Rescale(int width, int height, int quality = wxIMAGE_QUALITY_NORMAL), "Changes the size of the image in-place by scaling it: after a call to this function, the image will have the given width and height. @@ -659,8 +669,9 @@ object, using a MIME type string to specify the image file format.", "", DocDeclStr( - bool , Ok(), + bool , IsOk(), "Returns true if image data is present.", ""); + %pythoncode { Ok = IsOk } DocDeclStr( int , GetWidth(), @@ -1026,35 +1037,75 @@ range -1.0..1.0 where -1.0 is -360 degrees and 1.0 is 360 degrees", ""); "Converts a color in HSV color space to RGB color space.", ""); - %pythoncode { def __nonzero__(self): return self.Ok() } + %pythoncode { def __nonzero__(self): return self.IsOk() } + + %property(AlphaBuffer, GetAlphaBuffer, SetAlphaBuffer, doc="See `GetAlphaBuffer` and `SetAlphaBuffer`"); + %property(AlphaData, GetAlphaData, SetAlphaData, doc="See `GetAlphaData` and `SetAlphaData`"); + %property(Data, GetData, SetData, doc="See `GetData` and `SetData`"); + %property(DataBuffer, GetDataBuffer, SetDataBuffer, doc="See `GetDataBuffer` and `SetDataBuffer`"); + %property(Height, GetHeight, doc="See `GetHeight`"); + %property(MaskBlue, GetMaskBlue, doc="See `GetMaskBlue`"); + %property(MaskGreen, GetMaskGreen, doc="See `GetMaskGreen`"); + %property(MaskRed, GetMaskRed, doc="See `GetMaskRed`"); + %property(Width, GetWidth, doc="See `GetWidth`"); + }; + +// Make an image from buffer objects. Not that this is here instead of in the +// wxImage class (as a constructor) because there is already another one with +// the exact same signature, so there woudl be ambiguities in the generated +// C++. Doing it as an independent factory function like this accomplishes +// the same thing however. +%newobject _ImageFromBuffer; +%inline %{ + wxImage* _ImageFromBuffer(int width, int height, + buffer data, int DATASIZE, + buffer alpha=NULL, int ALPHASIZE=0) + { + if (DATASIZE != width*height*3) { + wxPyErr_SetString(PyExc_ValueError, "Invalid data buffer size."); + return NULL; + } + if (alpha != NULL) { + if (ALPHASIZE != width*height) { + wxPyErr_SetString(PyExc_ValueError, "Invalid alpha buffer size."); + return NULL; + } + return new wxImage(width, height, data, alpha, true); + } + return new wxImage(width, height, data, true); + } +%} + %pythoncode { def ImageFromBuffer(width, height, dataBuffer, alphaBuffer=None): """ Creates a `wx.Image` 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. - - A reference to the data and alpha buffer objects are kept with the - wx.Image, so that they won't get deleted until after the wx.Image - is deleted. However please be aware that it is not guaranteed that - an object won't move its memory buffer to a new location when it - needs to resize its contents. If that happens then the wx.Image - will end up referring to an invalid memory location and could cause - the application to crash. Therefore care should be taken to not - manipulate the objects used for the data and alpha buffers in a - way that would cause them to change size. + 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. + + The wx.Image will be created with its data and alpha pointers initialized + to the memory address pointed to by the buffer objects, thus saving the + time needed to copy the image data from the buffer object to the wx.Image. + While this has advantages, it also has the shoot-yourself-in-the-foot + risks associated with sharing a C pointer between two objects. + + To help alleviate the risk a reference to the data and alpha buffer + objects are kept with the wx.Image, so that they won't get deleted until + after the wx.Image is deleted. However please be aware that it is not + guaranteed that an object won't move its memory buffer to a new location + when it needs to resize its contents. If that happens then the wx.Image + will end up referring to an invalid memory location and could cause the + application to crash. Therefore care should be taken to not manipulate + the objects used for the data and alpha buffers in a way that would cause + them to change size. """ - if alphaBuffer is not None: - image = _ImageFromBufferWithAlpha(width, height, dataBuffer, alphaBuffer, None) - else: - image = _ImageFromBuffer(width, height, dataBuffer, None) + image = _core_._ImageFromBuffer(width, height, dataBuffer, alphaBuffer) image._buffer = dataBuffer image._alpha = alphaBuffer return image @@ -1212,7 +1263,12 @@ public: }; -#if wxUSE_IFF + +#if 0 +%{ +#include +%} + DocStr(wxIFFHandler, "A `wx.ImageHandler` for IFF image files.", ""); class wxIFFHandler : public wxImageHandler { @@ -1221,6 +1277,19 @@ public: }; #endif + +%{ +#include +%} + +DocStr(wxTGAHandler, +"A `wx.ImageHandler` for TGA image files.", ""); +class wxTGAHandler : public wxImageHandler { +public: + wxTGAHandler(); +}; + + //--------------------------------------------------------------------------- %{