Apply mask origin patch for blitting.

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

diff --git a/include/wx/image.h b/include/wx/image.h
index bc19ddd607f9c6fd78c52b2283ac6461071293f3..36843a4122bbd4f00cb4bf3dfc7ef5a9f2f6ecab 100644 (file)
--- a/include/wx/image.h
+++ b/include/wx/image.h
@@ -10,17 +10,14 @@
 #ifndef _WX_IMAGE_H_
 #define _WX_IMAGE_H_
 
 #ifndef _WX_IMAGE_H_
 #define _WX_IMAGE_H_
 

-#if defined(__GNUG__) && !defined(__APPLE__)
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)

 #pragma interface "image.h"
 #endif
 
 #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"
 #include "wx/object.h"
 #include "wx/string.h"
 #include "wx/gdicmn.h"

-#if WXWIN_COMPATIBILITY_2_2
-#  include "wx/bitmap.h"
-#endif

 #include "wx/hashmap.h"
 
 #if wxUSE_STREAMS
 #include "wx/hashmap.h"
 
 #if wxUSE_STREAMS


@@ -33,8 +30,29 @@
 // which breaks the compilation below
 #undef index
 
 // which breaks the compilation below
 #undef index
 

+#define wxIMAGE_OPTION_QUALITY  wxString(_T("quality"))

 #define wxIMAGE_OPTION_FILENAME wxString(_T("FileName"))
 
 #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
 //-----------------------------------------------------------------------------
 //-----------------------------------------------------------------------------
 // classes
 //-----------------------------------------------------------------------------


@@ -51,12 +69,12 @@ class WXDLLEXPORT wxImageHandler: public wxObject
 {
 public:
     wxImageHandler()
 {
 public:
     wxImageHandler()

-        : m_name(wxT("")), m_extension(wxT("")), m_mime(), m_type(0)
+        : m_name(wxEmptyString), m_extension(wxEmptyString), m_mime(), m_type(0)

         { }
 
 #if wxUSE_STREAMS
         { }
 
 #if wxUSE_STREAMS

-    virtual bool LoadFile( wxImage *image, wxInputStream& stream, bool verbose=TRUE, int index=-1 );
-    virtual bool SaveFile( wxImage *image, wxOutputStream& stream, bool verbose=TRUE );
+    virtual bool LoadFile( wxImage *image, wxInputStream& stream, bool verbose=true, int index=-1 );
+    virtual bool SaveFile( wxImage *image, wxOutputStream& stream, bool verbose=true );

 
     virtual int GetImageCount( wxInputStream& stream );
 
 
     virtual int GetImageCount( wxInputStream& stream );
 


@@ -139,11 +157,14 @@ public:
 class WXDLLEXPORT wxImage: public wxObject
 {
 public:
 class WXDLLEXPORT wxImage: public wxObject
 {
 public:

-    wxImage();
-    wxImage( int width, int height );
-    wxImage( int width, int height, unsigned char* data, bool static_data = FALSE );
+    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 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 );
 
 #if wxUSE_STREAMS
     wxImage( wxInputStream& stream, long type = wxBITMAP_TYPE_ANY, int index = -1 );


@@ -153,17 +174,10 @@ public:
     wxImage( const wxImage& image );
     wxImage( const wxImage* image );
 
     wxImage( const wxImage& image );
     wxImage( const wxImage* image );
 

-#if WXWIN_COMPATIBILITY_2_2 && wxUSE_GUI
-    // conversion to/from wxBitmap (deprecated, use wxBitmap's methods instead):
-    wxDEPRECATED( wxImage(const wxBitmap &bitmap) );
-    wxDEPRECATED( wxBitmap ConvertToBitmap() const );
-#ifdef __WXGTK__
-    wxBitmap ConvertToMonoBitmap( unsigned char red, unsigned char green, unsigned char blue ) const;
-#endif
-#endif
-
-    void Create( int width, int height );
-    void Create( int width, int height, unsigned char* data, bool static_data = FALSE );
+    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
     void Destroy();
 
     // creates an identical copy of the image (the = operator


@@ -171,7 +185,14 @@ public:
     wxImage Copy() const;
 
     // return the new image with size width*height
     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
 
     // pastes image into this instance and takes care of
     // the mask colour and out of bounds problems


@@ -185,29 +206,35 @@ public:
     // rescales the image in place
     wxImage& Rescale( int width, int height ) { return *this = Scale(width, height); }
 
     // 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,
     // 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,

-                   bool interpolating = TRUE, wxPoint * offset_after_rotation = (wxPoint*) NULL) const;
+                   bool interpolating = true, wxPoint * offset_after_rotation = (wxPoint*) NULL) const;

 
 

-    wxImage Rotate90( bool clockwise = TRUE ) const;
-    wxImage Mirror( bool horizontally = TRUE ) const;
+    wxImage Rotate90( bool clockwise = true ) const;
+    wxImage Mirror( bool horizontally = true ) const;

 
     // replace one colour with another
     void Replace( unsigned char r1, unsigned char g1, unsigned char b1,
                   unsigned char r2, unsigned char g2, unsigned char b2 );
 
 
     // replace one colour with another
     void Replace( unsigned char r1, unsigned char g1, unsigned char b1,
                   unsigned char r2, unsigned char g2, unsigned char b2 );
 

-    // convert to monochrome image (<r,g,b> will be replaced by white, everything else by black)
+    // 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;
 
     // these routines are slow but safe
     void SetRGB( int x, int y, unsigned char r, unsigned char g, unsigned char b );
     wxImage ConvertToMono( unsigned char r, unsigned char g, unsigned char b ) const;
 
     // 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;
 
     void SetAlpha(int x, int y, unsigned char alpha);
     unsigned char GetRed( int x, int y ) const;
     unsigned char GetGreen( int x, int y ) const;
     unsigned char GetBlue( int x, int y ) const;
 
     void SetAlpha(int x, int y, unsigned char alpha);

-    unsigned char GetAlpha(int x, int y);
+    unsigned char GetAlpha(int x, int y) const;

 
     // find first colour that is not used in the image and has higher
     // RGB values than <startR,startG,startB>
 
     // find first colour that is not used in the image and has higher
     // RGB values than <startR,startG,startB>


@@ -218,6 +245,22 @@ public:
     bool SetMaskFromImage(const wxImage & mask,
                           unsigned char mr, unsigned char mg, unsigned char mb);
 
     bool SetMaskFromImage(const wxImage & mask,
                           unsigned char mr, unsigned char mg, unsigned char mb);
 

+    // converts image's alpha channel to mask, if it has any, does nothing
+    // otherwise:
+    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
+    // (actually shades of grey) typically when you draw anti-
+    // aliased text into a bitmap. The DC drawinf routines
+    // 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).
+    // The method will then fill up the whole image with the
+    // colour given.
+    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 );
     virtual bool LoadFile( const wxString& name, long type = wxBITMAP_TYPE_ANY, int index = -1 );
     static bool CanRead( const wxString& name );
     static int GetImageCount( const wxString& name, long type = wxBITMAP_TYPE_ANY );
     virtual bool LoadFile( const wxString& name, long type = wxBITMAP_TYPE_ANY, int index = -1 );


@@ -246,19 +289,28 @@ public:
     // these functions provide fastest access to wxImage data but should be
     // used carefully as no checks are done
     unsigned char *GetData() const;
     // 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; }
 
     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 );
 
     // 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;
     unsigned char GetMaskRed() const;
     unsigned char GetMaskGreen() const;
     unsigned char GetMaskBlue() const;

-    void SetMask( bool mask = TRUE );
+    void SetMask( bool mask = true );

     bool HasMask() const;
 
 #if wxUSE_PALETTE
     bool HasMask() const;
 
 #if wxUSE_PALETTE


@@ -306,12 +358,20 @@ public:
     static wxImageHandler *FindHandler( long imageType );
     static wxImageHandler *FindHandlerMime( const wxString& mimetype );
 
     static wxImageHandler *FindHandler( long imageType );
     static wxImageHandler *FindHandlerMime( const wxString& mimetype );
 

+    static wxString GetImageExtWildcard();
+

     static void CleanUpHandlers();
     static void InitStandardHandlers();
 
 protected:
     static wxList   sm_handlers;
 
     static void CleanUpHandlers();
     static void InitStandardHandlers();
 
 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;
 
 private:
     friend class WXDLLEXPORT wxImageHandler;
 


@@ -321,7 +381,7 @@ private:
 
 extern void WXDLLEXPORT wxInitAllImageHandlers();
 
 
 extern void WXDLLEXPORT wxInitAllImageHandlers();
 

-WXDLLEXPORT_DATA(extern wxImage)    wxNullImage;
+extern WXDLLEXPORT_DATA(wxImage)    wxNullImage;

 
 //-----------------------------------------------------------------------------
 // wxImage handlers
 
 //-----------------------------------------------------------------------------
 // wxImage handlers