ScummVM API documentation
Sword25::BitmapResource Class Reference
Inheritance diagram for Sword25::BitmapResource:
Sword25::Resource

Public Member Functions

 BitmapResource (const Common::String &filename, Image *pImage)
 
bool isValid () const
 Gibt zurück, ob das Objekt einen gültigen Zustand hat.
 
int getWidth () const
 Gibt die Breite des Bitmaps zurück.
 
int getHeight () const
 Gibt die Höhe des Bitmaps zurück.
 
bool blit (int posX=0, int posY=0, int flipping=Graphics::FLIP_NONE, Common::Rect *pSrcPartRect=NULL, uint color=BS_ARGB(255, 255, 255, 255), int width=-1, int height=-1, RectangleList *updateRects=0)
 Rendert das Bild in den Framebuffer. More...
 
bool fill (const Common::Rect *pFillRect=0, uint color=BS_RGB(0, 0, 0))
 Füllt einen Rechteckigen Bereich des Bildes mit einer Farbe. More...
 
uint getPixel (int x, int y) const
 Liest einen Pixel des Bildes. More...
 
- Public Member Functions inherited from Sword25::Resource
 Resource (const Common::String &uniqueFileName, RESOURCE_TYPES type)
 
void addReference ()
 
void release ()
 
int getLockCount () const
 
const Common::StringgetFileName () const
 
uint getType () const
 

Auskunfts-Methoden

bool isBlitTarget ()
 Überprüft, ob das BS_Image ein Zielbild für einen Blit-Aufruf sein kann. More...
 
bool isScalingAllowed ()
 Gibt true zurück, falls das BS_Image bei einem Aufruf von Blit() skaliert dargestellt werden kann.
 
bool isFillingAllowed ()
 Gibt true zurück, wenn das BS_Image mit einem Aufruf von Fill() gefüllt werden kann.
 
bool isAlphaAllowed ()
 Gibt true zurück, wenn das BS_Image bei einem Aufruf von Blit() mit einem Alphawert dargestellt werden kann.
 
bool isColorModulationAllowed ()
 Gibt true zurück, wenn das BS_Image bei einem Aufruf von Blit() mit Farbmodulation dargestellt werden kann.
 
bool isSolid ()
 

Additional Inherited Members

- Public Types inherited from Sword25::Resource
enum  RESOURCE_TYPES {
  TYPE_UNKNOWN, TYPE_BITMAP, TYPE_ANIMATION, TYPE_SOUND,
  TYPE_FONT
}
 

Member Function Documentation

◆ blit()

bool Sword25::BitmapResource::blit ( int  posX = 0,
int  posY = 0,
int  flipping = Graphics::FLIP_NONE,
Common::Rect pSrcPartRect = NULL,
uint  color = BS_ARGB(255, 255, 255, 255),
int  width = -1,
int  height = -1,
RectangleList updateRects = 0 
)
inline

Rendert das Bild in den Framebuffer.

Parameters
PosXdie Position auf der X-Achse im Zielbild in Pixeln, an der das Bild gerendert werden soll.
Der Standardwert ist 0.
PosYdie Position auf der Y-Achse im Zielbild in Pixeln, an der das Bild gerendert werden soll.
Der Standardwert ist 0.
Flippinggibt an, wie das Bild gespiegelt werden soll.
Der Standardwert ist BS_Image::FLIP_NONE (keine Spiegelung)
pSrcPartRectPointer 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.
Colorein 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.
Widthgibt 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.
Widthgibt 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.
Returns
Gibt false zurück, falls das Rendern fehlgeschlagen ist.
Remarks
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()

◆ fill()

bool Sword25::BitmapResource::fill ( const Common::Rect pFillRect = 0,
uint  color = BS_RGB(0, 0, 0) 
)
inline

Füllt einen Rechteckigen Bereich des Bildes mit einer Farbe.

Parameters
pFillRectPointer 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.
Colorder 32 Bit Farbwert mit dem der Bildbereich gefüllt werden soll.
Remarks
Ein Aufruf dieser Methode ist nur gestattet, wenn IsFillingAllowed() true zurückgibt.
Es ist möglich über die Methode transparente Rechtecke darzustellen, indem man eine Farbe mit einem Alphawert ungleich 255 angibt.
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.
Falls das Rechteck nicht völlig innerhalb des Bildschirms ist, wird es automatisch zurechtgestutzt.

◆ getPixel()

uint Sword25::BitmapResource::getPixel ( int  x,
int  y 
) const
inline

Liest einen Pixel des Bildes.

Parameters
Xdie X-Koordinate des Pixels.
Ydie Y-Koordinate des Pixels
Returns
Gibt den 32-Bit Farbwert des Pixels an der übergebenen Koordinate zurück.
Remarks
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.

◆ isBlitTarget()

bool Sword25::BitmapResource::isBlitTarget ( )
inline

Überprüft, ob das BS_Image ein Zielbild für einen Blit-Aufruf sein kann.

Returns
Gibt false zurück, falls ein Blit-Aufruf mit diesem Objekt als Ziel nicht gestattet ist.

The documentation for this class was generated from the following file: