Don't always override the default background colours.

[wxWidgets.git] / include / wx / rawbmp.h

diff --git a/include/wx/rawbmp.h b/include/wx/rawbmp.h
index 1fdbdcaff71b3405ccd01b277d6602d91c88160a..0f25a78252918fd134ac7479d98b60de2b1f5443 100644 (file)
--- a/include/wx/rawbmp.h
+++ b/include/wx/rawbmp.h
@@ -12,7 +12,12 @@
 #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
@@ -72,7 +77,7 @@
  */
 
 /*
-    Note: we do not use WXDLLEXPORT with classes in this file because VC++ has
+    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.
@@ -309,7 +314,7 @@ struct wxPixelDataOut<wxImage>
             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
@@ -405,12 +410,20 @@ struct wxPixelDataOut<wxImage>
             // data access
             // -----------
 
-            // access to invidividual colour components
+            // 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
@@ -425,7 +438,7 @@ struct wxPixelDataOut<wxImage>
         {
             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
@@ -433,7 +446,7 @@ struct wxPixelDataOut<wxImage>
                       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);
         }
@@ -442,7 +455,7 @@ struct wxPixelDataOut<wxImage>
         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.GetPosition(), rect.GetSize());
         }
@@ -595,6 +608,10 @@ struct wxPixelDataOut<wxBitmap>
             // 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; }
 
@@ -650,7 +667,7 @@ struct wxPixelDataOut<wxBitmap>
 
 #if WXWIN_COMPATIBILITY_2_8
         // not needed anymore, calls to it should be simply removed
-        wxDEPRECATED_INLINE( void UseAlpha(), wxEMPTY_PARAMETER_VALUE );
+        wxDEPRECATED_INLINE( void UseAlpha(), wxEMPTY_PARAMETER_VALUE )
 #endif
 
     // private: -- see comment in the beginning of the file
@@ -675,7 +692,18 @@ struct wxPixelDataOut<wxBitmap>
 
 #endif //wxUSE_GUI
 
-template <class Image, class PixelFormat = wxPixelFormatFor<Image> >
+// 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 <class Image,
+          class PixelFormat = wxTYPENAME_IN_TEMPLATE_DEFAULT_PARAM
+                                wxPixelFormatFor<Image>::Format >
 class wxPixelData :
     public wxPixelDataOut<Image>::template wxPixelDataIn<PixelFormat>
 {
@@ -725,4 +753,5 @@ struct wxPixelIterator : public wxPixelData<Image, PixelFormat>::Iterator
 {
 };
 
+#endif // wxHAS_RAW_BITMAP
 #endif // _WX_RAWBMP_H_