X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/5e5437e00bb1e42d24060e6115d2e6a042c1a93f..1169a91932273bc84c23ed9dbd0a2da064d59d66:/include/wx/image.h diff --git a/include/wx/image.h b/include/wx/image.h index 7e872e3911..778de29404 100644 --- a/include/wx/image.h +++ b/include/wx/image.h @@ -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,18 +18,30 @@ #include "wx/object.h" #include "wx/string.h" #include "wx/gdicmn.h" -#include "wx/bitmap.h" +#if WXWIN_COMPATIBILITY_2_2 +# include "wx/bitmap.h" +#endif +#include "wx/hashmap.h" #if wxUSE_STREAMS # 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 + +#define wxIMAGE_OPTION_FILENAME wxString(_T("FileName")) + //----------------------------------------------------------------------------- // classes //----------------------------------------------------------------------------- class WXDLLEXPORT wxImageHandler; class WXDLLEXPORT wxImage; +class WXDLLEXPORT wxPalette; //----------------------------------------------------------------------------- // wxImageHandler @@ -38,15 +50,17 @@ 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=0 ); + 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 ); - bool CanRead( wxInputStream& stream ) { return DoCanRead(stream); } + bool CanRead( wxInputStream& stream ) { return CallDoCanRead(stream); } bool CanRead( const wxString& name ); #endif // wxUSE_STREAMS @@ -62,67 +76,103 @@ 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; wxString m_extension; wxString m_mime; long m_type; - + private: DECLARE_CLASS(wxImageHandler) }; //----------------------------------------------------------------------------- -// wxImage +// wxImageHistogram //----------------------------------------------------------------------------- -class WXDLLEXPORT wxHNode +class WXDLLEXPORT wxImageHistogramEntry { public: + wxImageHistogramEntry() { index = value = 0; } unsigned long index; unsigned long value; }; +WX_DECLARE_EXPORTED_HASH_MAP(unsigned long, wxImageHistogramEntry, + wxIntegerHash, wxIntegerEqual, + 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 +//----------------------------------------------------------------------------- + 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 ); - wxImage( wxInputStream& stream, long type = wxBITMAP_TYPE_ANY ); - wxImage( const wxString& name, const wxString& mimetype ); - wxImage( wxInputStream& stream, const wxString& mimetype ); + wxImage( const wxString& name, long type = wxBITMAP_TYPE_ANY, int index = -1 ); + wxImage( const wxString& name, const wxString& mimetype, int index = -1 ); + +#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 ); - wxImage( const wxBitmap &bitmap ); - operator wxBitmap() const { return ConvertToBitmap(); } - wxBitmap ConvertToBitmap() const; -#ifdef __WXGTK__ - wxBitmap ConvertToMonoBitmap( unsigned char red, unsigned char green, unsigned char blue ); -#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 // just raises the ref count) wxImage Copy() const; - + // return the new image with size width*height wxImage GetSubImage( const wxRect& ) const; - + // pastes image into this instance and takes care of // the mask colour and out of bounds problems - void Paste( const wxImage &image, int x, int y ); + 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 ShrinkBy( int xFactor , int yFactor ) const ; + // rescales the image in place wxImage& Rescale( int width, int height ) { return *this = Scale(width, height); } @@ -138,37 +188,61 @@ 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 ( 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 ); 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); + + // find first colour that is not used in the image and has higher + // RGB values than + bool FindFirstUnusedColour( unsigned char *r, unsigned char *g, unsigned char *b, + unsigned char startR = 1, unsigned char startG = 0, + unsigned char startB = 0 ) const; + // Set image's mask to the area of 'mask' that has colour + bool SetMaskFromImage(const wxImage & mask, + unsigned char mr, unsigned char mg, unsigned char mb); + static bool CanRead( const wxString& name ); - virtual bool LoadFile( const wxString& name, long type = wxBITMAP_TYPE_ANY ); - virtual bool LoadFile( const wxString& name, const wxString& mimetype ); + 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 ); + virtual bool LoadFile( const wxString& name, const wxString& mimetype, int index = -1 ); #if wxUSE_STREAMS static bool CanRead( wxInputStream& stream ); - virtual bool LoadFile( wxInputStream& stream, long type = wxBITMAP_TYPE_ANY ); - virtual bool LoadFile( wxInputStream& stream, const wxString& mimetype ); + static int GetImageCount( wxInputStream& stream, long type = wxBITMAP_TYPE_ANY ); + virtual bool LoadFile( wxInputStream& stream, long type = wxBITMAP_TYPE_ANY, int index = -1 ); + virtual bool LoadFile( wxInputStream& stream, const wxString& mimetype, int index = -1 ); #endif - virtual bool SaveFile( const wxString& name, int type ); - virtual bool SaveFile( const wxString& name, const wxString& mimetype ); + 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; #if wxUSE_STREAMS - virtual bool SaveFile( wxOutputStream& stream, int type ); - virtual bool SaveFile( wxOutputStream& stream, const wxString& mimetype ); + virtual bool SaveFile( wxOutputStream& stream, int type ) const; + virtual bool SaveFile( wxOutputStream& stream, const wxString& mimetype ) const; #endif bool Ok() const; 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 ); @@ -178,10 +252,12 @@ public: void SetMask( bool mask = TRUE ); bool HasMask() const; +#if wxUSE_PALETTE // Palette functions bool HasPalette() const; const wxPalette& GetPalette() const; void SetPalette(const wxPalette& palette); +#endif // wxUSE_PALETTE // Option functions (arbitrary name/value mapping) void SetOption(const wxString& name, const wxString& value); @@ -190,8 +266,15 @@ public: int GetOptionInt(const wxString& name) const; bool HasOption(const wxString& name) const; - unsigned long CountColours( unsigned long stopafter = (unsigned long) -1 ); - unsigned long ComputeHistogram( wxHashTable &h ); + unsigned long CountColours( unsigned long stopafter = (unsigned long) -1 ) const; + + // 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 + // in the image with that colour. + // Returned value: # of entries in the histogram + unsigned long ComputeHistogram( wxImageHistogram &h ) const; wxImage& operator = (const wxImage& image) { @@ -200,9 +283,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; } @@ -214,6 +297,8 @@ public: static wxImageHandler *FindHandler( long imageType ); static wxImageHandler *FindHandlerMime( const wxString& mimetype ); + static wxString GetImageExtWildcard(); + static void CleanUpHandlers(); static void InitStandardHandlers(); @@ -229,6 +314,7 @@ private: extern void WXDLLEXPORT wxInitAllImageHandlers(); +WXDLLEXPORT_DATA(extern wxImage) wxNullImage; //----------------------------------------------------------------------------- // wxImage handlers @@ -241,6 +327,10 @@ extern void WXDLLEXPORT wxInitAllImageHandlers(); #include "wx/imagjpeg.h" #include "wx/imagtiff.h" #include "wx/imagpnm.h" +#include "wx/imagxpm.h" +#include "wx/imagiff.h" + +#endif // wxUSE_IMAGE #endif // _WX_IMAGE_H_