Richard Boegli's CnC_Generals_Zero_Hour Fork WIP
This is documentation of Richard Boegil's Zero Hour Fork
 
Loading...
Searching...
No Matches
DebugDisplay Class Reference

#include <DebugDisplay.h>

Inherits DebugDisplayInterface.

Inherited by W3DDebugDisplay.

Public Member Functions

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

Protected Attributes

Color m_textColor
 Color to render text in.
 
Int m_xPos
 Current X position of cursor.
 
Int m_yPos
 Current Y position of cursor.
 
Int m_width
 Character width of display.
 
Int m_height
 Character height of display.
 
Int m_rightMargin
 Right margin position.
 
Int m_leftMargin
 Left margin position.
 

Additional Inherited Members

- Public Types inherited from DebugDisplayInterface
enum  Color {
  WHITE , BLACK , YELLOW , RED ,
  GREEN , BLUE , NUM_COLORS
}
 
- Protected Member Functions inherited from DebugDisplayInterface
virtual void drawText (Int x, Int y, Char *text)=0
 Render null ternimated string at current cursor position.
 

Detailed Description

Definition at line 112 of file DebugDisplay.h.

Constructor & Destructor Documentation

◆ DebugDisplay()

DebugDisplay::DebugDisplay ( )

Definition at line 103 of file DebugDisplay.cpp.

◆ ~DebugDisplay()

virtual DebugDisplay::~DebugDisplay ( )
inlinevirtual

Definition at line 118 of file DebugDisplay.h.

Member Function Documentation

◆ getCursorXPos()

Int DebugDisplay::getCursorXPos ( void )
virtual

Get current X position of cursor.

Implements DebugDisplayInterface.

Definition at line 135 of file DebugDisplay.cpp.

◆ getCursorYPos()

Int DebugDisplay::getCursorYPos ( void )
virtual

Get current Y position of cursor.

Implements DebugDisplayInterface.

Definition at line 144 of file DebugDisplay.cpp.

◆ getHeight()

Int DebugDisplay::getHeight ( void )
virtual

Get character height of display.

Implements DebugDisplayInterface.

Definition at line 162 of file DebugDisplay.cpp.

◆ getWidth()

Int DebugDisplay::getWidth ( void )
virtual

Get character width of display.

Implements DebugDisplayInterface.

Definition at line 153 of file DebugDisplay.cpp.

◆ printf()

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

Print formatted text at current cursor position.

Implements DebugDisplayInterface.

Definition at line 198 of file DebugDisplay.cpp.

◆ reset()

void DebugDisplay::reset ( void )
virtual

Reset back to default settings.

Implements DebugDisplayInterface.

Definition at line 114 of file DebugDisplay.cpp.

◆ setCursorPos()

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

Set new cursor position.

Implements DebugDisplayInterface.

Definition at line 125 of file DebugDisplay.cpp.

◆ setLeftMargin()

void DebugDisplay::setLeftMargin ( Int leftPos)
virtual

set left margin position

Implements DebugDisplayInterface.

Definition at line 189 of file DebugDisplay.cpp.

◆ setRightMargin()

void DebugDisplay::setRightMargin ( Int rightPos)
virtual

set right margin position

Implements DebugDisplayInterface.

Definition at line 180 of file DebugDisplay.cpp.

◆ setTextColor()

void DebugDisplay::setTextColor ( Color color)
virtual

set text color

Implements DebugDisplayInterface.

Definition at line 171 of file DebugDisplay.cpp.

Member Data Documentation

◆ m_height

Int DebugDisplay::m_height
protected

Character height of display.

Definition at line 137 of file DebugDisplay.h.

◆ m_leftMargin

Int DebugDisplay::m_leftMargin
protected

Left margin position.

Definition at line 139 of file DebugDisplay.h.

◆ m_rightMargin

Int DebugDisplay::m_rightMargin
protected

Right margin position.

Definition at line 138 of file DebugDisplay.h.

◆ m_textColor

Color DebugDisplay::m_textColor
protected

Color to render text in.

Definition at line 133 of file DebugDisplay.h.

◆ m_width

Int DebugDisplay::m_width
protected

Character width of display.

Definition at line 136 of file DebugDisplay.h.

◆ m_xPos

Int DebugDisplay::m_xPos
protected

Current X position of cursor.

Definition at line 134 of file DebugDisplay.h.

◆ m_yPos

Int DebugDisplay::m_yPos
protected

Current Y position of cursor.

Definition at line 135 of file DebugDisplay.h.


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