Console Support

Software console emulation for debugging and simple text output. More...

Files
file	console.c
	Console Support.
file	console.h
	Console Support.

Macros
#define	TAB_WIDTH   4
	Tab width.
#define	HORIZONTAL_PADDING   64
	Padding from the left and right ends of the screen in pixels.
#define	VERTICAL_PADDING   8
	Padding from the top and bottom ends of the screen in pixels.

Functions
void	console_init ()
	Initialize the console.
void	console_close ()
	Close the console.
void	console_set_debug (bool debug)
	Send console output to debug channel.
void	console_set_render_mode (int mode)
	Set the console rendering mode.
void	console_clear ()
	Clear the console.
void	console_render ()
	Render the console.

Console Render Modes
Modes for rendering the console to the screen
#define	RENDER_MANUAL   0
	Manual Rendering.
#define	RENDER_AUTOMATIC   1
	Automatic Rendering.

Console Dimensions
#define	CONSOLE_WIDTH   64
	The console width in characters.
#define	CONSOLE_HEIGHT   28
	The console height in characters.

Detailed Description

Software console emulation for debugging and simple text output.

Console support is provided as a poor-man's console for simple debugging on the N64. It does not respect common escape sequences and is nonstandard in size. When using the console, code should be careful to make sure that the display system has not been initialized. Similarly, if the display system is needed, code should be sure that the console is not initialized.

Code wishing to use the console should first initialize the console support in libdragon with console_init. Once the console has been initialized, it wil operate in one of two modes. In automatic mode, every write to the console will be immediately displayed on the screen. The console will be scrolled when the buffer fills. In manual mode, the console will only be displayed after calling console_render. To set the render mode, use console_set_render_mode. To add data to the console, use printf or iprintf. To clear the console and reset the scroll, use console_clear. Once the console is not needed or when the code wishes to switch to the display subsystem, console_clear should be called to cleanly shut down the console support.

Macro Definition Documentation

RENDER_MANUAL

#define RENDER_MANUAL   0

Manual Rendering.

The user must call console_render when the screen should be updated

RENDER_AUTOMATIC

#define RENDER_AUTOMATIC   1

Automatic Rendering.

The screen will be updated on every console interaction

CONSOLE_WIDTH

#define CONSOLE_WIDTH   64

The console width in characters.

Note

Right padding is not enforced by code, adjust this to fit into [horizontal resolution] - 2 * HORIZONTAL_PADDING

CONSOLE_HEIGHT

#define CONSOLE_HEIGHT   28

The console height in characters.

Note

Bottom padding is not enforced by code, adjust this to fit into [vertical resolution] - 2 * VERTICAL_PADDING

TAB_WIDTH

#define TAB_WIDTH   4

Tab width.

Note

This needs to divide evenly into CONSOLE_WIDTH

HORIZONTAL_PADDING

#define HORIZONTAL_PADDING   64

Padding from the left and right ends of the screen in pixels.

Note

This should be ~10% of the horizontal resolution to be safely visible

Function Documentation

console_init()

void console_init

(

)

Initialize the console.

Initialize the console system. This will initialize the video properly, so a call to the display_init() fuction is not necessary.

console_close()

void console_close

(

)

Close the console.

Free the console system. This will clean up any dynamic memory that was in use.

console_set_debug()

void console_set_debug

(

bool

debug

)

Send console output to debug channel.

Configure whether the console output should be redirected to the debug channel as well (stderr), that can be sent over USB for development purposes. See debugf for more information.

Parameters

[in]

debug

True if console output should also be sent to the debugging channel, false otherwise

console_set_render_mode()

void console_set_render_mode

(

int

mode

)

Set the console rendering mode.

This sets the render mode of the console. The RENDER_AUTOMATIC mode allows console_printf to immediately be placed onto the screen. This is very similar to a normal console on a unix/windows system. The RENDER_MANUAL mode allows console_printf to be buffered, and displayed at a later date using console_render(). This is to allow a rendering interface somewhat analogous to curses

Parameters

[in]

mode

Render mode (RENDER_AUTOMATIC or RENDER_MANUAL)

console_clear()

void console_clear

(

)

Clear the console.

Clear the console and set the virtual cursor back to the top left.

console_render()

void console_render

(

)

Render the console.

Render the console to the screen. This should be called when in manual rendering mode to display the console to the screen. In automatic mode it is not necessary to call.

The color that is used to draw the text can be set using graphics_set_color.

Do not call while interrupts are disabled, or it will lock the system.