rename the ID parameter

[wxWidgets.git] / include / wx / image.h

diff --git a/include/wx/image.h b/include/wx/image.h
index e6850220093824a9c9e08ce53022d2eb77b0a95a..8718380516efeaf0f426c0d7729556ee59a928b2 100644 (file)
--- 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$
@@ -11,6 +11,9 @@
 #define _WX_IMAGE_H_
 
 #include "wx/defs.h"
+
+#if wxUSE_IMAGE
+
 #include "wx/object.h"
 #include "wx/string.h"
 #include "wx/gdicmn.h"
@@ -20,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
@@ -42,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
@@ -57,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
 //-----------------------------------------------------------------------------
@@ -160,7 +177,7 @@ public:
     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 red;
         unsigned char green;
         unsigned char blue;
     };
@@ -171,7 +188,7 @@ public:
     public:
         HSVValue(double h=0.0, double s=0.0, double v=0.0)
             : hue(h), saturation(s), value(v) {}
-        double hue;  
+        double hue;
         double saturation;
         double value;
     };
@@ -190,9 +207,6 @@ public:
     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 );
@@ -218,12 +232,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,
@@ -241,6 +264,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 (<r,g,b> will be replaced by white,
     // everything else by black)
     wxImage ConvertToMono( unsigned char r, unsigned char g, unsigned char b ) const;
@@ -360,13 +387,6 @@ public:
     // -1.0..1.0 where -1.0 is -360 degrees and 1.0 is 360 degrees
     void RotateHue(double angle);
 
-    wxImage& operator = (const wxImage& image)
-    {
-        if ( (*this) != image )
-            Ref(image);
-        return *this;
-    }
-
     bool operator == (const wxImage& image) const
         { return m_refData == image.m_refData; }
     bool operator != (const wxImage& image) const
@@ -399,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;
 
@@ -428,4 +451,3 @@ extern WXDLLEXPORT_DATA(wxImage)    wxNullImage;
 
 #endif
   // _WX_IMAGE_H_
-