|
sgdk
|
TTY text console. More...
#include "config.h"#include "types.h"#include "vdp.h"#include "vdp_bg.h"#include "vdp_tile.h"#include "sys.h"#include "ym2612.h"#include "psg.h"#include "z80_ctrl.h"#include "memory.h"#include "ext/console.h"Defines | |
| #define | CONSOLE_TAB_SIZE 8 |
Functions | |
| u16 | vsprintf (char *buf, const char *fmt, va_list args) |
| int | CON_sprintf (char *buf, const char *fmt,...) |
| int | CON_snprintf (char *buf, int count, const char *fmt,...) |
| void | CON_setVsprintf (vsprintf_t vsprintf_func) |
| Register a standard vsprintf function as callback for CON_sprintf() | |
| void | CON_setVsnprintf (vsnprintf_t vsnprintf_func) |
| Register a standard vsnprintf function as callback for CON_snprintf() | |
| void | CON_setConsoleSize (u16 left, u16 top, u16 width, u16 height) |
| Set the size of the console window. | |
| void | CON_setLineBufferSize (u16 size) |
| Set the size of the character line buffer. | |
| void | CON_setTransferMethod (TransferMethod tm) |
| Set the transfer method used to upload the console tile buffer to VDP RAM. | |
| void | CON_reset () |
| Reset the console. | |
| void | CON_systemResetOnNextWrite () |
| Reset the system to the SGDK default state when CON_write() is called next time. | |
| void | CON_clear () |
| Clear the console window. | |
| void | CON_setCursorPosition (u16 x, u16 y) |
| Set a new cursor position. | |
| V2u16 | CON_getCursorPosition () |
| Return the current cursor position. | |
| int | CON_write (const char *fmt,...) |
TTY text console.
This unit provides a simple TTY text console. Characters are written as a stream, where lines are automatically wrapped if the horizontal border of the screen is reached. When at the bottom of the screen window, the console content is moved up by one text line and a blank row is inserted.
Per default, the console occupies a standad screen of 40x28 tiles. All text attributes, such as font, palette, plane etc., are taken from SGDK text settings. Screen updates are done using DMA transfer mode (which can be changed with CON_setTransferMethod()).
One of the use cases are assert messages. To this end, the Genesis state can be automatically reset before text is displayed (see assert macro in console.h).
| void CON_clear | ( | ) |
Clear the console window.
This clears the console window by filling it with space characters. It is assumed that the first tile of the font is a space character. DMA settings apply here as well.
| V2u16 CON_getCursorPosition | ( | ) |
Return the current cursor position.
| void CON_reset | ( | ) |
Reset the console.
This function is a shortcut for:
CON_setConsoleSize(0, 0, 40, 28);
CON_setLineBufferSize(160);
CON_setTransferMethod(DMA);
Set the size of the console window.
| left | Position of the leftmost window column in tiles. Default is 0. |
| top | Position of the topmost window row in tiles. Default is 0. |
| width | Width of the console window in tiles. Default is 40. |
| height | Height of the console window in tiles. Default is 28. |
If either width or height are 0 then VDP_getScreenWidth() and VDP_getScreenHeight() will be used to determine suitable default values.
Set a new cursor position.
| x | New cursor x position. |
| y | New cursor y position. |
This function specifies a new column and row for the cursor. This is the position where the next character will appear when CON_write() is processed. A position of (0,0) relates to the tile in the top/left corner.
| void CON_setLineBufferSize | ( | u16 | size | ) |
Set the size of the character line buffer.
| size | Buffer size in bytes. This is the number of characters the buffer can hold including a terminating null-character. |
Sets the size of the character buffer that is used internally to compose the formatted output string which is printed on the console.
Upon calling CON_setLineBufferSize(), the previous line buffer memory is immedieately freed. The new buffer will be allocated once the next call to CON_write() occurs.
Per default, the buffer size is set to 160 characters. Note that if only a vsprintf function is registered (see CON_setVsprintf()), the user is responsible for making sure a call to CON_write() does not exceed the line buffer. In case a vsnprintf function is registered (see CON_setVsnprintf()), it will automtically check the buffer size and prevent overflows.
| void CON_setTransferMethod | ( | TransferMethod | tm | ) |
Set the transfer method used to upload the console tile buffer to VDP RAM.
| tm | Transfer method. Accepted values are:
|
This sets the transfer method used with VDP_setTileMapDataRect(). The default value is DMA, which will cause an immediate upload. Note that when DMA_QUEUE or DMA_QUEUE_COPY is used, the user is responsible for triggering DMA upload, e.g., by calling SYS_doVBlankProcess().
| void CON_setVsnprintf | ( | vsnprintf_t | vsnprintf_func | ) |
Register a standard vsnprintf function as callback for CON_snprintf()
| vsnprintf_func | Function pointer to a standard C library vsnprintf function |
Registers a callback function that will be wrapped by CON_snprintf(). The funcion supplied needs to be a vsnprintf function that takes va_list as arguments, defined as follows:
typedef int (*vsnprintf_t)(char *buf, int count, const char *fmt, va_list args);
A possible implementation is stbsp_vsnprintf() (http://github.com/nothings/stb).
| void CON_setVsprintf | ( | vsprintf_t | vsprintf_func | ) |
Register a standard vsprintf function as callback for CON_sprintf()
| vsprintf_func | Function pointer to a standard C library vsprintf function |
Registers a callback function that will be wrapped by CON_sprintf(). The funcion supplied needs to be a vsprintf function that takes va_list as arguments, defined as follows:
typedef int (*vsprintf_t)(char *buf, const char *fmt, va_list args);
Possible implementations are SGDK's vsprintf() or alternatively stbsp_vsprintf() (http://github.com/nothings/stb).
| void CON_systemResetOnNextWrite | ( | ) |
Reset the system to the SGDK default state when CON_write() is called next time.
To reset the system the following SGDK functions will be called:
1.7.4