X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/21dc4be5d27fd73cda55795ab9d1e7e02b494c46..d72e4d138a45abaacd77caa6415d51ae02a49df5:/include/wx/image.h diff --git a/include/wx/image.h b/include/wx/image.h index 36843a4122..d1d4ec7621 100644 --- a/include/wx/image.h +++ b/include/wx/image.h @@ -1,5 +1,5 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: image.h +// Name: wx/image.h // Purpose: wxImage class // Author: Robert Roebling // RCS-ID: $Id$ @@ -10,11 +10,10 @@ #ifndef _WX_IMAGE_H_ #define _WX_IMAGE_H_ -#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) -#pragma interface "image.h" -#endif - #include "wx/defs.h" + +#if wxUSE_IMAGE + #include "wx/object.h" #include "wx/string.h" #include "wx/gdicmn.h" @@ -24,8 +23,6 @@ # include "wx/stream.h" #endif -#if wxUSE_IMAGE - // on some systems (Unixware 7.x) index is defined as a macro in the headers // which breaks the compilation below #undef index @@ -46,6 +43,13 @@ enum wxIMAGE_RESOLUTION_CM = 2 }; +// Constants for wxImage::Scale() for determining the level of quality +enum +{ + wxIMAGE_QUALITY_NORMAL = 0, + wxIMAGE_QUALITY_HIGH = 1 +}; + // alpha channel values: fully transparent, default threshold separating // transparent pixels from opaque for a few functions dealing with alpha and // fully opaque @@ -61,6 +65,15 @@ class WXDLLEXPORT wxImageHandler; class WXDLLEXPORT wxImage; class WXDLLEXPORT wxPalette; +//----------------------------------------------------------------------------- +// wxVariant support +//----------------------------------------------------------------------------- + +#if wxUSE_VARIANT +#include "wx/variant.h" +DECLARE_VARIANT_OBJECT_EXPORTED(wxImage,WXDLLEXPORT) +#endif + //----------------------------------------------------------------------------- // wxImageHandler //----------------------------------------------------------------------------- @@ -86,10 +99,10 @@ public: void SetExtension(const wxString& ext) { m_extension = ext; } void SetType(long type) { m_type = type; } void SetMimeType(const wxString& type) { m_mime = type; } - wxString GetName() const { return m_name; } - wxString GetExtension() const { return m_extension; } + const wxString& GetName() const { return m_name; } + const wxString& GetExtension() const { return m_extension; } long GetType() const { return m_type; } - wxString GetMimeType() const { return m_mime; } + const wxString& GetMimeType() const { return m_mime; } protected: #if wxUSE_STREAMS @@ -157,27 +170,46 @@ public: class WXDLLEXPORT wxImage: public wxObject { public: + // 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; + }; + 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 ); + wxImage( const char* const* xpmData ); #if wxUSE_STREAMS wxImage( wxInputStream& stream, long type = wxBITMAP_TYPE_ANY, int index = -1 ); wxImage( wxInputStream& stream, const wxString& mimetype, int index = -1 ); #endif // wxUSE_STREAMS - wxImage( const wxImage& image ); - wxImage( const wxImage* image ); - 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 ); + bool Create( const char* const* xpmData ); void Destroy(); // creates an identical copy of the image (the = operator @@ -199,12 +231,21 @@ public: void Paste( const wxImage &image, int x, int y ); // return the new image with size width*height - wxImage Scale( int width, int height ) const; + wxImage Scale( int width, int height, int quality = wxIMAGE_QUALITY_NORMAL ) const; + + // box averager and bicubic filters for up/down sampling + wxImage ResampleBox(int width, int height) const; + wxImage ResampleBicubic(int width, int height) const; + + // blur the image according to the specified pixel radius + wxImage Blur(int radius); + wxImage BlurHorizontal(int radius); + wxImage BlurVertical(int radius); wxImage ShrinkBy( int xFactor , int yFactor ) const ; // rescales the image in place - wxImage& Rescale( int width, int height ) { return *this = Scale(width, height); } + wxImage& Rescale( int width, int height, int quality = wxIMAGE_QUALITY_NORMAL ) { return *this = Scale(width, height, quality); } // resizes the image in place wxImage& Resize( const wxSize& size, const wxPoint& pos, @@ -222,6 +263,10 @@ public: void Replace( unsigned char r1, unsigned char g1, unsigned char b1, unsigned char r2, unsigned char g2, unsigned char b2 ); + // Convert to greyscale image. Uses the luminance component (Y) of the image. + // The luma value (YUV) is calculated using (R * lr) + (G * lg) + (B * lb), defaults to ITU-T BT.601 + wxImage ConvertToGreyscale( double lr = 0.299, double lg = 0.587, double lb = 0.114 ) const; + // convert to monochrome image ( will be replaced by white, // everything else by black) wxImage ConvertToMono( unsigned char r, unsigned char g, unsigned char b ) const; @@ -282,7 +327,8 @@ public: virtual bool SaveFile( wxOutputStream& stream, const wxString& mimetype ) const; #endif - bool Ok() const; + bool Ok() const { return IsOk(); } + bool IsOk() const; int GetWidth() const; int GetHeight() const; @@ -337,12 +383,9 @@ public: // Returned value: # of entries in the histogram unsigned long ComputeHistogram( wxImageHistogram &h ) const; - wxImage& operator = (const wxImage& image) - { - if ( (*this) != image ) - Ref(image); - return *this; - } + // 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); bool operator == (const wxImage& image) const { return m_refData == image.m_refData; } @@ -363,6 +406,10 @@ public: static void CleanUpHandlers(); static void InitStandardHandlers(); + static HSVValue RGBtoHSV(const RGBValue& rgb); + static RGBValue HSVtoRGB(const HSVValue& hsv); + + protected: static wxList sm_handlers; @@ -372,6 +419,9 @@ protected: // note that index must be multiplied by 3 when using it with RGB array long XYToIndex(int x, int y) const; + virtual wxObjectRefData* CreateRefData() const; + virtual wxObjectRefData* CloneRefData(const wxObjectRefData* data) const; + private: friend class WXDLLEXPORT wxImageHandler; @@ -401,4 +451,3 @@ extern WXDLLEXPORT_DATA(wxImage) wxNullImage; #endif // _WX_IMAGE_H_ -