]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/image.h
1. added support for bitmaps with alpha channel
[wxWidgets.git] / include / wx / image.h
index cf69aa743aa9e8c98132d895c08fc8762622cd5c..153065c764b3cb2a537929c65d164d9a26e439bf 100644 (file)
@@ -10,7 +10,7 @@
 #ifndef _WX_IMAGE_H_
 #define _WX_IMAGE_H_
 
-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
 #pragma interface "image.h"
 #endif
 
@@ -18,7 +18,6 @@
 #include "wx/object.h"
 #include "wx/string.h"
 #include "wx/gdicmn.h"
-#include "wx/bitmap.h"
 #include "wx/hashmap.h"
 
 #if wxUSE_STREAMS
 
 #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
+
 #define wxIMAGE_OPTION_FILENAME wxString(_T("FileName"))
 
 //-----------------------------------------------------------------------------
@@ -35,6 +38,7 @@
 
 class WXDLLEXPORT wxImageHandler;
 class WXDLLEXPORT wxImage;
+class WXDLLEXPORT wxPalette;
 
 //-----------------------------------------------------------------------------
 // wxImageHandler
@@ -43,7 +47,9 @@ class WXDLLEXPORT wxImage;
 class WXDLLEXPORT wxImageHandler: public wxObject
 {
 public:
-    wxImageHandler() { m_name = ""; m_extension = ""; m_type = 0; }
+    wxImageHandler()
+        : m_name(wxEmptyString), m_extension(wxEmptyString), m_mime(), m_type(0)
+        { }
 
 #if wxUSE_STREAMS
     virtual bool LoadFile( wxImage *image, wxInputStream& stream, bool verbose=TRUE, int index=-1 );
@@ -51,7 +57,7 @@ public:
 
     virtual int GetImageCount( wxInputStream& stream );
 
-    bool CanRead( wxInputStream& stream ) { return DoCanRead(stream); }
+    bool CanRead( wxInputStream& stream ) { return CallDoCanRead(stream); }
     bool CanRead( const wxString& name );
 #endif // wxUSE_STREAMS
 
@@ -67,6 +73,9 @@ public:
 protected:
 #if wxUSE_STREAMS
     virtual bool DoCanRead( wxInputStream& stream ) = 0;
+
+    // save the stream position, call DoCanRead() and restore the position
+    bool CallDoCanRead(wxInputStream& stream);
 #endif // wxUSE_STREAMS
 
     wxString  m_name;
@@ -85,14 +94,40 @@ private:
 class WXDLLEXPORT wxImageHistogramEntry
 {
 public:
-    wxImageHistogramEntry() : index(0), value(0) {}
+    wxImageHistogramEntry() { index = value = 0; }
     unsigned long index;
     unsigned long value;
 };
 
 WX_DECLARE_EXPORTED_HASH_MAP(unsigned long, wxImageHistogramEntry,
                              wxIntegerHash, wxIntegerEqual,
-                             wxImageHistogram);
+                             wxImageHistogramBase);
+
+class WXDLLEXPORT wxImageHistogram : public wxImageHistogramBase
+{
+public:
+    wxImageHistogram() : wxImageHistogramBase(256) { }
+
+    // get the key in the histogram for the given RGB values
+    static unsigned long MakeKey(unsigned char r,
+                                 unsigned char g,
+                                 unsigned char b)
+    {
+        return (r << 16) | (g << 8) | b;
+    }
+
+    // find first colour that is not used in the image and has higher
+    // RGB values than RGB(startR, startG, startB)
+    //
+    // returns true and puts this colour in r, g, b (each of which may be NULL)
+    // on success or returns false if there are no more free colours
+    bool FindFirstUnusedColour(unsigned char *r,
+                               unsigned char *g,
+                               unsigned char *b,
+                               unsigned char startR = 1,
+                               unsigned char startG = 0,
+                               unsigned char startB = 0 ) const;
+};
 
 //-----------------------------------------------------------------------------
 // wxImage
@@ -102,7 +137,7 @@ class WXDLLEXPORT wxImage: public wxObject
 {
 public:
     wxImage();
-    wxImage( int width, int height );
+    wxImage( int width, int height, bool clear = true );
     wxImage( int width, int height, unsigned char* data, 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 );
@@ -115,17 +150,8 @@ public:
     wxImage( const wxImage& image );
     wxImage( const wxImage* image );
 
-#if wxUSE_GUI
-    // convertion to/from wxBitmap (deprecated, use wxBitmap's methods instead):
-    wxImage( const wxBitmap &bitmap );
-    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 );
     void Destroy();
 
     // creates an identical copy of the image (the = operator
@@ -142,6 +168,8 @@ public:
     // return the new image with size width*height
     wxImage Scale( int width, int height ) const;
 
+    wxImage ShrinkBy( int xFactor , int yFactor ) const ;
+
     // rescales the image in place
     wxImage& Rescale( int width, int height ) { return *this = Scale(width, height); }
 
@@ -157,7 +185,8 @@ public:
     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
@@ -166,6 +195,9 @@ public:
     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) const;
+
     // find first colour that is not used in the image and has higher
     // RGB values than <startR,startG,startB>
     bool FindFirstUnusedColour( unsigned char *r, unsigned char *g, unsigned char *b,
@@ -175,6 +207,10 @@ public:
     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 = 128);
+
     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 );
@@ -187,6 +223,7 @@ public:
     virtual bool LoadFile( wxInputStream& stream, const wxString& mimetype, int index = -1 );
 #endif
 
+    virtual bool SaveFile( const wxString& name ) const;
     virtual bool SaveFile( const wxString& name, int type ) const;
     virtual bool SaveFile( const wxString& name, const wxString& mimetype ) const;
 
@@ -199,9 +236,15 @@ public:
     int GetWidth() const;
     int GetHeight() const;
 
-    char unsigned *GetData() const;
-    void SetData( char unsigned *data );
-    void SetData( char unsigned *data, int new_width, int new_height );
+    // 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 );
+
+    unsigned char *GetAlpha() const;    // may return NULL!
+    bool HasAlpha() const { return GetAlpha() != NULL; }
+    void SetAlpha(unsigned char *alpha = NULL);
 
     // Mask functions
     void SetMaskColour( unsigned char r, unsigned char g, unsigned char b );
@@ -229,8 +272,8 @@ public:
 
     // Computes the histogram of the image and fills a hash table, indexed
     // with integer keys built as 0xRRGGBB, containing wxImageHistogramEntry
-    // objects. Each of them contains an 'index' (useful to build a palette 
-    // with the image colours) and a 'value', which is the number of pixels 
+    // objects. Each of them contains an 'index' (useful to build a palette
+    // with the image colours) and a 'value', which is the number of pixels
     // in the image with that colour.
     // Returned value: # of entries in the histogram
     unsigned long ComputeHistogram( wxImageHistogram &h ) const;
@@ -242,9 +285,9 @@ public:
         return *this;
     }
 
-    bool operator == (const wxImage& image)
+    bool operator == (const wxImage& image) const
         { return m_refData == image.m_refData; }
-    bool operator != (const wxImage& image)
+    bool operator != (const wxImage& image) const
         { return m_refData != image.m_refData; }
 
     static wxList& GetHandlers() { return sm_handlers; }
@@ -256,6 +299,8 @@ public:
     static wxImageHandler *FindHandler( long imageType );
     static wxImageHandler *FindHandlerMime( const wxString& mimetype );
 
+    static wxString GetImageExtWildcard();
+
     static void CleanUpHandlers();
     static void InitStandardHandlers();