GOB: Add a new class Surface

This will be the new class managing all drawing, providing
depth-agnostic methods for all drawing operations, including 2
iterator-like classes, Pixel and ConstPixel.

svn-id: r52946

1 files changed, 131 insertions, 0 deletions

diff --git a/engines/gob/surface.h b/engines/gob/surface.h
new file mode 100644
index 0000000000..625462e2b7
--- /dev/null
+++ b/engines/gob/surface.h
@@ -0,0 +1,131 @@
+/* ScummVM - Graphic Adventure Engine
+ *
+ * ScummVM is the legal property of its developers, whose names
+ * are too numerous to list here. Please refer to the COPYRIGHT
+ * file distributed with this source distribution.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+
+ * This program 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 General Public License for more details.
+
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ *
+ * $URL$
+ * $Id$
+ *
+ */
+
+#ifndef GOB_SURFACE_H
+#define GOB_SURFACE_H
+
+#include "common/scummsys.h"
+#include "common/ptr.h"
+#include "common/rational.h"
+
+namespace Gob {
+
+/** An iterator over a surface's image data, automatically handles different color depths. */
+class Pixel {
+public:
+	Pixel(byte *vidMem, uint8 bpp);
+
+	Pixel &operator++();
+	Pixel operator++(int x);
+
+	Pixel &operator--();
+	Pixel operator--(int x);
+
+	Pixel &operator+=(int x);
+	Pixel &operator-=(int x);
+
+	uint32 get() const;
+	void set(uint32 p);
+
+private:
+	byte *_vidMem;
+	uint8 _bpp;
+};
+
+/** A const iterator over a surface's image data, automatically handles different color depths. */
+class ConstPixel {
+public:
+	ConstPixel(const byte *vidMem, uint8 bpp);
+
+	ConstPixel &operator++();
+	ConstPixel operator++(int x);
+
+	ConstPixel &operator--();
+	ConstPixel operator--(int x);
+
+	ConstPixel &operator+=(int x);
+	ConstPixel &operator-=(int x);
+
+	uint32 get() const;
+
+private:
+	const byte *_vidMem;
+	uint8 _bpp;
+};
+
+class Surface {
+public:
+	Surface(uint16 width, uint16 height, uint8 bpp, byte *vidMem = 0);
+	~Surface();
+
+	uint16 getWidth () const;
+	uint16 getHeight() const;
+	uint16 getBPP   () const;
+
+	byte *getData(uint16 x = 0, uint16 y = 0);
+	const byte *getData(uint16 x = 0, uint16 y = 0) const;
+
+	void resize(uint16 width, uint16 height);
+
+	Pixel get(uint16 x = 0, uint16 y = 0);
+	ConstPixel get(uint16 x = 0, uint16 y = 0) const;
+
+	void blit(const Surface &from, int16 left, int16 top, int16 right, int16 bottom,
+	          int16 x, int16 y, int16 transp = -1);
+	void blit(const Surface &from, int16 x, int16 y, int16 transp = -1);
+	void blit(const Surface &from, int16 transp = -1);
+
+	void blitScaled(const Surface &from, int16 left, int16 top, int16 right, int16 bottom,
+	                int16 x, int16 y, Common::Rational scale, int16 transp = -1);
+	void blitScaled(const Surface &from, int16 x, int16 y, Common::Rational scale, int16 transp = -1);
+	void blitScaled(const Surface &from, Common::Rational scale, int16 transp = -1);
+
+	void fillRect(uint16 left, uint16 top, uint16 right, uint16 bottom, uint32 color);
+	void fill(uint32 color);
+	void clear();
+
+	void putPixel(uint16 x, uint16 y, uint32 color);
+	void drawLine(uint16 x0, uint16 y0, uint16 x1, uint16 y1, uint32 color);
+	void drawCircle(uint16 x0, uint16 y0, uint16 radius, uint32 color, int16 pattern = 0);
+
+	void blitToScreen(uint16 left, uint16 top, uint16 right, uint16 bottom, uint16 x, uint16 y) const;
+
+private:
+	uint16 _width;
+	uint16 _height;
+	uint8  _bpp;
+
+	bool  _ownVidMem;
+	byte *_vidMem;
+
+	static bool clipBlitRect(int16 &left, int16 &top, int16 &right, int16 &bottom, int16 &x, int16 &y,
+	                         uint16 dWidth, uint16 dHeight, uint16 sWidth, uint16 sHeight);
+};
+
+typedef Common::SharedPtr<Surface> SurfacePtr;
+
+} // End of namespace Gob
+
+#endif // GOB_SURFACE_H