document various enumerations defined in defs.h; give a name to the anonymous enum...

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

diff --git a/include/wx/rawbmp.h b/include/wx/rawbmp.h
index d4e9b60d45c7a740d83910c312cfb40fc5cb2e91..d636d586e5b86750605f05f58ba9b6d6e7a82dfd 100644 (file)
--- a/include/wx/rawbmp.h
+++ b/include/wx/rawbmp.h
@@ -9,10 +9,11 @@
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 // 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"
 
 #include "wx/image.h"

+#include "wx/bitmap.h"

 
 // ----------------------------------------------------------------------------
 // Abstract Pixel API
 
 // ----------------------------------------------------------------------------
 // Abstract Pixel API


@@ -72,7 +73,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.
     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.


@@ -164,8 +165,13 @@ typedef wxPixelFormat<unsigned char, 24, 0, 1, 2> wxImagePixelFormat;
 
     #define wxPIXEL_FORMAT_ALPHA 3
 #elif defined(__WXGTK__)
 
     #define wxPIXEL_FORMAT_ALPHA 3
 #elif defined(__WXGTK__)

-    // Under GTK+ 2.X we use GdkPixbuf, which should be RGBA
-    typedef wxPixelFormat<unsigned char, 32, 0, 1, 2> wxNativePixelFormat;
+    // Under GTK+ 2.X we use GdkPixbuf, which is standard RGB or RGBA
+    typedef wxPixelFormat<unsigned char, 24, 0, 1, 2> wxNativePixelFormat;
+
+    #define wxPIXEL_FORMAT_ALPHA 3
+#elif defined(__WXDFB__)
+    // Under DirectFB, RGB components are reversed, they're in BGR order
+    typedef wxPixelFormat<unsigned char, 24, 2, 1, 0> wxNativePixelFormat;

 
     #define wxPIXEL_FORMAT_ALPHA 3
 #endif
 
     #define wxPIXEL_FORMAT_ALPHA 3
 #endif


@@ -304,7 +310,7 @@ struct wxPixelDataOut<wxImage>
             typedef wxImagePixelFormat PixelFormat;
 
             // the type of the pixel components
             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
 
             // the pixel data we're working with
             typedef


@@ -400,12 +406,20 @@ struct wxPixelDataOut<wxImage>
             // data access
             // -----------
 
             // 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; }
 
             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
         // private: -- see comment in the beginning of the file
 
             // pointer into RGB buffer


@@ -420,7 +434,7 @@ struct wxPixelDataOut<wxImage>
         {
             m_width = image.GetWidth();
             m_height = image.GetHeight();
         {
             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
         }
 
         // initializes us with the given region of the specified image


@@ -428,7 +442,7 @@ struct wxPixelDataOut<wxImage>
                       const wxPoint& pt,
                       const wxSize& sz) : m_image(image), m_pixels(image)
         {
                       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);
         }
 
             InitRect(pt, sz);
         }


@@ -437,7 +451,7 @@ struct wxPixelDataOut<wxImage>
         wxPixelDataIn(ImageType& image,
                       const wxRect& rect) : m_image(image), m_pixels(image)
         {
         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());
         }
 
             InitRect(rect.GetPosition(), rect.GetSize());
         }


@@ -525,7 +539,7 @@ struct wxPixelDataOut<wxBitmap>
             {
                 m_ptr = NULL;
             }
             {
                 m_ptr = NULL;
             }

-            
+

             // return true if this iterator is valid
             bool IsOk() const { return m_ptr != NULL; }
 
             // return true if this iterator is valid
             bool IsOk() const { return m_ptr != NULL; }
 


@@ -590,6 +604,10 @@ struct wxPixelDataOut<wxBitmap>
             // address the pixel contents directly
             //
             // warning: the format is platform dependent
             // 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; }
 
             typename PixelFormat::PixelType& Data()
                 { return *(typename PixelFormat::PixelType *)m_ptr; }
 


@@ -631,11 +649,22 @@ struct wxPixelDataOut<wxBitmap>
         // dtor unlocks the bitmap
         ~wxPixelDataIn()
         {
         // 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
 
 
     // private: -- see comment in the beginning of the file
 


@@ -656,9 +685,21 @@ struct wxPixelDataOut<wxBitmap>
         }
     };
 };
         }
     };
 };

+

 #endif //wxUSE_GUI
 
 #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>
 {
 class wxPixelData :
     public wxPixelDataOut<Image>::template wxPixelDataIn<PixelFormat>
 {


@@ -677,7 +718,6 @@ public:
     }
 };
 
     }
 };
 

-

 // some "predefined" pixel data classes
 #if wxUSE_IMAGE
 typedef wxPixelData<wxImage> wxImagePixelData;
 // some "predefined" pixel data classes
 #if wxUSE_IMAGE
 typedef wxPixelData<wxImage> wxImagePixelData;


@@ -709,5 +749,4 @@ struct wxPixelIterator : public wxPixelData<Image, PixelFormat>::Iterator
 {
 };
 
 {
 };
 

-#endif // _WX_RAWBMP_H_BASE_
-
+#endif // _WX_RAWBMP_H_