More parameter variable names fixed to make them more readable by replacing abbreviat...

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

diff --git a/include/wx/rawbmp.h b/include/wx/rawbmp.h
index e5d03d0a6dc8804e749d74d5c64aba5b068c83eb..91a29f6f1906c2734233300d137fb8b6bff7c341 100644 (file)
--- a/include/wx/rawbmp.h
+++ b/include/wx/rawbmp.h
@@ -5,13 +5,15 @@
 // Modified by:
 // Created:     10.03.03
 // RCS-ID:      $Id$
 // Modified by:
 // Created:     10.03.03
 // RCS-ID:      $Id$

-// Copyright:   (c) 2002 Vadim Zeitlin <vadim@wxwindows.org>
+// Copyright:   (c) 2002 Vadim Zeitlin <vadim@wxwidgets.org>

 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_RAWBMP_H_BASE_
 #define _WX_RAWBMP_H_BASE_
 
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_RAWBMP_H_BASE_
 #define _WX_RAWBMP_H_BASE_
 

+#include "wx/image.h"
+

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


@@ -100,9 +102,11 @@
         - index of the alpha component or -1 if none
         - type which can contain the full pixel value (all channels)
  */
         - index of the alpha component or -1 if none
         - type which can contain the full pixel value (all channels)
  */

-template <typename Channel,
+
+template <class Channel,

           size_t Bpp, int R, int G, int B, int A = -1,
           size_t Bpp, int R, int G, int B, int A = -1,

-          typename Pixel = wxUint32>
+          class Pixel = wxUint32>
+

 struct WXDLLEXPORT wxPixelFormat
 {
     // iterator over pixels is usually of type "ChannelType *"
 struct WXDLLEXPORT wxPixelFormat
 {
     // iterator over pixels is usually of type "ChannelType *"


@@ -118,7 +122,7 @@ struct WXDLLEXPORT wxPixelFormat
     enum { BitsPerPixel = Bpp };
 
     // size of one pixel in ChannelType units (usually bytes)
     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
 
     // the channels indices inside the pixel
     enum


@@ -141,25 +145,38 @@ struct WXDLLEXPORT wxPixelFormat
 typedef wxPixelFormat<unsigned char, 24, 0, 1, 2> wxImagePixelFormat;
 
 // the (most common) native bitmap format without alpha support
 typedef wxPixelFormat<unsigned char, 24, 0, 1, 2> wxImagePixelFormat;
 
 // the (most common) native bitmap format without alpha support

-typedef wxPixelFormat<unsigned char, 24,
-                      #ifdef __WXMSW__
-                                2, 1, 0
-                      #else // !__WXMSW__
-                                0, 1, 2
-                      #endif // __WXMSW__/!__WXMSW__
-                     > wxNativePixelFormat;
+#if defined(__WXMSW__)
+    // under MSW the RGB components are inversed, they're in BGR order
+    typedef wxPixelFormat<unsigned char, 24, 2, 1, 0> 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<unsigned char, 32, 1, 2, 3> wxNativePixelFormat;
+
+    #define wxPIXEL_FORMAT_ALPHA 0
+#elif defined(__WXCOCOA__)
+    // Cocoa is standard RGB or RGBA (normally it is RGBA)
+    typedef wxPixelFormat<unsigned char, 24, 0, 1, 2> wxNativePixelFormat;
+
+    #define wxPIXEL_FORMAT_ALPHA 3
+#endif

 
 // the (most common) native format for bitmaps with alpha channel
 
 // the (most common) native format for bitmaps with alpha channel

-typedef wxPixelFormat<unsigned char, 32,
-                      wxNativePixelFormat::RED,
-                      wxNativePixelFormat::GREEN,
-                      wxNativePixelFormat::BLUE,
-                      3> wxAlphaPixelFormat;
+#ifdef wxPIXEL_FORMAT_ALPHA
+    typedef wxPixelFormat<unsigned char, 32,
+                          wxNativePixelFormat::RED,
+                          wxNativePixelFormat::GREEN,
+                          wxNativePixelFormat::BLUE,
+                          wxPIXEL_FORMAT_ALPHA> 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 <class T> struct wxPixelFormatFor;
 
 
 // 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 <class T> 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
 // 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


@@ -168,6 +185,7 @@ struct WXDLLEXPORT wxPixelFormatFor<wxImage>
 {
     typedef wxImagePixelFormat Format;
 };
 {
     typedef wxImagePixelFormat Format;
 };

+#endif //wxUSE_IMAGE

 
 // ----------------------------------------------------------------------------
 // wxPixelData
 
 // ----------------------------------------------------------------------------
 // wxPixelData


@@ -187,6 +205,8 @@ public:
     int GetWidth() const { return m_width; }
     int GetHeight() const { return m_height; }
 
     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; }
 
     // the distance between two rows
     int GetRowStride() const { return m_stride; }
 


@@ -253,6 +273,7 @@ struct WXDLLEXPORT wxPixelDataOut
     };
 };
 
     };
 };
 

+#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 <>
 // wxPixelData specialization for wxImage: this is the simplest case as we
 // don't have to care about different pixel formats here
 template <>


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


@@ -320,7 +341,7 @@ struct WXDLLEXPORT wxPixelDataOut<wxImage>
             {
                 m_pRGB += PixelFormat::SizePixel;
                 if ( m_pAlpha )
             {
                 m_pRGB += PixelFormat::SizePixel;
                 if ( m_pAlpha )

-                    m_pAlpha += PixelFormat::SizePixel;
+                    ++m_pAlpha;

 
                 return *this;
             }
 
                 return *this;
             }


@@ -372,9 +393,9 @@ struct WXDLLEXPORT wxPixelDataOut<wxImage>
             // -----------
 
             // access to invidividual colour components
             // -----------
 
             // 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
             ChannelType& Alpha() { return *m_pAlpha; }
 
         // private: -- see comment in the beginning of the file


@@ -410,7 +431,7 @@ struct WXDLLEXPORT wxPixelDataOut<wxImage>
         {
             m_stride = Iterator::SizePixel * m_width;
 
         {
             m_stride = Iterator::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
         }
 
         // we evaluate to true only if we could get access to bitmap data


@@ -437,7 +458,9 @@ struct WXDLLEXPORT wxPixelDataOut<wxImage>
         Iterator m_pixels;
     };
 };
         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 <>
 // wxPixelData specialization for wxBitmap: here things are more interesting as
 // we also have to support different pixel formats
 template <>


@@ -450,7 +473,7 @@ struct WXDLLEXPORT wxPixelDataOut<wxBitmap>
         // the type of the class we're working with
         typedef wxBitmap ImageType;
 
         // the type of the class we're working with
         typedef wxBitmap ImageType;
 

-        class Iterator
+        class WXDLLEXPORT Iterator

         {
         public:
             // the pixel format we use
         {
         public:
             // the pixel format we use


@@ -558,10 +581,9 @@ struct WXDLLEXPORT wxPixelDataOut<wxBitmap>
 
         // private: -- see comment in the beginning of the file
 
 
         // 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;
         };
 
             ChannelType *m_ptr;
         };
 


@@ -576,7 +598,7 @@ struct WXDLLEXPORT wxPixelDataOut<wxBitmap>
         wxPixelDataIn(wxBitmap& bmp, const wxRect& rect)
             : m_bmp(bmp), m_pixels(bmp, *this)
         {
         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)
         }
 
         wxPixelDataIn(wxBitmap& bmp, const wxPoint& pt, const wxSize& sz)


@@ -620,32 +642,44 @@ struct WXDLLEXPORT wxPixelDataOut<wxBitmap>
         }
     };
 };
         }
     };
 };

+#endif //wxUSE_GUI
+
+#ifdef __VISUALC__
+    // typedef-name 'foo' used as synonym for class-name 'bar'
+    // (VC++ gives this warning each time wxPixelData::Base is used but it
+    //  doesn't make any sense here -- what's wrong with using typedef instead
+    //  of class, this is what it is here for!)
+    #pragma warning(disable: 4097)
+#endif // __VISUALC__

 
 template <class Image, class PixelFormat = wxPixelFormatFor<Image> >
 class wxPixelData :
     public wxPixelDataOut<Image>::template wxPixelDataIn<PixelFormat>
 {
 public:
 
 template <class Image, class PixelFormat = wxPixelFormatFor<Image> >
 class wxPixelData :
     public wxPixelDataOut<Image>::template wxPixelDataIn<PixelFormat>
 {
 public:

-    wxPixelData(Image& image)
-        : wxPixelDataOut<Image>::template wxPixelDataIn<PixelFormat>(image)
-        {
-        }
+    typedef
+        typename wxPixelDataOut<Image>::template wxPixelDataIn<PixelFormat>
+        Base;

 
 

-    wxPixelData(Image& i, const wxPoint& pt, const wxSize& sz)
-        : wxPixelDataOut<Image>::template wxPixelDataIn<PixelFormat>(i, pt, sz)
-        {
-        }
+    wxPixelData(Image& image) : Base(image) { }

 
 

-    wxPixelData(Image& i, const wxRect& rect)
-        : wxPixelDataOut<Image>::template wxPixelDataIn<PixelFormat>(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
 // some "predefined" pixel data classes

+#if wxUSE_IMAGE

 typedef wxPixelData<wxImage> wxImagePixelData;
 typedef wxPixelData<wxImage> wxImagePixelData;

+#endif //wxUSE_IMAGE
+#if wxUSE_GUI

 typedef wxPixelData<wxBitmap, wxNativePixelFormat> wxNativePixelData;
 typedef wxPixelData<wxBitmap, wxAlphaPixelFormat> wxAlphaPixelData;
 typedef wxPixelData<wxBitmap, wxNativePixelFormat> wxNativePixelData;
 typedef wxPixelData<wxBitmap, wxAlphaPixelFormat> wxAlphaPixelData;

+#endif //wxUSE_GUI

 
 // ----------------------------------------------------------------------------
 // wxPixelIterator
 
 // ----------------------------------------------------------------------------
 // wxPixelIterator


@@ -670,6 +704,7 @@ struct WXDLLEXPORT wxPixelIterator : wxPixelData<Image, PixelFormat>::Iterator
 
 #ifdef __VISUALC__
     #pragma warning(default: 4355)
 
 #ifdef __VISUALC__
     #pragma warning(default: 4355)

+    #pragma warning(default: 4097)

 #endif
 
 #endif // _WX_RAWBMP_H_BASE_
 #endif
 
 #endif // _WX_RAWBMP_H_BASE_