/////////////////////////////////////////////////////////////////////////////
-// Name: image.h
+// Name: wx/image.h
// Purpose: wxImage class
// Author: Robert Roebling
// RCS-ID: $Id$
#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"
# 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_RESOLUTIONUNIT wxString(_T("ResolutionUnit"))
// constants used with wxIMAGE_OPTION_RESOLUTIONUNIT
-enum
+//
+// NB: don't change these values, they correspond to libjpeg constants
+enum wxImageResolution
{
+ // Resolution not specified
+ wxIMAGE_RESOLUTION_NONE = 0,
+
+ // Resolution specified in inches
wxIMAGE_RESOLUTION_INCHES = 1,
+
+ // Resolution specified in centimeters
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
+const unsigned char wxIMAGE_ALPHA_TRANSPARENT = 0;
+const unsigned char wxIMAGE_ALPHA_THRESHOLD = 0x80;
+const unsigned char wxIMAGE_ALPHA_OPAQUE = 0xff;
+
//-----------------------------------------------------------------------------
// classes
//-----------------------------------------------------------------------------
-class WXDLLEXPORT wxImageHandler;
-class WXDLLEXPORT wxImage;
-class WXDLLEXPORT wxPalette;
+class WXDLLIMPEXP_FWD_CORE wxImageHandler;
+class WXDLLIMPEXP_FWD_CORE wxImage;
+class WXDLLIMPEXP_FWD_CORE wxPalette;
+
+//-----------------------------------------------------------------------------
+// wxVariant support
+//-----------------------------------------------------------------------------
+
+#if wxUSE_VARIANT
+#include "wx/variant.h"
+DECLARE_VARIANT_OBJECT_EXPORTED(wxImage,WXDLLIMPEXP_CORE)
+#endif
//-----------------------------------------------------------------------------
// wxImageHandler
//-----------------------------------------------------------------------------
-class WXDLLEXPORT wxImageHandler: public wxObject
+class WXDLLIMPEXP_CORE wxImageHandler: public wxObject
{
public:
wxImageHandler()
- : m_name(wxEmptyString), m_extension(wxEmptyString), m_mime(), m_type(0)
+ : m_name(wxEmptyString), m_extension(wxEmptyString), m_mime(), m_type(wxBITMAP_TYPE_INVALID)
{ }
#if wxUSE_STREAMS
void SetName(const wxString& name) { m_name = name; }
void SetExtension(const wxString& ext) { m_extension = ext; }
- void SetType(long type) { m_type = type; }
+ void SetType(wxBitmapType type) { m_type = type; }
void SetMimeType(const wxString& type) { m_mime = type; }
- wxString GetName() const { return m_name; }
- wxString GetExtension() const { return m_extension; }
- long GetType() const { return m_type; }
- wxString GetMimeType() const { return m_mime; }
+ const wxString& GetName() const { return m_name; }
+ const wxString& GetExtension() const { return m_extension; }
+ wxBitmapType GetType() const { return m_type; }
+ const wxString& GetMimeType() const { return m_mime; }
+
+#if WXWIN_COMPATIBILITY_2_8
+ wxDEPRECATED(
+ void SetType(long type) { SetType((wxBitmapType)type); }
+ )
+#endif // WXWIN_COMPATIBILITY_2_8
protected:
#if wxUSE_STREAMS
bool CallDoCanRead(wxInputStream& stream);
#endif // wxUSE_STREAMS
+ // helper for the derived classes SaveFile() implementations: returns the
+ // values of x- and y-resolution options specified as the image options if
+ // any
+ static wxImageResolution
+ GetResolutionFromOptions(const wxImage& image, int *x, int *y);
+
+
wxString m_name;
wxString m_extension;
wxString m_mime;
- long m_type;
+ wxBitmapType m_type;
private:
DECLARE_CLASS(wxImageHandler)
// wxImageHistogram
//-----------------------------------------------------------------------------
-class WXDLLEXPORT wxImageHistogramEntry
+class WXDLLIMPEXP_CORE wxImageHistogramEntry
{
public:
wxImageHistogramEntry() { index = value = 0; }
wxIntegerHash, wxIntegerEqual,
wxImageHistogramBase);
-class WXDLLEXPORT wxImageHistogram : public wxImageHistogramBase
+class WXDLLIMPEXP_CORE wxImageHistogram : public wxImageHistogramBase
{
public:
wxImageHistogram() : wxImageHistogramBase(256) { }
// wxImage
//-----------------------------------------------------------------------------
-class WXDLLEXPORT wxImage: public wxObject
+class WXDLLIMPEXP_CORE wxImage: public wxObject
{
public:
- wxImage(){}
+ // 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, wxBitmapType 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, wxBitmapType 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 );
+#ifdef __BORLANDC__
+ // needed for Borland 5.5
+ wxImage( char** xpmData ) { Create(wx_const_cast(const char* const*, xpmData)); }
+ bool Create( char** xpmData ) { return Create(wx_const_cast(const char* const*, xpmData)); }
+#endif
void Destroy();
// creates an identical copy of the image (the = operator
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) const;
+ wxImage BlurHorizontal(int radius) const;
+ wxImage BlurVertical(int radius) const;
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,
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;
// converts image's alpha channel to mask, if it has any, does nothing
// otherwise:
- bool ConvertAlphaToMask(unsigned char threshold = 128);
+ 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
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 int GetImageCount( const wxString& name, wxBitmapType type = wxBITMAP_TYPE_ANY );
+ virtual bool LoadFile( const wxString& name, wxBitmapType 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 );
- static int GetImageCount( wxInputStream& stream, long type = wxBITMAP_TYPE_ANY );
- virtual bool LoadFile( wxInputStream& stream, long type = wxBITMAP_TYPE_ANY, int index = -1 );
+ static int GetImageCount( wxInputStream& stream, wxBitmapType type = wxBITMAP_TYPE_ANY );
+ virtual bool LoadFile( wxInputStream& stream, wxBitmapType 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 ) const;
- virtual bool SaveFile( const wxString& name, int type ) const;
+ virtual bool SaveFile( const wxString& name, wxBitmapType type ) const;
virtual bool SaveFile( const wxString& name, const wxString& mimetype ) const;
#if wxUSE_STREAMS
- virtual bool SaveFile( wxOutputStream& stream, int type ) const;
+ virtual bool SaveFile( wxOutputStream& stream, wxBitmapType type ) const;
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;
+ // Gets the type of image found by LoadFile or specified with SaveFile
+ wxBitmapType GetType() const;
+
+ // Set the image type, this is normally only called if the image is being
+ // created from data in the given format but not using LoadFile() (e.g.
+ // wxGIFDecoder uses this)
+ void SetType(wxBitmapType type);
+
// 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; }
- 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 );
// Get the current mask colour or find a suitable colour
// 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;
- }
-
- bool operator == (const wxImage& image) const
- { return m_refData == image.m_refData; }
- bool operator != (const wxImage& image) const
- { return m_refData != image.m_refData; }
+ // 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);
static wxList& GetHandlers() { return sm_handlers; }
static void AddHandler( wxImageHandler *handler );
static void InsertHandler( wxImageHandler *handler );
static bool RemoveHandler( const wxString& name );
static wxImageHandler *FindHandler( const wxString& name );
- static wxImageHandler *FindHandler( const wxString& extension, long imageType );
- static wxImageHandler *FindHandler( long imageType );
+ static wxImageHandler *FindHandler( const wxString& extension, wxBitmapType imageType );
+ static wxImageHandler *FindHandler( wxBitmapType imageType );
+
static wxImageHandler *FindHandlerMime( const wxString& mimetype );
static wxString GetImageExtWildcard();
static void CleanUpHandlers();
static void InitStandardHandlers();
+ static HSVValue RGBtoHSV(const RGBValue& rgb);
+ static RGBValue HSVtoRGB(const HSVValue& hsv);
+
+#if WXWIN_COMPATIBILITY_2_8
+ wxDEPRECATED_CONSTRUCTOR(
+ wxImage(const wxString& name, long type, int index = -1)
+ {
+ LoadFile(name, (wxBitmapType)type, index);
+ }
+ )
+
+#if wxUSE_STREAMS
+ wxDEPRECATED_CONSTRUCTOR(
+ wxImage(wxInputStream& stream, long type, int index = -1)
+ {
+ LoadFile(stream, (wxBitmapType)type, index);
+ }
+ )
+
+ wxDEPRECATED(
+ bool LoadFile(wxInputStream& stream, long type, int index = -1)
+ {
+ return LoadFile(stream, (wxBitmapType)type, index);
+ }
+ )
+
+ wxDEPRECATED(
+ bool SaveFile(wxOutputStream& stream, long type) const
+ {
+ return SaveFile(stream, (wxBitmapType)type);
+ }
+ )
+#endif // wxUSE_STREAMS
+
+ wxDEPRECATED(
+ bool LoadFile(const wxString& name, long type, int index = -1)
+ {
+ return LoadFile(name, (wxBitmapType)type, index);
+ }
+ )
+
+ wxDEPRECATED(
+ bool SaveFile(const wxString& name, long type) const
+ {
+ return SaveFile(name, (wxBitmapType)type);
+ }
+ )
+
+ wxDEPRECATED(
+ static wxImageHandler *FindHandler(const wxString& ext, long type)
+ {
+ return FindHandler(ext, (wxBitmapType)type);
+ }
+ )
+
+ wxDEPRECATED(
+ static wxImageHandler *FindHandler(long imageType)
+ {
+ return FindHandler((wxBitmapType)imageType);
+ }
+ )
+#endif // WXWIN_COMPATIBILITY_2_8
+
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;
+
+ virtual wxObjectRefData* CreateRefData() const;
+ virtual wxObjectRefData* CloneRefData(const wxObjectRefData* data) const;
+
private:
- friend class WXDLLEXPORT wxImageHandler;
+ friend class WXDLLIMPEXP_FWD_CORE wxImageHandler;
+
+#if wxUSE_STREAMS
+ // read the image from the specified stream updating image type if
+ // successful
+ bool DoLoad(wxImageHandler& handler, wxInputStream& stream, int index);
+
+ // write the image to the specified stream and also update the image type
+ // if successful
+ bool DoSave(wxImageHandler& handler, wxOutputStream& stream) const;
+#endif // wxUSE_STREAMS
DECLARE_DYNAMIC_CLASS(wxImage)
};
-extern void WXDLLEXPORT wxInitAllImageHandlers();
+extern void WXDLLIMPEXP_CORE wxInitAllImageHandlers();
-extern WXDLLEXPORT_DATA(wxImage) wxNullImage;
+extern WXDLLIMPEXP_DATA_CORE(wxImage) wxNullImage;
//-----------------------------------------------------------------------------
// wxImage handlers
#include "wx/imaggif.h"
#include "wx/imagpcx.h"
#include "wx/imagjpeg.h"
+#include "wx/imagtga.h"
#include "wx/imagtiff.h"
#include "wx/imagpnm.h"
#include "wx/imagxpm.h"
#endif
// _WX_IMAGE_H_
-
projects / wxWidgets.git / blobdiff