1. Home
  2. Documentation
  3. API
  4. Debug Class Reference

Debug Class Reference

#include <Debug.h>

Inheritance diagram for Debug:
Tool

# Public Member Functions

override void update ()
 Update the tool's state.
override void show ()
 Show the tool.
override void hide ()
 Hide the tool.
override void processUserInput (uint16 pressedKey)

# Private Attributes

VirtualList pages
 Degug pages.
VirtualList subPages
 Debug sub pages.
VirtualNode currentPage
 Current page's node.
VirtualNode currentSubPage
 Current sub page's node.
int8 spriteIndex
 Current sprite's index.
int8 bgmapSegment
 Currently displayed BGMAP segment.
uint8 bgmapSegmentDiplayedSection
 Currently displayed part of BGMAP memory.
int32 objectSegment
 Currently displayed OBJECT segment.
int32 charSegment
 Currently displayed CHAR memory segment.
int32 sramPage
 Currently displayed SRAM page.
- Private Attributes inherited from Tool
ToolState toolState

# Additional Inherited Members

- Private Member Functions inherited from Tool
void constructor ()
 Class' constructor.
void setToolState (ToolState toolState)
virtual void dimmGame ()
 Dimm down the game.
virtual void lightUpGame ()
 Light up the game.

# Detailed Description

Class Debug

Inherits from Tool

Implements a tool that displays various debug information.

Definition at line 44 of file Debug.h.

# Member Function Documentation

# hide()

override void Debug::hide ( )
virtual

Hide the tool.

Implements Tool.

# processUserInput()

override void Debug::processUserInput ( uint16 pressedKey)
virtual

Process the provided user pressed key.

Parameters
pressedKeyUser pressed key

Implements Tool.

# show()

override void Debug::show ( )
virtual

Show the tool.

Implements Tool.

# update()

override void Debug::update ( )
virtual

Update the tool's state.

Implements Tool.

# Member Data Documentation

# bgmapSegment

int8 Debug::bgmapSegment
private

Currently displayed BGMAP segment.

Definition at line 62 of file Debug.h.

# bgmapSegmentDiplayedSection

uint8 Debug::bgmapSegmentDiplayedSection
private

Currently displayed part of BGMAP memory.

Definition at line 65 of file Debug.h.

# charSegment

int32 Debug::charSegment
private

Currently displayed CHAR memory segment.

Definition at line 71 of file Debug.h.

# currentPage

VirtualNode Debug::currentPage
private

Current page's node.

Definition at line 53 of file Debug.h.

# currentSubPage

VirtualNode Debug::currentSubPage
private

Current sub page's node.

Definition at line 56 of file Debug.h.

# objectSegment

int32 Debug::objectSegment
private

Currently displayed OBJECT segment.

Definition at line 68 of file Debug.h.

# pages

VirtualList Debug::pages
private

Degug pages.

Definition at line 47 of file Debug.h.

# spriteIndex

int8 Debug::spriteIndex
private

Current sprite's index.

Definition at line 59 of file Debug.h.

# sramPage

int32 Debug::sramPage
private

Currently displayed SRAM page.

Definition at line 74 of file Debug.h.

# subPages

VirtualList Debug::subPages
private

Debug sub pages.

Definition at line 50 of file Debug.h.


The documentation for this class was generated from the following file:
  • VUEngine-Core/source/Debugging/Tool/Debug/Debug.h