libOGC  1.0
 All Data Structures Files Functions Variables Typedefs Macros Modules Pages
Macros | Functions
consol.h File Reference

Console subsystem. More...

#include "gx_struct.h"

Macros

#define console_init   CON_Init
 
#define SYS_ConsoleInit   CON_InitEx
 

Functions

void CON_EnableGecko (int channel, int safe)
 Enable or disable the USB gecko console. More...
 
void CON_GetMetrics (int *cols, int *rows)
 retrieve the columns and rows of the current console More...
 
void CON_GetPosition (int *cols, int *rows)
 retrieve the current cursor position of the current console More...
 
void CON_Init (void *framebuffer, int xstart, int ystart, int xres, int yres, int stride)
 Initializes the console subsystem with given parameters. More...
 
s32 CON_InitEx (GXRModeObj *rmode, s32 conXOrigin, s32 conYOrigin, s32 conWidth, s32 conHeight)
 Initialize stdout console. More...
 

Detailed Description

Console subsystem.

Function Documentation

CON_EnableGecko ( int  channel,
int  safe 
)

Enable or disable the USB gecko console.

Parameters
[in]channelEXI channel, or -1 Ęto disable the gecko console
[in]safeIf true, use safe mode (wait for peer)
Returns
none
CON_GetMetrics ( int *  cols,
int *  rows 
)

retrieve the columns and rows of the current console

Parameters
[out]cols,rowsnumber of columns and rows of the current console
Returns
none
CON_GetPosition ( int *  col,
int *  row 
)

retrieve the current cursor position of the current console

Parameters
[out]col,rowcurrent cursor position
Returns
none
CON_Init ( void *  framebuffer,
int  xstart,
int  ystart,
int  xres,
int  yres,
int  stride 
)

Initializes the console subsystem with given parameters.

Parameters
[in]framebufferpointer to the framebuffer used for drawing the characters
[in]xstart,ystartstart position of the console output in pixel
[in]xres,yressize of the console in pixel
[in]stridesize of one line of the framebuffer in bytes
Returns
none
s32 CON_InitEx ( GXRModeObj rmode,
s32  conXOrigin,
s32  conYOrigin,
s32  conWidth,
s32  conHeight 
)

Initialize stdout console.

Parameters
[in]rmodepointer to the video/render mode configuration
[in]conXOriginstarting pixel in X direction of the console output on the external framebuffer
[in]conYOriginstarting pixel in Y direction of the console output on the external framebuffer
[in]conWidthwidth of the console output 'window' to be drawn
[in]conHeightheight of the console output 'window' to be drawn
Returns
0 on success, <0 on error