X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/6408deedee874b3fb873e2fc7f1a148e973bd23d..32485259c1342115488d219776dfebeb3d4d81b1:/include/wx/image.h diff --git a/include/wx/image.h b/include/wx/image.h index 845de80b5b..38f2809d98 100644 --- a/include/wx/image.h +++ b/include/wx/image.h @@ -14,7 +14,7 @@ #pragma interface "image.h" #endif -#include "wx/setup.h" +#include "wx/defs.h" #include "wx/object.h" #include "wx/string.h" #include "wx/gdicmn.h" @@ -30,8 +30,29 @@ // which breaks the compilation below #undef index +#define wxIMAGE_OPTION_QUALITY wxString(_T("quality")) #define wxIMAGE_OPTION_FILENAME wxString(_T("FileName")) +#define wxIMAGE_OPTION_RESOLUTION wxString(_T("Resolution")) +#define wxIMAGE_OPTION_RESOLUTIONX wxString(_T("ResolutionX")) +#define wxIMAGE_OPTION_RESOLUTIONY wxString(_T("ResolutionY")) + +#define wxIMAGE_OPTION_RESOLUTIONUNIT wxString(_T("ResolutionUnit")) + +// constants used with wxIMAGE_OPTION_RESOLUTIONUNIT +enum +{ + wxIMAGE_RESOLUTION_INCHES = 1, + wxIMAGE_RESOLUTION_CM = 2 +}; + +// alpha channel values: fully transparent, default threshold separating +// transparent pixels from opaque for a few functions dealing with alpha and +// fully opaque +const unsigned char wxIMAGE_ALPHA_TRANSPARENT = 0; +const unsigned char wxIMAGE_ALPHA_THRESHOLD = 0x80; +const unsigned char wxIMAGE_ALPHA_OPAQUE = 0xff; + //----------------------------------------------------------------------------- // classes //----------------------------------------------------------------------------- @@ -136,11 +157,39 @@ public: class WXDLLEXPORT wxImage: public wxObject { public: +#if wxABI_VERSION >= 20602 + // red, green and blue are 8 bit unsigned integers in the range of 0..255 + // We use the identifier RGBValue instead of RGB, since RGB is #defined + class RGBValue + { + public: + RGBValue(unsigned char r=0, unsigned char g=0, unsigned char b=0) + : red(r), green(g), blue(b) {} + unsigned char red; + unsigned char green; + unsigned char blue; + }; + + // hue, saturation and value are doubles in the range 0.0..1.0 + class HSVValue + { + public: + HSVValue(double h=0.0, double s=0.0, double v=0.0) + : hue(h), saturation(s), value(v) {} + double hue; + double saturation; + double value; + }; +#endif // wxABI_VERSION >= 2.6.2 + wxImage(){} wxImage( int width, int height, bool clear = true ); wxImage( int width, int height, unsigned char* data, bool static_data = false ); + wxImage( int width, int height, unsigned char* data, unsigned char* alpha, bool static_data = false ); wxImage( const wxString& name, long type = wxBITMAP_TYPE_ANY, int index = -1 ); wxImage( const wxString& name, const wxString& mimetype, int index = -1 ); + wxImage( const char** xpmData ); + wxImage( char** xpmData ); #if wxUSE_STREAMS wxImage( wxInputStream& stream, long type = wxBITMAP_TYPE_ANY, int index = -1 ); @@ -152,6 +201,8 @@ public: bool Create( int width, int height, bool clear = true ); bool Create( int width, int height, unsigned char* data, bool static_data = false ); + bool Create( int width, int height, unsigned char* data, unsigned char* alpha, bool static_data = false ); + bool Create( const char** xpmData ); void Destroy(); // creates an identical copy of the image (the = operator @@ -159,7 +210,14 @@ public: wxImage Copy() const; // return the new image with size width*height - wxImage GetSubImage( const wxRect& ) const; + wxImage GetSubImage( const wxRect& rect) const; + + // Paste the image or part of this image into an image of the given size at the pos + // any newly exposed areas will be filled with the rgb colour + // by default if r = g = b = -1 then fill with this image's mask colour or find and + // set a suitable mask colour + wxImage Size( const wxSize& size, const wxPoint& pos, + int r = -1, int g = -1, int b = -1 ) const; // pastes image into this instance and takes care of // the mask colour and out of bounds problems @@ -173,6 +231,10 @@ public: // rescales the image in place wxImage& Rescale( int width, int height ) { return *this = Scale(width, height); } + // resizes the image in place + wxImage& Resize( const wxSize& size, const wxPoint& pos, + int r = -1, int g = -1, int b = -1 ) { return *this = Size(size, pos, r, g, b); } + // Rotates the image about the given point, 'angle' radians. // Returns the rotated image, leaving this image intact. wxImage Rotate(double angle, const wxPoint & centre_of_rotation, @@ -191,6 +253,7 @@ public: // these routines are slow but safe void SetRGB( int x, int y, unsigned char r, unsigned char g, unsigned char b ); + void SetRGB( const wxRect& rect, unsigned char r, unsigned char g, unsigned char b ); unsigned char GetRed( int x, int y ) const; unsigned char GetGreen( int x, int y ) const; unsigned char GetBlue( int x, int y ) const; @@ -209,7 +272,7 @@ public: // converts image's alpha channel to mask, if it has any, does nothing // otherwise: - bool ConvertAlphaToMask(unsigned char threshold = 128); + bool ConvertAlphaToMask(unsigned char threshold = wxIMAGE_ALPHA_THRESHOLD); // This method converts an image where the original alpha // information is only available as a shades of a colour @@ -218,10 +281,10 @@ public: // draw grey values on the black background although they // actually mean to draw white with differnt alpha values. // This method reverses it, assuming a black (!) background - // and white text (actually only the red channel is read). + // and white text (actually only the red channel is read). // The method will then fill up the whole image with the // colour given. - bool ConvertColourToAlpha( unsigned char r, unsigned char g, unsigned char b ); + bool ConvertColourToAlpha( unsigned char r, unsigned char g, unsigned char b ); static bool CanRead( const wxString& name ); static int GetImageCount( const wxString& name, long type = wxBITMAP_TYPE_ANY ); @@ -251,15 +314,24 @@ public: // these functions provide fastest access to wxImage data but should be // used carefully as no checks are done unsigned char *GetData() const; - void SetData( unsigned char *data ); - void SetData( unsigned char *data, int new_width, int new_height ); + void SetData( unsigned char *data, bool static_data=false ); + void SetData( unsigned char *data, int new_width, int new_height, bool static_data=false ); unsigned char *GetAlpha() const; // may return NULL! bool HasAlpha() const { return GetAlpha() != NULL; } - void SetAlpha(unsigned char *alpha = NULL); + void SetAlpha(unsigned char *alpha = NULL, bool static_data=false); + void InitAlpha(); + + // return true if this pixel is masked or has alpha less than specified + // threshold + bool IsTransparent(int x, int y, + unsigned char threshold = wxIMAGE_ALPHA_THRESHOLD) const; // Mask functions void SetMaskColour( unsigned char r, unsigned char g, unsigned char b ); + // Get the current mask colour or find a suitable colour + // returns true if using current mask colour + bool GetOrFindMaskColour( unsigned char *r, unsigned char *g, unsigned char *b ) const; unsigned char GetMaskRed() const; unsigned char GetMaskGreen() const; unsigned char GetMaskBlue() const; @@ -290,6 +362,12 @@ public: // Returned value: # of entries in the histogram unsigned long ComputeHistogram( wxImageHistogram &h ) const; +#if wxABI_VERSION >= 20602 + // Rotates the hue of each pixel of the image. angle is a double in the range + // -1.0..1.0 where -1.0 is -360 degrees and 1.0 is 360 degrees + void RotateHue(double angle); +#endif // wxABI_VERSION >= 2.6.2 + wxImage& operator = (const wxImage& image) { if ( (*this) != image ) @@ -316,9 +394,21 @@ public: static void CleanUpHandlers(); static void InitStandardHandlers(); +#if wxABI_VERSION >= 20602 + static HSVValue RGBtoHSV(const RGBValue& rgb); + static RGBValue HSVtoRGB(const HSVValue& hsv); +#endif // wxABI_VERSION >= 2.6.2 + + protected: static wxList sm_handlers; + // return the index of the point with the given coordinates or -1 if the + // image is invalid of the coordinates are out of range + // + // note that index must be multiplied by 3 when using it with RGB array + long XYToIndex(int x, int y) const; + private: friend class WXDLLEXPORT wxImageHandler; @@ -328,7 +418,7 @@ private: extern void WXDLLEXPORT wxInitAllImageHandlers(); -WXDLLEXPORT_DATA(extern wxImage) wxNullImage; +extern WXDLLEXPORT_DATA(wxImage) wxNullImage; //----------------------------------------------------------------------------- // wxImage handlers