overlay.h File Reference

Go to the source code of this file.

Functions
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)

Function Documentation

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

Creates a box.

Parameters

[in]	x	Position X scaled on a resolution of 800 x 600.
[in]	y	Position Y scaled on a resolution of 800 x 600.
[in]	w	Box's width scaled on a resolution of 800 x 600.
[in]	h	Box's height scaled on a resolution of 800 x 600.
[in]	dwColor	Color of the box (ARGB).
[in]	bShow	Should the box be drawed after the initialization?

Returns

Returns the box's id, return -1, if an error occured.

int BoxDestroy

(

int

id

)

Destroys a box.

Parameters

[in]

id

Box's id.

Returns

1 if successfull, 0 if not.

See also

BoxCreate()

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

Enables a border for the box or disables it.

Parameters

[in]	id	Box's id.
[in]	height	Border's height.
[in]	bShown	true, if the border should be displayed, otherwise false.

Returns

1 if successfull, 0 if not.

See also

BoxCreate()

int BoxSetBorderColor	(	int	id,
		unsigned int	dwColor
	)

Set die border's color.

Parameters

[in]	id	Box's id.
[in]	dwColor	Border's color (ARGB).

Returns

1 if successfull, 0 if not.

See also

BoxCreate()

int BoxSetColor	(	int	id,
		unsigned int	dwColor
	)

Set the box's color.

Parameters

[in]	id	Box's id.
[in]	dwColor	Box'x color (ARGB).

Returns

1 if successfull, 0 if not.

See also

BoxCreate()

int BoxSetHeight	(	int	id,
		int	height
	)

Set the box's height.

Parameters

[in]	id	Box's id.
[in]	height	Box's height, scaled on a resolution of 800 x 600.

Returns

1 if successfull, 0 if not.

See also

BoxCreate()

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

Sets the position of the box.

Parameters

[in]	id	Box's id.
[in]	x	Position-X, scaled on a resolution of 800 x 600.
[in]	y	Position-Y, scaled on a resolution of 800 x 600.

Returns

1 if successfull, 0 if not.

See also

BoxCreate()

int BoxSetShown	(	int	id,
		bool	bShown
	)

Hides or shows a box.

Parameters

[in]	id	ID of the box.
[in]	bShown	true, if the box should be displayed, otherwise false.

Returns

1 if successfull, 0 if not.

See also

BoxCreate()

int BoxSetWidth	(	int	id,
		int	width
	)

Sets the box's width.

Parameters

[in]	id	Box's id.
[in]	width	Box's width.

Returns

1 if successfull, 0 if not.

See also

BoxCreate()

int DestroyAllVisual

(

)

Destroys all overlays.

Returns

1 if successfull, 0 if not.

int GetFrameRate

(

)

Reads the game's framerate.

Returns

Returns the framerate, -1 if an error occured.

int GetScreenSpecs	(	int &	width,
		int &	height
	)

Reads the game's resolution.

Parameters

[out]	width	Width of the game.
[out]	height	Height of the game.

Returns

1 if successfull, 0 if not.

int HideAllVisual

(

)

Hides all overlays.

Returns

1 if successfull, 0 if not.

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

Creates an image.

Parameters

[in]	path	Relativ or absolut path to an image file.
[in]	x	Position X scaled on a resolution of 800 x 600
[in]	y	Position Y scaled on a resolution of 800 x 600
[in]	rotation	Image's rotation.
[in]	align	Image's alignment.
[in]	bShow	Should the image be drawed after initialization?

Returns

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

int ImageDestroy

(

int

id

)

Destroys an image.

Parameters

[in]

id

Image's id.

Returns

1 if successfull, 0 if not.

See also

ImageCreate()

int ImageSetAlign	(	int	id,
		int	align
	)

Sets an image's alignment.

Parameters

[in]	id	Image's id.
[in]	align	New alignment.

Returns

1 if successfull, 0 if not.

See also

ImageCreate()

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

Sets an image's position.

Parameters

[in]	id	Image's id.
[in]	x	Position X scaled on a resolution of 800 x 600
[in]	y	Position Y scaled on a resolution of 800 x 600

Returns

1 if successfull, 0 if not.

See also

ImageCreate()

int ImageSetRotation	(	int	id,
		int	rotation
	)

Sets an image's rotation.

Parameters

[in]	id	Image's id.
[in]	rotation	New rotation.

Returns

1 if successfull, 0 if not.

See also

ImageCreate()

int ImageSetShown	(	int	id,
		bool	bShown
	)

Hides or shows an image.

Parameters

[in]	id	Image's id.
[in]	bShown	true, if the image should be drawed, otherwise false.

Returns

1 if successfull, 0 if not.

See also

ImageCreate()

int Init

(

)

Routine to initialize the API, but it does not have to be explicitly called because it's initialized internally.

Returns

1 if successfull, 0 if not.

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

Creates a line.

Parameters

[in]	x1	Position X of the first point, scaled on a resolution of 800 x 600.
[in]	y1	Position Y of the first point, scaled on a resolution of 800 x 600.
[in]	x2	Position X of the second point, scaled on a resolution of 800 x 600.
[in]	y2	Position Y of the second point, scaled on a resolution of 800 x 600.
[in]	width	Line's width.
[in]	color	Line's color (ARGB).
[in]	bShow	Should the line be drawed after initialization?

Returns

Returns the line's id, return -1, if an error occured.

int LineDestroy

(

int

id

)

Destroys a line.

Parameters

[in]

id

Line's id.

Returns

1 if successfull, 0 if not.

int LineSetColor	(	int	id,
		unsigned int	color
	)

Sets a line's color.

Parameters

[in]	id	Line's id.
[in]	color	New color (ARGB).

Returns

1 if successfull, 0 if not.

See also

LineCreate()

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

Setzt die Position einer Linie

Parameters

[in]	id	Line's id.
[in]	x1	Position X of the first point, scaled on a resolution of 800 x 600.
[in]	y1	Position Y of the first point, scaled on a resolution of 800 x 600.
[in]	x2	Position X of the second point, scaled on a resolution of 800 x 600.
[in]	y2	Position Y of the second point, scaled on a resolution of 800 x 600.

Returns

1 if successfull, 0 if not.

See also

LineCreate()

int LineSetShown	(	int	id,
		bool	bShown
	)

Hides or shows a line.

Parameters

[in]	id	Line's id.
[in]	bShown	true, if the border should be displayed, otherwise false.

Returns

1 if successfull, 0 if not.

See also

LineCreate()

int LineSetWidth	(	int	id,
		int	width
	)

Sets a line's width.

Parameters

[in]	id	Line's id.
[in]	width	New width.

Returns

1 if successfull, 0 if not.

See also

LineCreate()

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

Sets API's parameters.
Possible Parameters for '_szParamName':
"use_window" The API uses the window name instead the process name. default 0.
"process" Name of the process, will be ignored, if 'use_window' is set to '1'.
"window" Name of the window.

Parameters

[in]	_szParamName	Key.
[in]	_szParamValue	Value. This function MUST be called for the proper use of the API.

int ShowAllVisual

(

)

Shows all overlays.

Returns

1 if successfull, 0 if not.

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
	)

Creates a text with given parameters.

Parameters

[in]	Font	Name of the font.
[in]	FontSize	Size of the font.
[in]	bBold	Should the font be bold?
[in]	bItalic	Should the font be italic?
[in]	x	Position X scaled on a resolution of 800 x 600.
[in]	y	Position Y scaled on a resolution of 800 x 600.
[in]	color	Color of the text (ARGB-Code).
[in]	text	Text of the overlay.
[in]	bShadow	Black shadow?
[in]	bShow	Should the overlay be drawed after the initialization?

Returns

Returns the text's id, return -1, if an error occured.

int TextDestroy

(

int

ID

)

Destroys a text.

Parameters

[in]

ID

TextID which should be destroyed.

Returns

1 if successfull, 0 if not.

See also

TextCreate()

int TextSetColor	(	int	id,
		unsigned int	color
	)

Set the text's color.

Parameters

[in]	id	Text's id.
[in]	color	New color (ARGB-code).

Returns

1 if successfull, 0 if not.

See also

TextCreate()

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

Give the text a new position.

Parameters

[in]	id	Text's id.
[in]	x	Position X scaled on a resolution of 800 x 600.
[in]	y	Position Y scaled on a resolution of 800 x 600.

Returns

1 if successfull, 0 if not.

See also

TextCreate()

int TextSetShadow	(	int	id,
		bool	b
	)

Activates / Deactivates the text's shadow.

Parameters

[in]	id	Text's id.
[in]	b	true for activation, false for deactivation.

Returns

1 if successfull, 0 if not.

See also

TextCreate()

int TextSetShown	(	int	id,
		bool	b
	)

Activates / Deactivates the overlay.

Parameters

[in]	id	Overlay-ID
[in]	b	true for activation, false for deactivation.

Returns

1 if successfull, 0 if not.

See also

TextCreate()

int TextSetString	(	int	id,
		const char *	str
	)

Seta a new text.

Parameters

[in]	id	Text's id.
[in]	str	New text as a string.

Returns

1 if successfull, 0 if not.

See also

TextCreate()

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

Updates a text.

Parameters

[in]	id	Text's id.
[in]	Font	New font as a string.
[in]	FontSize	Size of the font.
[in]	bBold	Should the text be bold?
[in]	bItalic	Should the text be italic?

Returns

1 if successfull, 0 if not.

See also

TextCreate()