INTEGRATION: CWS canvas02 (1.1.2); FILE ADDED

2005/10/11 15:40:45 thb 1.1.2.4: #i54170# Corrected license headers
2005/09/29 09:47:09 mbu 1.1.2.3: icolorbuffer now enforces locking instead of getBuffer()
2005/08/04 21:42:07 thb 1.1.2.2: #i48939# Added clear() method to Bitmap; moved buffer format to IColorBuffer
2005/08/02 14:00:17 thb 1.1.2.1: Initial revision

1 files changed, 104 insertions, 0 deletions

diff --git a/canvas/inc/canvas/rendering/icolorbuffer.hxx b/canvas/inc/canvas/rendering/icolorbuffer.hxx
new file mode 100644
index 000000000000..dd578378c8f6
--- /dev/null
+++ b/canvas/inc/canvas/rendering/icolorbuffer.hxx
@@ -0,0 +1,104 @@
+/*************************************************************************
+ *
+ *  OpenOffice.org - a multi-platform office productivity suite
+ *
+ *  $RCSfile: icolorbuffer.hxx,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: kz $ $Date: 2005-11-02 12:45:07 $
+ *
+ *  The Contents of this file are made available subject to
+ *  the terms of GNU Lesser General Public License Version 2.1.
+ *
+ *
+ *    GNU Lesser General Public License Version 2.1
+ *    =============================================
+ *    Copyright 2005 by Sun Microsystems, Inc.
+ *    901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ *    This library is free software; you can redistribute it and/or
+ *    modify it under the terms of the GNU Lesser General Public
+ *    License version 2.1, as published by the Free Software Foundation.
+ *
+ *    This library is distributed in the hope that it will be useful,
+ *    but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ *    Lesser General Public License for more details.
+ *
+ *    You should have received a copy of the GNU Lesser General Public
+ *    License along with this library; if not, write to the Free Software
+ *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *    MA  02111-1307  USA
+ *
+ ************************************************************************/
+
+#ifndef INCLUDED_CANVAS_ICOLORBUFFER_HXX
+#define INCLUDED_CANVAS_ICOLORBUFFER_HXX
+
+#ifndef _SAL_TYPES_H_
+#include <sal/types.h>
+#endif
+
+#include <boost/shared_ptr.hpp>
+
+
+namespace canvas
+{
+    /** Interface for a raw memory pixel container
+
+        Use this interface to represent a surface of raw pixel (e.g. a
+        bitmap) to the canvas rendering framework.
+     */
+    struct IColorBuffer
+    {
+        /// The underlying pixel format for this buffer
+        enum Format
+        {
+            // 24-bit RGB pixel format, 8 bits per channel.
+            FMT_R8G8B8,
+
+            // 32-bit ARGB pixel format with alpha, 8 bits per channel.
+            FMT_A8R8G8B8,
+
+            // 32-bit RGB pixel format, 8 bits per channel.
+            FMT_X8R8G8B8,
+
+            // for enum to 32bit
+            FMT_UNKNOWN = static_cast<sal_uInt32>(-1)
+        };
+
+        virtual ~IColorBuffer() {}
+
+        /** Get a pointer to the raw memory bits of the pixel
+         */
+        virtual sal_uInt8* lock() const = 0;
+
+        /** unlock previous locked buffer
+        */
+        virtual void unlock() const = 0;
+
+        /** Get width in pixel
+         */
+        virtual sal_uInt32 getWidth() const = 0;
+
+        /** Get height in pixel
+         */
+        virtual sal_uInt32 getHeight() const = 0;
+
+        /** Offset, in bytes, between consecutive scan lines of the bitmap.
+            If the stride is positive, the bitmap is top-down.
+            If the stride is negative, the bitmap is bottom-up.
+            The returned value is only valid while the buffer is locked.
+         */
+        virtual sal_uInt32 getStride() const = 0;
+
+        /** Get format of the color buffer
+         */
+        virtual Format getFormat() const = 0;
+    };
+
+    typedef ::boost::shared_ptr< IColorBuffer > IColorBufferSharedPtr;
+}
+
+#endif /* INCLUDED_CANVAS_ICOLORBUFFER_HXX */