X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/e6c13db6ec2e73fea944771e0f318e9baa337f29..db5a2bff58b2dadd6c657afa57e0e723b9cab71d:/include/wx/rawbmp.h diff --git a/include/wx/rawbmp.h b/include/wx/rawbmp.h index 2d43d81e29..0f25a78252 100644 --- a/include/wx/rawbmp.h +++ b/include/wx/rawbmp.h @@ -5,12 +5,19 @@ // 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/defs.h" + +#ifdef wxHAS_RAW_BITMAP + +#include "wx/image.h" +#include "wx/bitmap.h" // ---------------------------------------------------------------------------- // Abstract Pixel API @@ -69,10 +76,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 WXDLLIMPEXP_CORE 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 +109,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 +129,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 +152,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,7 +212,7 @@ 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 @@ -187,6 +222,8 @@ public: 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; } @@ -243,26 +280,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 + class wxPixelDataIn : public wxPixelDataBase { + public: // the type of the class we're working with typedef wxImage ImageType; @@ -275,7 +314,7 @@ struct WXDLLEXPORT wxPixelDataOut typedef wxImagePixelFormat PixelFormat; // the type of the pixel components - typedef typename dummyPixelFormat::ChannelType ChannelType; + typedef typename PixelFormat::ChannelType ChannelType; // the pixel data we're working with typedef @@ -320,7 +359,7 @@ struct WXDLLEXPORT wxPixelDataOut { m_pRGB += PixelFormat::SizePixel; if ( m_pAlpha ) - m_pAlpha += PixelFormat::SizePixel; + ++m_pAlpha; return *this; } @@ -371,12 +410,20 @@ struct WXDLLEXPORT wxPixelDataOut // data access // ----------- - // 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]; } + // access to individual colour components + 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; } + // address the pixel contents directly (always RGB, without alpha) + // + // this can't be used to modify the image as assigning a 32bpp + // value to 24bpp pixel would overwrite an extra byte in the next + // pixel or beyond the end of image + const typename PixelFormat::PixelType& Data() + { return *(typename PixelFormat::PixelType *)m_pRGB; } + // private: -- see comment in the beginning of the file // pointer into RGB buffer @@ -391,7 +438,7 @@ struct WXDLLEXPORT wxPixelDataOut { m_width = image.GetWidth(); m_height = image.GetHeight(); - m_stride = Iterator::SizePixel * m_width; + m_stride = Iterator::PixelFormat::SizePixel * m_width; } // initializes us with the given region of the specified image @@ -399,7 +446,7 @@ struct WXDLLEXPORT wxPixelDataOut const wxPoint& pt, const wxSize& sz) : m_image(image), m_pixels(image) { - m_stride = Iterator::SizePixel * m_width; + m_stride = Iterator::PixelFormat::SizePixel * m_width; InitRect(pt, sz); } @@ -408,9 +455,9 @@ struct WXDLLEXPORT wxPixelDataOut wxPixelDataIn(ImageType& image, const wxRect& rect) : m_image(image), m_pixels(image) { - m_stride = Iterator::SizePixel * m_width; + m_stride = Iterator::PixelFormat::SizePixel * m_width; - InitRect(rect.GetPositions(), rect.GetSize()); + InitRect(rect.GetPosition(), rect.GetSize()); } // we evaluate to true only if we could get access to bitmap data @@ -437,14 +484,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 @@ -489,6 +538,12 @@ struct WXDLLEXPORT wxPixelDataOut 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; } @@ -553,15 +608,18 @@ struct WXDLLEXPORT wxPixelDataOut // address the pixel contents directly // // warning: the format is platform dependent + // + // warning 2: assigning to Data() only works correctly for 16bpp or + // 32bpp formats but using it for 24bpp ones overwrites + // one extra byte and so can't be done typename PixelFormat::PixelType& Data() { return *(typename PixelFormat::PixelType *)m_ptr; } // 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; }; @@ -576,7 +634,7 @@ struct WXDLLEXPORT wxPixelDataOut wxPixelDataIn(wxBitmap& bmp, const wxRect& rect) : m_bmp(bmp), m_pixels(bmp, *this) { - InitRect(rect.GetPositions(), rect.GetSize()); + InitRect(rect.GetPosition(), rect.GetSize()); } wxPixelDataIn(wxBitmap& bmp, const wxPoint& pt, const wxSize& sz) @@ -595,11 +653,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(), wxEMPTY_PARAMETER_VALUE ) +#endif // private: -- see comment in the beginning of the file @@ -621,32 +690,48 @@ struct WXDLLEXPORT wxPixelDataOut }; }; -template > +#endif //wxUSE_GUI + +// FIXME-VC6: VC6 doesn't like typename in default template parameters while +// it is necessary with standard-conforming compilers, remove this +// #define and just use typename when we drop VC6 support +#if defined(__VISUALC__) && !wxCHECK_VISUALC_VERSION(7) + #define wxTYPENAME_IN_TEMPLATE_DEFAULT_PARAM +#else + #define wxTYPENAME_IN_TEMPLATE_DEFAULT_PARAM typename +#endif + +template ::Format > class wxPixelData : public wxPixelDataOut::template wxPixelDataIn { public: - wxPixelData(Image& image) - : wxPixelDataOut::template wxPixelDataIn(image) - { - } + typedef + typename wxPixelDataOut::template wxPixelDataIn + Base; - wxPixelData(Image& i, const wxPoint& pt, const wxSize& sz) - : wxPixelDataOut::template wxPixelDataIn(i, pt, sz) - { - } + wxPixelData(Image& image) : Base(image) { } - wxPixelData(Image& i, const wxRect& rect) - : wxPixelDataOut::template wxPixelDataIn(i, rect) - { - } + wxPixelData(Image& i, const wxRect& rect) : Base(i, rect) { } + + wxPixelData(Image& i, const wxPoint& pt, const wxSize& sz) + : Base(i, pt, sz) + { + } }; // 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 // ---------------------------------------------------------------------------- @@ -664,13 +749,9 @@ 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 // wxHAS_RAW_BITMAP +#endif // _WX_RAWBMP_H_