X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/b9bcaf117a45df3088e6cfad17941585dcbef3a5..a4535b9f391bbe8453f70784bc77a06f3426e858:/include/wx/rawbmp.h diff --git a/include/wx/rawbmp.h b/include/wx/rawbmp.h index 7967318a03..377836fc99 100644 --- a/include/wx/rawbmp.h +++ b/include/wx/rawbmp.h @@ -5,12 +5,14 @@ // Modified by: // Created: 10.03.03 // RCS-ID: $Id$ -// Copyright: (c) 2002 Vadim Zeitlin +// Copyright: (c) 2002 Vadim Zeitlin // Licence: wxWindows licence /////////////////////////////////////////////////////////////////////////////// -#ifndef _WX_RAWBMP_H_BASE_ -#define _WX_RAWBMP_H_BASE_ +#ifndef _WX_RAWBMP_H_ +#define _WX_RAWBMP_H_ + +#include "wx/image.h" // ---------------------------------------------------------------------------- // Abstract Pixel API @@ -69,10 +71,12 @@ } */ -#ifdef __VISUALC__ - // VC++ gives an absolutely harmless warning for wxPixelData ctor - #pragma warning(disable: 4355) // 'this' used in initializer list -#endif +/* + Note: we do not use WXDLLEXPORT with classes in this file because VC++ has + problems with exporting inner class defined inside a specialization of a + template class from a DLL. Besides, as all the methods are inline it's not + really necessary to put them in DLL at all. + */ // ---------------------------------------------------------------------------- // wxPixelFormat @@ -100,10 +104,12 @@ - index of the alpha component or -1 if none - type which can contain the full pixel value (all channels) */ -template -struct WXDLLEXPORT wxPixelFormat + class Pixel = wxUint32> + +struct wxPixelFormat { // iterator over pixels is usually of type "ChannelType *" typedef Channel ChannelType; @@ -118,7 +124,7 @@ struct WXDLLEXPORT wxPixelFormat enum { BitsPerPixel = Bpp }; // size of one pixel in ChannelType units (usually bytes) - enum { SizePixel = BitsPerPixel / (8 * sizeof(ChannelType)) }; + enum { SizePixel = Bpp / (8 * sizeof(Channel)) }; // the channels indices inside the pixel enum @@ -141,33 +147,57 @@ struct WXDLLEXPORT wxPixelFormat typedef wxPixelFormat wxImagePixelFormat; // the (most common) native bitmap format without alpha support -typedef wxPixelFormat wxNativePixelFormat; +#if defined(__WXMSW__) + // under MSW the RGB components are reversed, they're in BGR order + typedef wxPixelFormat wxNativePixelFormat; + + #define wxPIXEL_FORMAT_ALPHA 3 +#elif defined(__WXMAC__) + // under Mac, first component is unused but still present, hence we use + // 32bpp, not 24 + typedef wxPixelFormat wxNativePixelFormat; + + #define wxPIXEL_FORMAT_ALPHA 0 +#elif defined(__WXCOCOA__) + // Cocoa is standard RGB or RGBA (normally it is RGBA) + typedef wxPixelFormat wxNativePixelFormat; + + #define wxPIXEL_FORMAT_ALPHA 3 +#elif defined(__WXGTK__) + // Under GTK+ 2.X we use GdkPixbuf, which is standard RGB or RGBA + typedef wxPixelFormat wxNativePixelFormat; + + #define wxPIXEL_FORMAT_ALPHA 3 +#elif defined(__WXDFB__) + // Under DirectFB, RGB components are reversed, they're in BGR order + typedef wxPixelFormat wxNativePixelFormat; + + #define wxPIXEL_FORMAT_ALPHA 3 +#endif // the (most common) native format for bitmaps with alpha channel -typedef wxPixelFormat wxAlphaPixelFormat; +#ifdef wxPIXEL_FORMAT_ALPHA + typedef wxPixelFormat wxAlphaPixelFormat; +#endif // wxPIXEL_FORMAT_ALPHA // we also define the (default/best) pixel format for the given class: this is // used as default value for the pixel format in wxPixelIterator template template struct wxPixelFormatFor; +#if wxUSE_IMAGE // wxPixelFormatFor is only defined for wxImage, attempt to use it with other // classes (wxBitmap...) will result in compile errors which is exactly what we // want template <> -struct WXDLLEXPORT wxPixelFormatFor +struct wxPixelFormatFor { typedef wxImagePixelFormat Format; }; +#endif //wxUSE_IMAGE // ---------------------------------------------------------------------------- // wxPixelData @@ -177,15 +207,26 @@ struct WXDLLEXPORT wxPixelFormatFor wxPixelDataBase is just a helper for wxPixelData: it contains things common to both wxImage and wxBitmap specializations. */ -class WXDLLEXPORT wxPixelDataBase +class wxPixelDataBase { public: + // origin of the rectangular region we represent + wxPoint GetOrigin() const { return m_ptOrigin; } + + // width and height of the region we represent int GetWidth() const { return m_width; } int GetHeight() const { return m_height; } + + wxSize GetSize() const { return wxSize(m_width, m_height); } + + // the distance between two rows int GetRowStride() const { return m_stride; } // private: -- see comment in the beginning of the file + // the origin of this image inside the bigger bitmap (usually (0, 0)) + wxPoint m_ptOrigin; + // the size of the image we address, in pixels int m_width, m_height; @@ -234,26 +275,28 @@ protected: // we need to define this skeleton template to mollify VC++ template -struct WXDLLEXPORT wxPixelDataOut +struct wxPixelDataOut { template - class WXDLLEXPORT wxPixelDataIn + class wxPixelDataIn { public: class Iterator { }; }; }; +#if wxUSE_IMAGE // wxPixelData specialization for wxImage: this is the simplest case as we // don't have to care about different pixel formats here template <> -struct WXDLLEXPORT wxPixelDataOut +struct wxPixelDataOut { // NB: this is a template class even though it doesn't use its template // parameter because otherwise wxPixelData couldn't compile - template - class WXDLLEXPORT wxPixelDataIn : public wxPixelDataBase + template + class wxPixelDataIn : public wxPixelDataBase { + public: // the type of the class we're working with typedef wxImage ImageType; @@ -266,7 +309,7 @@ struct WXDLLEXPORT wxPixelDataOut typedef wxImagePixelFormat PixelFormat; // the type of the pixel components - typedef typename PixelFormat::ChannelType ChannelType; + typedef typename dummyPixelFormat::ChannelType ChannelType; // the pixel data we're working with typedef @@ -311,12 +354,13 @@ struct WXDLLEXPORT wxPixelDataOut { m_pRGB += PixelFormat::SizePixel; if ( m_pAlpha ) - m_pAlpha += PixelFormat::SizePixel; + ++m_pAlpha; return *this; } - // postfix (hence less efficient -- don't use unless you must) version + // postfix (hence less efficient -- don't use it unless you + // absolutely must) version Iterator operator++(int) { Iterator p(*this); @@ -362,9 +406,9 @@ struct WXDLLEXPORT wxPixelDataOut // ----------- // access to invidividual colour components - ChannelType& Red() { return m_ptr[PixelFormat::RED]; } - ChannelType& Green() { return m_ptr[PixelFormat::GREEN]; } - ChannelType& Blue() { return m_ptr[PixelFormat::BLUE]; } + ChannelType& Red() { return m_pRGB[PixelFormat::RED]; } + ChannelType& Green() { return m_pRGB[PixelFormat::GREEN]; } + ChannelType& Blue() { return m_pRGB[PixelFormat::BLUE]; } ChannelType& Alpha() { return *m_pAlpha; } // private: -- see comment in the beginning of the file @@ -384,6 +428,25 @@ struct WXDLLEXPORT wxPixelDataOut m_stride = Iterator::SizePixel * m_width; } + // initializes us with the given region of the specified image + wxPixelDataIn(ImageType& image, + const wxPoint& pt, + const wxSize& sz) : m_image(image), m_pixels(image) + { + m_stride = Iterator::SizePixel * m_width; + + InitRect(pt, sz); + } + + // initializes us with the given region of the specified image + wxPixelDataIn(ImageType& image, + const wxRect& rect) : m_image(image), m_pixels(image) + { + m_stride = Iterator::SizePixel * m_width; + + InitRect(rect.GetPosition(), rect.GetSize()); + } + // we evaluate to true only if we could get access to bitmap data // successfully operator bool() const { return m_pixels.IsOk(); } @@ -392,6 +455,15 @@ struct WXDLLEXPORT wxPixelDataOut Iterator GetPixels() const { return m_pixels; } private: + void InitRect(const wxPoint& pt, const wxSize& sz) + { + m_width = sz.x; + m_height = sz.y; + + m_ptOrigin = pt; + m_pixels.Offset(*this, pt.x, pt.y); + } + // the image we're working with ImageType& m_image; @@ -399,14 +471,16 @@ struct WXDLLEXPORT wxPixelDataOut Iterator m_pixels; }; }; +#endif //wxUSE_IMAGE +#if wxUSE_GUI // wxPixelData specialization for wxBitmap: here things are more interesting as // we also have to support different pixel formats template <> -struct WXDLLEXPORT wxPixelDataOut +struct wxPixelDataOut { template - class WXDLLEXPORT wxPixelDataIn : public wxPixelDataBase + class wxPixelDataIn : public wxPixelDataBase { public: // the type of the class we're working with @@ -431,25 +505,32 @@ struct WXDLLEXPORT wxPixelDataOut *this = data.GetPixels(); } - // initializes the iterator to point to the origin of the given pixel - // data + // initializes the iterator to point to the origin of the given + // pixel data Iterator(PixelData& data) { Reset(data); } - // initializes the iterator to point to the origin of the given bitmap + // initializes the iterator to point to the origin of the given + // bitmap Iterator(wxBitmap& bmp, PixelData& data) { - // using cast here is ugly but it should be safe as GetRawData() - // real return type should be consistent with BitsPerPixel (which - // is in turn defined by ChannelType) and this is the only thing we - // can do without making GetRawData() a template function which is - // undesirable + // using cast here is ugly but it should be safe as + // GetRawData() real return type should be consistent with + // BitsPerPixel (which is in turn defined by ChannelType) and + // this is the only thing we can do without making GetRawData() + // a template function which is undesirable m_ptr = (ChannelType *) bmp.GetRawData(data, PixelFormat::BitsPerPixel); } + // default constructor + Iterator() + { + m_ptr = NULL; + } + // return true if this iterator is valid bool IsOk() const { return m_ptr != NULL; } @@ -465,7 +546,8 @@ struct WXDLLEXPORT wxPixelDataOut return *this; } - // postfix (hence less efficient -- don't use unless you must) version + // postfix (hence less efficient -- don't use it unless you + // absolutely must) version Iterator operator++(int) { Iterator p(*this); @@ -518,17 +600,30 @@ struct WXDLLEXPORT wxPixelDataOut // private: -- see comment in the beginning of the file - // NB: for efficiency reasons this class must *not* have any other - // fields, otherwise it won't be put into a CPU register (as it - // should inside the inner loops) by some compilers, notably gcc + // for efficiency reasons this class should not have any other + // fields, otherwise it won't be put into a CPU register (as it + // should inside the inner loops) by some compilers, notably gcc ChannelType *m_ptr; }; - // ctor associates this pointer with a bitmap and locks the bitmap for raw - // access, it will be unlocked only by our dtor and so these objects should - // normally be only created on the stack, i.e. have limited life-time - wxPixelDataIn(wxBitmap bmp) : m_bmp(bmp), m_pixels(bmp, *this) + // ctor associates this pointer with a bitmap and locks the bitmap for + // raw access, it will be unlocked only by our dtor and so these + // objects should normally be only created on the stack, i.e. have + // limited life-time + wxPixelDataIn(wxBitmap& bmp) : m_bmp(bmp), m_pixels(bmp, *this) + { + } + + wxPixelDataIn(wxBitmap& bmp, const wxRect& rect) + : m_bmp(bmp), m_pixels(bmp, *this) + { + InitRect(rect.GetPosition(), rect.GetSize()); + } + + wxPixelDataIn(wxBitmap& bmp, const wxPoint& pt, const wxSize& sz) + : m_bmp(bmp), m_pixels(bmp, *this) { + InitRect(pt, sz); } // we evaluate to true only if we could get access to bitmap data @@ -541,11 +636,22 @@ struct WXDLLEXPORT wxPixelDataOut // dtor unlocks the bitmap ~wxPixelDataIn() { - m_bmp.UngetRawData(*this); + if ( m_pixels.IsOk() ) + { +#if defined(__WXMSW__) || defined(__WXMAC__) + // this is a hack to mark wxBitmap as using alpha channel + if ( Format::HasAlpha ) + m_bmp.UseAlpha(); +#endif + m_bmp.UngetRawData(*this); + } + // else: don't call UngetRawData() if GetRawData() failed } - // call this to indicate that we should use the alpha channel - void UseAlpha() { m_bmp.UseAlpha(); } +#if WXWIN_COMPATIBILITY_2_8 + // not needed anymore, calls to it should be simply removed + wxDEPRECATED( inline void UseAlpha() ); +#endif // private: -- see comment in the beginning of the file @@ -554,25 +660,56 @@ struct WXDLLEXPORT wxPixelDataOut // the iterator pointing to the image origin Iterator m_pixels; + + private: + void InitRect(const wxPoint& pt, const wxSize& sz) + { + m_pixels.Offset(*this, pt.x, pt.y); + + m_ptOrigin = pt; + m_width = sz.x; + m_height = sz.y; + } }; }; +#endif //wxUSE_GUI + template > class wxPixelData : public wxPixelDataOut::template wxPixelDataIn { public: - wxPixelData(const Image& image) - : wxPixelDataOut::template wxPixelDataIn(image) - { - } + typedef + typename wxPixelDataOut::template wxPixelDataIn + Base; + + wxPixelData(Image& image) : Base(image) { } + + wxPixelData(Image& i, const wxRect& rect) : Base(i, rect) { } + + wxPixelData(Image& i, const wxPoint& pt, const wxSize& sz) + : Base(i, pt, sz) + { + } }; +#if WXWIN_COMPATIBILITY_2_8 +template +inline void wxPixelDataOut::wxPixelDataIn::UseAlpha() {} +#endif + + // some "predefined" pixel data classes +#if wxUSE_IMAGE typedef wxPixelData wxImagePixelData; +#endif //wxUSE_IMAGE +#if wxUSE_GUI typedef wxPixelData wxNativePixelData; typedef wxPixelData wxAlphaPixelData; +#endif //wxUSE_GUI + // ---------------------------------------------------------------------------- // wxPixelIterator // ---------------------------------------------------------------------------- @@ -590,13 +727,8 @@ typedef wxPixelData wxAlphaPixelData; partial template specialization then and neither VC6 nor VC7 provide it. */ template < class Image, class PixelFormat = wxPixelFormatFor > -struct WXDLLEXPORT wxPixelIterator : wxPixelData::Iterator +struct wxPixelIterator : public wxPixelData::Iterator { }; -#ifdef __VISUALC__ - #pragma warning(default: 4355) -#endif - -#endif // _WX_RAWBMP_H_BASE_ - +#endif // _WX_RAWBMP_H_