/* 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$
*
*/
/*
* This code is based on Broken Sword 2.5 engine
*
* Copyright (c) Malte Thiesen, Daniel Queteschiner and Michael Elsdoerfer
*
* Licensed under GNU GPL v2
*
*/
/*
BS_Image
--------
Autor: Malte Thiesen
*/
#ifndef SWORD25_IMAGE_H
#define SWORD25_IMAGE_H
// Includes
#include "sword25/kernel/common.h"
#include "common/rect.h"
#include "sword25/gfx/graphicengine.h"
namespace Sword25 {
class Image {
public:
virtual ~Image() {};
// Enums
/**
@brief Die möglichen Flippingparameter für die Blit-Methode.
*/
enum FLIP_FLAGS {
/// Das Bild wird nicht gespiegelt.
FLIP_NONE = 0,
/// Das Bild wird an der horizontalen Achse gespiegelt.
FLIP_H = 1,
/// Das Bild wird an der vertikalen Achse gespiegelt.
FLIP_V = 2,
/// Das Bild wird an der horizontalen und vertikalen Achse gespiegelt.
FLIP_HV = FLIP_H | FLIP_V,
/// Das Bild wird an der horizontalen und vertikalen Achse gespiegelt.
FLIP_VH = FLIP_H | FLIP_V
};
//@{
/** @name Accessor-Methoden */
/**
@brief Gibt die Breite des Bildes in Pixeln zurück
*/
virtual int GetWidth() const = 0;
/**
@brief Gibt die Höhe des Bildes in Pixeln zurück
*/
virtual int GetHeight() const = 0;
/**
@brief Gibt das Farbformat des Bildes zurück
*/
virtual GraphicEngine::COLOR_FORMATS GetColorFormat() const = 0;
//@}
//@{
/** @name Render-Methoden */
/**
@brief Rendert das Bild in den Framebuffer.
@param pDest ein Pointer auf das Zielbild. In den meisten Fällen ist dies der Framebuffer.
@param PosX die Position auf der X-Achse im Zielbild in Pixeln, an der das Bild gerendert werden soll.
Der Standardwert ist 0.
@param PosY die Position auf der Y-Achse im Zielbild in Pixeln, an der das Bild gerendert werden soll.
Der Standardwert ist 0.
@param Flipping gibt an, wie das Bild gespiegelt werden soll.
Der Standardwert ist BS_Image::FLIP_NONE (keine Spiegelung)
@param pSrcPartRect Pointer auf ein Common::Rect, welches den Ausschnitt des Quellbildes spezifiziert, der gerendert
werden soll oder NULL, falls das gesamte Bild gerendert werden soll.
Dieser Ausschnitt bezieht sich auf das ungespiegelte und unskalierte Bild.
Der Standardwert ist NULL.
@param Color ein ARGB Farbwert, der die Parameter für die Farbmodulation und fürs Alphablending festlegt.
Die Alpha-Komponente der Farbe bestimmt den Alphablending Parameter (0 = keine Deckung, 255 = volle Deckung).
Die Farbkomponenten geben die Farbe für die Farbmodulation an.
Der Standardwert is BS_ARGB(255, 255, 255, 255) (volle Deckung, keine Farbmodulation).
Zum Erzeugen des Farbwertes können die Makros BS_RGB und BS_ARGB benutzt werden.
@param Width gibt die Ausgabebreite des Bildausschnittes an.
Falls diese von der Breite des Bildausschnittes abweicht wird
das Bild entsprechend Skaliert.
Der Wert -1 gibt an, dass das Bild nicht Skaliert werden soll.
Der Standardwert ist -1.
@param Width gibt die Ausgabehöhe des Bildausschnittes an.
Falls diese von der Höhe des Bildauschnittes abweicht, wird
das Bild entsprechend Skaliert.
Der Wert -1 gibt an, dass das Bild nicht Skaliert werden soll.
Der Standardwert ist -1.
@return Gibt false zurück, falls das Rendern fehlgeschlagen ist.
@remark Er werden nicht alle Blitting-Operationen von allen BS_Image-Klassen unterstützt.
Mehr Informationen gibt es in der Klassenbeschreibung von BS_Image und durch folgende Methoden:
- IsBlitTarget()
- IsScalingAllowed()
- IsFillingAllowed()
- IsAlphaAllowed()
- IsColorModulationAllowed()
- IsSetContentAllowed()
*/
virtual bool Blit(int PosX = 0, int PosY = 0,
int Flipping = FLIP_NONE,
Common::Rect *pPartRect = NULL,
unsigned int Color = BS_ARGB(255, 255, 255, 255),
int Width = -1, int Height = -1) = 0;
/**
@brief Füllt einen Rechteckigen Bereich des Bildes mit einer Farbe.
@param pFillRect Pointer auf ein Common::Rect, welches den Ausschnitt des Bildes spezifiziert, der gefüllt
werden soll oder NULL, falls das gesamte Bild gefüllt werden soll.
Der Standardwert ist NULL.
@param Color der 32 Bit Farbwert mit dem der Bildbereich gefüllt werden soll.
@remark Es ist möglich über die Methode transparente Rechtecke darzustellen, indem man eine Farbe mit einem Alphawert ungleich
255 angibt.
@remark Unabhängig vom Farbformat des Bildes muss ein 32 Bit Farbwert angegeben werden. Zur Erzeugung, können die Makros
BS_RGB und BS_ARGB benutzt werden.
@remark Falls das Rechteck nicht völlig innerhalb des Bildschirms ist, wird es automatisch zurechtgestutzt.
*/
virtual bool Fill(const Common::Rect *pFillRect = 0, unsigned int Color = BS_RGB(0, 0, 0)) = 0;
/**
@brief Füllt den Inhalt des Bildes mit Pixeldaten.
@param Pixeldata ein Vector der die Pixeldaten enthält. Sie müssen in dem Farbformat des Bildes vorliegen und es müssen genügend Daten
vorhanden sein, um das ganze Bild zu füllen.
@param Offset der Offset in Byte im Pixeldata-Vector an dem sich der erste zu schreibende Pixel befindet.
Der Standardwert ist 0.
@param Stride der Abstand in Byte zwischen dem Zeilenende und dem Beginn einer neuen Zeile im Pixeldata-Vector.
Der Standardwert ist 0.
@return Gibt false zurück, falls der Aufruf fehlgeschlagen ist.
@remark Ein Aufruf dieser Methode ist nur erlaubt, wenn IsSetContentAllowed() true zurückgibt.
*/
virtual bool SetContent(const byte *Pixeldata, uint size, unsigned int Offset, unsigned int Stride) = 0;
/**
@brief Liest einen Pixel des Bildes.
@param X die X-Koordinate des Pixels.
@param Y die Y-Koordinate des Pixels
@return Gibt den 32-Bit Farbwert des Pixels an der übergebenen Koordinate zurück.
@remark Diese Methode sollte auf keine Fall benutzt werden um größere Teile des Bildes zu lesen, da sie sehr langsam ist. Sie ist
eher dafür gedacht einzelne Pixel des Bildes auszulesen.
*/
virtual unsigned int GetPixel(int X, int Y) = 0;
//@{
/** @name Auskunfts-Methoden */
/**
@brief Überprüft, ob an dem BS_Image Blit() aufgerufen werden darf.
@return Gibt false zurück, falls ein Blit()-Aufruf an diesem Objekt nicht gestattet ist.
*/
virtual bool IsBlitSource() const = 0;
/**
@brief Überprüft, ob das BS_Image ein Zielbild für einen Blit-Aufruf sein kann.
@return Gibt false zurück, falls ein Blit-Aufruf mit diesem Objekt als Ziel nicht gestattet ist.
*/
virtual bool IsBlitTarget() const = 0;
/**
@brief Gibt true zurück, falls das BS_Image bei einem Aufruf von Blit() skaliert dargestellt werden kann.
*/
virtual bool IsScalingAllowed() const = 0;
/**
@brief Gibt true zurück, wenn das BS_Image mit einem Aufruf von Fill() gefüllt werden kann.
*/
virtual bool IsFillingAllowed() const = 0;
/**
@brief Gibt true zurück, wenn das BS_Image bei einem Aufruf von Blit() mit einem Alphawert dargestellt werden kann.
*/
virtual bool IsAlphaAllowed() const = 0;
/**
@brief Gibt true zurück, wenn das BS_Image bei einem Aufruf von Blit() mit Farbmodulation dargestellt werden kann.
*/
virtual bool IsColorModulationAllowed() const = 0;
/**
@brief Gibt true zurück, wenn der Inhalt des BS_Image durch eine Aufruf von SetContent() ausgetauscht werden kann.
*/
virtual bool IsSetContentAllowed() const = 0;
//@}
};
} // End of namespace Sword25
#endif