Klasse zum Anzeigen von Sprites.
Mehr ...
- Beschreibung:
- Diese Klasse kann zum Laden und Anzeigen von Sprites verwendet werden, die im PFP-Sprite-Texture-Format vorliegen.
- Seit
- Die Klasse wurde mit Version 6.2.4 eingeführt.
ppl6::grafix::CSprite::CSprite |
( |
| ) |
|
- Beschreibung:
- Dies ist der Konstruktor der Klasse. Gegenwärtig werden hier jedoch keinerlei Daten initialisiert.
ppl6::grafix::CSprite::~CSprite |
( |
| ) |
|
- Beschreibung:
- Dies ist der Destruktor der Klasse. Er ruft die Clear-Funktion auf, um sicherzustellen, dass sämtliche Texturen und Speicherbereiche der Klasse wieder freigegeben werden.
void ppl6::grafix::CSprite::clear |
( |
| ) |
|
- Beschreibung:
- Diese Funktion sorgt dafür, dass sämtlicher durch die Klasse allokierter Speicher und Texturen wieder freigegeben werden.
int ppl6::grafix::CSprite::draw |
( |
CSurface & |
target, |
|
|
int |
x, |
|
|
int |
y, |
|
|
int |
id |
|
) |
| const |
- Beschreibung:
- Mit dieser Funktion wird ein beliebiges Sprite auf dem Ziel-Surface angezeigt.
- Parameter
-
[in] | target | Ziel-Surface |
[in] | x | X-Koordinate, bei der das Sprite gezeichnet werden soll |
[in] | y | Y-Koordinate, bei der das Sprite gezeichnet werden soll |
[in] | id | ID des anzuzeigenden Sprites |
- Rückgabe
- Bei Erfolg liefert die Funktion 1 zurück, im Fehlerfall 0.
int ppl6::grafix::CSprite::draw |
( |
CDrawable & |
target, |
|
|
int |
x, |
|
|
int |
y, |
|
|
int |
id |
|
) |
| const |
- Beschreibung:
- Mit dieser Funktion wird ein beliebiges Sprite auf dem Ziel-Surface angezeigt.
- Parameter
-
[in] | target | Ziel-Surface |
[in] | x | X-Koordinate, bei der das Sprite gezeichnet werden soll |
[in] | y | Y-Koordinate, bei der das Sprite gezeichnet werden soll |
[in] | id | ID des anzuzeigenden Sprites |
- Rückgabe
- Bei Erfolg liefert die Funktion 1 zurück, im Fehlerfall 0.
CSurface * ppl6::grafix::CSprite::findTexture |
( |
int |
id | ) |
|
|
private |
- Beschreibung:
- Diese Funktion wird intern aufgerufen, um einen Surface-Pointer auf eine bereits geladene Textur zu erhalten.
- Parameter
-
[in] | id | ID der gewünschten Texture |
- Rückgabe
- Ist die Textur-ID vorhanden und bereits geladen, wird ein Pointer auf deren CSurface-Klasse zurückgeliefert, andernfalls NULL.
- Beschreibung:
- Mit dieser Funktion kann eine Textur-Sprite-Datei geladen werden.
- Parameter
-
[in] | filename | Name der zu ladenden Datei |
[in] | flags | Flags mit der die Textur-Surfaces erstellt werden sollen. Dies ist eine Kombination der Werte innerhalb der Enumeration ppl6::grafix::Surface::Flags |
- Rückgabe
- Konnte die Datei erfolgreich geladern werden, gibt die Funktion 1 (true) zurück, im Fehlerfall 0 (false). Im Fehlerfall wird ein entsprechender Fehlercode gesetzt.
- Beschreibung:
- Mit dieser Funktion kann eine bereits geöffnete Textur-Sprite-Datei geladen werden.
- Parameter
-
[in] | ff | Pointer auf die CFileObject-Klasse, die die Daten enthält. |
[in] | flags | Flags mit der die Textur-Surfaces erstellt werden sollen. Dies ist eine Kombination der Werte innerhalb der Enumeration ppl6::grafix::Surface::Flags |
- Rückgabe
- Konnte die Datei erfolgreich geladern werden, gibt die Funktion 1 (true) zurück, im Fehlerfall 0 (false). Im Fehlerfall wird ein entsprechender Fehlercode gesetzt.
int ppl6::grafix::CSprite::loadIndex |
( |
PFPChunk * |
chunk | ) |
|
|
private |
- Beschreibung:
- Diese Funktion wird intern verwendet, um den INDX-Chunk der Sprite-Datei einzulesen. Sie darf erst nach Aufruf von CSprite::LoadTexture verwendet werden.
- Parameter
-
[in] | chunk | Pointer auf den INDX-Chunk |
- Rückgabe
- Konnte der Index erfolgreich eingelesen und alle Texturen zugeordnet werden, liefert die Funktion true (1) zurück, andernfalls false (0).
- Beschreibung:
- Diese Funktion wird intern verwendet, um einen SURF-Chunk mit einer Textur aus der Sprite-Datei zu laden.
- Parameter
-
[in] | chunk | Pointer auf den zu ladenden SURF-Chunk |
[in] | flags | Flags, mit dem das Texture-Surfaces erstellt werden soll. Dies ist eine Kombination der Werte innerhalb der Enumeration ppl6::grafix::Surface::Flags |
- Rückgabe
- Konnte die Textur erfolgreich geladen werden, liefert die Funktion true (1) zurück, andernfalls false (0).
int ppl6::grafix::CSprite::numSprites |
( |
| ) |
const |
- Beschreibung:
- Diese Funktion liefert die Anzahl durch die Klasse geladener Sprites zurück.
- Rückgabe
- Anzahl Sprites oder 0, wenn keine geladen sind.
int ppl6::grafix::CSprite::numTextures |
( |
| ) |
const |
- Beschreibung:
- Diese Funktion liefert die Anzahl durch die Klasse geladener Texturen zurück.
- Rückgabe
- Anzahl Texturen oder 0, wenn keine geladen sind.
ppl6::grafix::CSprite::SpriteList |
|
private |
ppl6::grafix::CSprite::TextureList |
|
private |
Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Dateien:
- /jenkins/jobs/clang_ppl6/workspace/include/ppl6-grafix.h
- /jenkins/jobs/clang_ppl6/workspace/src/grafix6/CSprite.cpp