overlay.h-Dateireferenz

gehe zum Quellcode dieser Datei

Funktionen
int	TextCreate (const char *Font, int FontSize, bool bBold, bool bItalic, int x, int y, unsigned int color, const char *text, bool bShadow, bool bShow)
int	TextDestroy (int ID)
int	TextSetShadow (int id, bool b)
int	TextSetShown (int id, bool b)
int	TextSetColor (int id, unsigned int color)
int	TextSetPos (int id, int x, int y)
int	TextSetString (int id, const char *str)
int	TextUpdate (int id, const char *Font, int FontSize, bool bBold, bool bItalic)
int	BoxCreate (int x, int y, int w, int h, unsigned int dwColor, bool bShow)
int	BoxDestroy (int id)
int	BoxSetShown (int id, bool bShown)
int	BoxSetBorder (int id, int height, bool bShown)
int	BoxSetBorderColor (int id, unsigned int dwColor)
int	BoxSetColor (int id, unsigned int dwColor)
int	BoxSetHeight (int id, int height)
int	BoxSetPos (int id, int x, int y)
int	BoxSetWidth (int id, int width)
int	LineCreate (int x1, int y1, int x2, int y2, int width, unsigned int color, bool bShow)
int	LineDestroy (int id)
int	LineSetShown (int id, bool bShown)
int	LineSetColor (int id, unsigned int color)
int	LineSetWidth (int id, int width)
int	LineSetPos (int id, int x1, int y1, int x2, int y2)
int	ImageCreate (const char *path, int x, int y, int rotation, int align, bool bShow)
int	ImageDestroy (int id)
int	ImageSetShown (int id, bool bShown)
int	ImageSetAlign (int id, int align)
int	ImageSetPos (int id, int x, int y)
int	ImageSetRotation (int id, int rotation)
int	DestroyAllVisual ()
int	ShowAllVisual ()
int	HideAllVisual ()
int	GetFrameRate ()
int	GetScreenSpecs (int &width, int &height)
int	Init ()
void	SetParam (const char *_szParamName, const char *_szParamValue)

Dokumentation der Funktionen

int BoxCreate	(	int	x,
		int	y,
		int	w,
		int	h,
		unsigned int	dwColor,
		bool	bShow
	)

Erstellt eine Box mit den angegebenen Paramtern.

Parameter

[in]	x	Position X skaliert auf einer Auflösung von 800 x 600
[in]	y	Position Y skaliert auf einer Auflösung von 800 x 600
[in]	w	Breite der Box, skaliert auf einer Auflösung von 800 x 600
[in]	h	Höhe der Box, skaliert auf einer Auflösung von 800 x 600
[in]	dwColor	Farbe der Box
[in]	bShow	Sollte die Box nach dem Erstellen gezeichnet werden?

Rückgabe

Gibt die ID der Box zurück, -1 bei einem Fehler!

int BoxDestroy

(

int

id

)

Zerstört eine Box.

Parameter

[in]

id

ID der Box

Rückgabe

1 wenn erfolgreich, 0 wenn nicht.

Siehe auch

BoxCreate()

int BoxSetBorder	(	int	id,
		int	height,
		bool	bShown
	)

Setzt eine Umrandung für die Box.

Parameter

[in]	id	ID der Box
[in]	height	Höhe der Umrandung.
[in]	bShown	true, falls die Umrandung gezeigt werden soll, false wenn nicht.

Rückgabe

1 wenn erfolgreich, 0 wenn nicht.

Siehe auch

BoxCreate()

int BoxSetBorderColor	(	int	id,
		unsigned int	dwColor
	)

Setzt die Farbe der Umrandung einer Box.

Parameter

[in]	id	ID der Box
[in]	dwColor	Farbe für die Umrandung (ARGB-Code)

Rückgabe

1 wenn erfolgreich, 0 wenn nicht.

Siehe auch

BoxCreate()

int BoxSetColor	(	int	id,
		unsigned int	dwColor
	)

Setzt die Farbe der Box.

Parameter

[in]	id	ID der Box
[in]	dwColor	Farbe der Box (ARGB-Code)

Rückgabe

1 wenn erfolgreich, 0 wenn nicht.

Siehe auch

BoxCreate()

int BoxSetHeight	(	int	id,
		int	height
	)

Setzt die Höhe einer Box.

Parameter

[in]	id	ID der Box.
[in]	height	Höhe der Box.

Rückgabe

1 wenn erfolgreich, 0 wenn nicht.

Siehe auch

BoxCreate()

int BoxSetPos	(	int	id,
		int	x,
		int	y
	)

Setzt die Position einer Box.

Parameter

[in]	id	ID der Box.
[in]	x	Position-X, skaliert auf einer Auflösung von 800-600.
[in]	y	Position-Y, skaliert auf einer Auflösung von 800-600.

Rückgabe

1 wenn erfolgreich, 0 wenn nicht.

Siehe auch

BoxCreate()

int BoxSetShown	(	int	id,
		bool	bShown
	)

Aktiviert / Deaktiviert eine Box temporär.

Parameter

[in]	id	ID der Box
[in]	bShown	true, falls die Box gezeigt werden soll, false wenn nicht.

Rückgabe

1 wenn erfolgreich, 0 wenn nicht.

Siehe auch

BoxCreate()

int BoxSetWidth	(	int	id,
		int	width
	)

Setzt die Breite einer Box.

Parameter

[in]	id	ID der Box
[in]	width	Breite der Box

Rückgabe

1 wenn erfolgreich, 0 wenn nicht.

Siehe auch

BoxCreate()

int DestroyAllVisual

(

)

Zerstört alle Overlays.

Rückgabe

1 wenn erfolgreich, 0 wenn nicht.

int GetFrameRate

(

)

Liest die aktuelle Framerate aus.

Rückgabe

Framerate, -1 bei einem Fehler.

int GetScreenSpecs	(	int &	width,
		int &	height
	)

Gibt die aktuelle Auflösung des Spieles / Programmes über zwei Referenzen zurück.

Parameter

[out]	width	Breite.
[out]	height	Höhe.

Rückgabe

1, wenn erfolgreich, sonst 0.

int HideAllVisual

(

)

Versteckt alle Overlays.

Rückgabe

1 wenn erfolgreich, 0 wenn nicht.

int ImageCreate	(	const char *	path,
		int	x,
		int	y,
		int	rotation,
		int	align,
		bool	bShow
	)

Erstellt ein Bild mit den angegebenen Paramtern.

Parameter

[in]	path	Relativer oder absoluter Pfad zur einer Bild-Datei.
[in]	x	X-Position des ersten Punktes, skaliert auf einer Auflösung von 800 x 600
[in]	y	Y-Position des ersten Punktes, skaliert auf einer Auflösung von 800 x 600
[in]	rotation	Rotation des Bildes.
[in]	align	Platzierung des Bildes.
[in]	bShow	true, falls das Bild beim initialisieren gezeichnet werden soll, false wenn nicht.

Rückgabe

Gibt die ID zurück, -1 bei einem Fehler.

int ImageDestroy

(

int

id

)

zerstört ein Bild.

Parameter

[in]

id

ID des Bildes, welches zerstört werden soll.

Rückgabe

1 wenn erfolgreich, 0 wenn nicht.

Siehe auch

ImageCreate()

int ImageSetAlign	(	int	id,
		int	align
	)

Ordnet das Bild zu.

Parameter

[in]	id	ID des Bildes.
[in]	align	Zuordnung.

Rückgabe

1 wenn erfolgreich, 0 wenn nicht.

Siehe auch

ImageCreate()

int ImageSetPos	(	int	id,
		int	x,
		int	y
	)

Setzt die Position eines Bildes.

Parameter

[in]	id	ID des Bildes.
[in]	x	X-Position des ersten Punktes, skaliert auf einer Auflösung von 800 x 600
[in]	y	Y-Position des ersten Punktes, skaliert auf einer Auflösung von 800 x 600

Rückgabe

1 wenn erfolgreich, 0 wenn nicht.

Siehe auch

ImageCreate()

int ImageSetRotation	(	int	id,
		int	rotation
	)

Setzt die Rotation eines Bildes.

Parameter

[in]	id	ID des Bildes.
[in]	rotation	Rotation des Bildes.

Rückgabe

1 wenn erfolgreich, 0 wenn nicht.

Siehe auch

ImageCreate()

int ImageSetShown	(	int	id,
		bool	bShown
	)

Aktiviert / Deaktiviert ein Bild temporär.

Parameter

[in]	id	ID des Bildes.
[in]	bShown	true, falls das Bild gezeigt werden soll, false wenn nicht.

Rückgabe

1 wenn erfolgreich, 0 wenn nicht.

Siehe auch

ImageCreate()

int Init

(

)

Initialisiert die API, muss aber nicht aufgerufen werden, da sie intern aufgerufen wird.

Rückgabe

1 wenn erfolgreich, 0 wenn nicht.

int LineCreate	(	int	x1,
		int	y1,
		int	x2,
		int	y2,
		int	width,
		unsigned int	color,
		bool	bShow
	)

Erstellt eine Linie mit den angegebenen Parametern.

Parameter

[in]	x1	X-Position des ersten Punktes, skaliert auf einer Auflösung von 800 x 600
[in]	y1	Y-Position des ersten Punktes, skaliert auf einer Auflösung von 800 x 600
[in]	x2	X-Position des zweiten Punktes, skaliert auf einer Auflösung von 800 x 600
[in]	y2	Y-Position des zweiten Punktes, skaliert auf einer Auflösung von 800 x 600
[in]	width	Breite der Linie in Pixeln.
[in]	color	Farbe der Linie.
[in]	bShow	Sollte die Linie direkt nach dem Erstellen gezeichnet werden?

Rückgabe

Gibt die ID der erstellen Linie zurück. -1 bei einem Fehler.

int LineDestroy

(

int

id

)

Zerstört eine Linie.

Parameter

[in]

id

Linien-Objekt, welches zerstört werden soll.

Rückgabe

1 wenn erfolgreich, 0 wenn nicht.

int LineSetColor	(	int	id,
		unsigned int	color
	)

Setzt die Farbe einer Linie.

Parameter

[in]	id	ID der Linie
[in]	color	Farbe der Linie (ARGB-Code)

Rückgabe

1 wenn erfolgreich, 0 wenn nicht.

Siehe auch

LineCreate()

int LineSetPos	(	int	id,
		int	x1,
		int	y1,
		int	x2,
		int	y2
	)

Setzt die Position einer Linie

Parameter

[in]	id	ID der Linie
[in]	x1	X-Position des ersten Punktes, skaliert auf einer Auflösung von 800 x 600
[in]	y1	Y-Position des ersten Punktes, skaliert auf einer Auflösung von 800 x 600
[in]	x2	X-Position des zweiten Punktes, skaliert auf einer Auflösung von 800 x 600
[in]	y2	Y-Position des zweiten Punktes, skaliert auf einer Auflösung von 800 x 600

Rückgabe

1 wenn erfolgreich, 0 wenn nicht.

Siehe auch

LineCreate()

int LineSetShown	(	int	id,
		bool	bShown
	)

Aktiviert / Deaktiviert eine Linie temporär.

Parameter

[in]	id	ID der Linie
[in]	bShown	true, falls die Linie gezeigt werden soll, false wenn nicht.

Rückgabe

1 wenn erfolgreich, 0 wenn nicht.

Siehe auch

LineCreate()

int LineSetWidth	(	int	id,
		int	width
	)

Setzt die Breite einer Linie.

Parameter

[in]	id	ID der Linie
[in]	width	Breite der Linie in Pixeln.

Rückgabe

1 wenn erfolgreich, 0 wenn nicht.

Siehe auch

LineCreate()

void SetParam	(	const char *	_szParamName,
		const char *	_szParamValue
	)

Setzt die Paramter für die API.
Mögliche Parameter für '_szParamName':
"use_window" Die API benutzt den Fensternamen, um einen Prozess zu finden. Standardmäßig auf 0.
"process" Name des Prozesses, wird ignoriert, wenn use_window auf 1 ist.
"window" Name des Fensters.

Parameter

[in]	_szParamName	Schlüsselparameter
[in]	_szParamValue	Wert für den ersten Parameter. Diese Funktion muss vor jeder anderen API-Funktion aufgerufen werden!

int ShowAllVisual

(

)

Zeigt alle Overlays.

Rückgabe

1 wenn erfolgreich, 0 wenn nicht.

int TextCreate	(	const char *	Font,
		int	FontSize,
		bool	bBold,
		bool	bItalic,
		int	x,
		int	y,
		unsigned int	color,
		const char *	text,
		bool	bShadow,
		bool	bShow
	)

Erstellt einen Text mit den angegebenen Parametern.

Parameter

[in]	Font	Name einer Font
[in]	FontSize	Größe der Font
[in]	bBold	Sollte die Font fett sein?
[in]	bItalic	Sollte die Font kursiv sein?
[in]	x	Position X skaliert auf einer Auflösung von 800 x 600
[in]	y	Position Y skaliert auf einer Auflösung von 800 x 600
[in]	color	Farbe des Overlays (ARGB-Code)
[in]	text	Text des Overlays
[in]	bShadow	Schwarzer Schatten um das Overlay?
[in]	bShow	Sollte der Text nach dem Funktionsaufruf gezeichnet werden?

Rückgabe

Gibt die ID des Overlays zurück, welche für alle weitern Funktionen benötigt wird. Gibt -1 bei einem Fehler zurück.

int TextDestroy

(

int

ID

)

Zerstört einen Text.

Parameter

[in]

ID

TextID welche zerstört werden sollte.

Rückgabe

1 wenn erfolgreich, 0 wenn nicht.

Siehe auch

TextCreate()

int TextSetColor	(	int	id,
		unsigned int	color
	)

Setzt eine neue Farbe für den Text

Parameter

[in]	id	Overlay-ID
[in]	color	Die neue Farbe als ARGB-Code

Rückgabe

1 wenn erfolgreich, 0 wenn nicht.

Siehe auch

TextCreate()

int TextSetPos	(	int	id,
		int	x,
		int	y
	)

Setzt den Text an eine angegebene Position

Parameter

[in]	id	Overlay-ID
[in]	x	X-Position skaliert auf einer Auflösung von 800 x 600
[in]	y	Y-Position skaliert auf einer Auflösung von 800 x 600

Rückgabe

1 wenn erfolgreich, 0 wenn nicht.

Siehe auch

TextCreate()

int TextSetShadow	(	int	id,
		bool	b
	)

Aktiviert / Deaktiviert den Schatten eines Textes.

Parameter

[in]	id	Overlay-ID
[in]	b	true für das Aktivieren, false für das Deaktivieren

Rückgabe

1 wenn erfolgreich, 0 wenn nicht.

Siehe auch

TextCreate()

int TextSetShown	(	int	id,
		bool	b
	)

Aktiviert / Deaktiviert das Overlay temporär.

Parameter

[in]	id	Overlay-ID
[in]	b	true für das Aktivieren, false für das Deaktivieren

Rückgabe

1 wenn erfolgreich, 0 wenn nicht.

Siehe auch

TextCreate()

int TextSetString	(	int	id,
		const char *	str
	)

Setzen eines neues Textes für das Text-Overlay.

Parameter

[in]	id	Overlay-ID
[in]	str	Neuer Text als String

Rückgabe

1 wenn erfolgreich, 0 wenn nicht.

Siehe auch

TextCreate()

int TextUpdate	(	int	id,
		const char *	Font,
		int	FontSize,
		bool	bBold,
		bool	bItalic
	)

Aktualisieren des Overlays mit neuen Daten.

Parameter

[in]	id	Overlay-ID
[in]	Font	Neue Font als String
[in]	FontSize	Größe der Font
[in]	bBold	Sollte der Text fett sein?
[in]	bItalic	Sollte der Text kursiv sein?

Rückgabe

1 wenn erfolgreich, 0 wenn nicht.

Siehe auch

TextCreate()