DebugDisplayInterface Class Reference

#include <DebugDisplay.h>

Inherited by DebugDisplay.

Public Types
enum	Color {   WHITE , BLACK , YELLOW , RED ,   GREEN , BLUE , NUM_COLORS }

Public Member Functions
virtual	~DebugDisplayInterface ()
virtual void	printf (Char *format,...)=0
	Print formatted text at current cursor position.
virtual void	setCursorPos (Int x, Int y)=0
	Set new cursor position.
virtual Int	getCursorXPos (void)=0
	Get current X position of cursor.
virtual Int	getCursorYPos (void)=0
	Get current Y position of cursor.
virtual Int	getWidth (void)=0
	Get character width of display.
virtual Int	getHeight (void)=0
	Get character height of display.
virtual void	setTextColor (Color color)=0
	Set text color.
virtual void	setRightMargin (Int rightPos)=0
	Set right margin position.
virtual void	setLeftMargin (Int leftPos)=0
	Set left margin position.
virtual void	reset (void)=0
	Reset back to default settings.

Protected Member Functions
virtual void	drawText (Int x, Int y, Char *text)=0
	Render null ternimated string at current cursor position.

Detailed Description

Definition at line 73 of file DebugDisplay.h.

Member Enumeration Documentation

Color

enum DebugDisplayInterface::Color

Enumerator
WHITE
BLACK
YELLOW
RED
GREEN
BLUE
NUM_COLORS

Definition at line 78 of file DebugDisplay.h.

Constructor & Destructor Documentation

~DebugDisplayInterface()

virtual DebugDisplayInterface::~DebugDisplayInterface ( )

inlinevirtual

Definition at line 89 of file DebugDisplay.h.

Member Function Documentation

drawText()

virtual void DebugDisplayInterface::drawText ( Int x, Int y, Char * text )

protectedpure virtual

Render null ternimated string at current cursor position.

Implemented in W3DDebugDisplay.

getCursorXPos()

virtual Int DebugDisplayInterface::getCursorXPos ( void )

pure virtual

Get current X position of cursor.

Implemented in DebugDisplay.

getCursorYPos()

virtual Int DebugDisplayInterface::getCursorYPos ( void )

pure virtual

Get current Y position of cursor.

Implemented in DebugDisplay.

getHeight()

virtual Int DebugDisplayInterface::getHeight ( void )

pure virtual

Get character height of display.

Implemented in DebugDisplay.

getWidth()

virtual Int DebugDisplayInterface::getWidth ( void )

pure virtual

Get character width of display.

Implemented in DebugDisplay.

printf()

virtual void DebugDisplayInterface::printf ( Char * format, ... )

pure virtual

Print formatted text at current cursor position.

Implemented in DebugDisplay.

reset()

virtual void DebugDisplayInterface::reset ( void )

pure virtual

Reset back to default settings.

Implemented in DebugDisplay.

setCursorPos()

virtual void DebugDisplayInterface::setCursorPos ( Int x, Int y )

pure virtual

Set new cursor position.

Implemented in DebugDisplay.

setLeftMargin()

virtual void DebugDisplayInterface::setLeftMargin ( Int leftPos )

pure virtual

Set left margin position.

Implemented in DebugDisplay.

setRightMargin()

virtual void DebugDisplayInterface::setRightMargin ( Int rightPos )

pure virtual

Set right margin position.

Implemented in DebugDisplay.

setTextColor()

virtual void DebugDisplayInterface::setTextColor ( Color color )

pure virtual

Set text color.

Implemented in DebugDisplay.

---

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

• Code/GameEngine/Include/GameClient/DebugDisplay.h