diff options
Diffstat (limited to 'c/src/lib/libbsp/arm/nds/libnds/include/nds/arm9/console.h')
| -rw-r--r-- | c/src/lib/libbsp/arm/nds/libnds/include/nds/arm9/console.h | 174 |
1 files changed, 87 insertions, 87 deletions
diff --git a/c/src/lib/libbsp/arm/nds/libnds/include/nds/arm9/console.h b/c/src/lib/libbsp/arm/nds/libnds/include/nds/arm9/console.h index 908c325131..19ac5382f9 100644 --- a/c/src/lib/libbsp/arm/nds/libnds/include/nds/arm9/console.h +++ b/c/src/lib/libbsp/arm/nds/libnds/include/nds/arm9/console.h @@ -1,87 +1,87 @@ -/*---------------------------------------------------------------------------------
- $Id$
-
- console functions
-
- Copyright (C) 2005
- Michael Noland (joat)
- Jason Rogers (dovoto)
- Dave Murphy (WinterMute)
-
- This software is provided 'as-is', without any express or implied
- warranty. In no event will the authors be held liable for any
- damages arising from the use of this software.
-
- Permission is granted to anyone to use this software for any
- purpose, including commercial applications, and to alter it and
- redistribute it freely, subject to the following restrictions:
-
- 1. The origin of this software must not be misrepresented; you
- must not claim that you wrote the original software. If you use
- this software in a product, an acknowledgment in the product
- documentation would be appreciated but is not required.
- 2. Altered source versions must be plainly marked as such, and
- must not be misrepresented as being the original software.
- 3. This notice may not be removed or altered from any source
- distribution.
-
-
----------------------------------------------------------------------------------*/
-
-/*! \file console.h
- \brief nds stdio support.
-*/
-
-#ifndef CONSOLE_H
-#define CONSOLE_H
-
-#define CONSOLE_USE_COLOR255 16
-
-#include <nds/jtypes.h>
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-/*! \fn void consoleInit(u16* font, u16* charBase, u16 numCharacters, u8 charStart, u16* map, u8 pal, u8 bitDepth)
- \brief Initialise the console.
- \param font base address of the 16 color font to use
- \param charBase VRAM address to load the font
- \param numCharacters number of characters in the font
- \param charStart ascii code of the first character in the font
- \param map base address of the map to use for printing
- \param pal 16 color palette index to use
- \param bitDepth 256/16 color tile flag.
-
- Initializes the console with the given parameters. When pal is greater than 15 and
- bitDepth is 16 then all non zero entries in the font are set to index 255. When bitDepth
- is not 16 then the font tiles are created as 8bit (256 color).
-
-*/
-void consoleInit(u16* font, u16* charBase, u16 numCharacters, u8 charStart, u16* map, u8 pal, u8 bitDepth);
-/*! \fn void consoleInitDefault(u16* map, u16* charBase, u8 bitDepth)
- \brief Initialize the console with some default parameters.
- \param charBase VRAM address to load the font
- \param map base address of the map to use for printing
- \param bitDepth 256/16 color tile flag
-
- This function calls consoleInit() with the default built in font and character ranges, the parameters given
- are as for that function.
-*/
-void consoleInitDefault(u16* map, u16* charBase, u8 bitDepth);
-
-/*! \fn void consoleDemoInit(void)
-\brief Initialize the console to a default state for prototyping.
-This function sets the console to use sub display, VRAM_C, and BG0 and enables MODE_0_2D on the
-sub display. It is intended for use in prototyping applications which need print ability and not actual
-game use. Print functionality can be utilized with just this call.
-*/
-void consoleDemoInit(void);
-/*! \fn void consoleClear(void)
-\brief Clears the screan by iprintf("\x1b[2J");
-*/
-void consoleClear(void);
-#ifdef __cplusplus
-}
-#endif
-
-#endif
+/*--------------------------------------------------------------------------------- + $Id$ + + console functions + + Copyright (C) 2005 + Michael Noland (joat) + Jason Rogers (dovoto) + Dave Murphy (WinterMute) + + This software is provided 'as-is', without any express or implied + warranty. In no event will the authors be held liable for any + damages arising from the use of this software. + + Permission is granted to anyone to use this software for any + purpose, including commercial applications, and to alter it and + redistribute it freely, subject to the following restrictions: + + 1. The origin of this software must not be misrepresented; you + must not claim that you wrote the original software. If you use + this software in a product, an acknowledgment in the product + documentation would be appreciated but is not required. + 2. Altered source versions must be plainly marked as such, and + must not be misrepresented as being the original software. + 3. This notice may not be removed or altered from any source + distribution. + + +---------------------------------------------------------------------------------*/ + +/*! \file console.h + \brief nds stdio support. +*/ + +#ifndef CONSOLE_H +#define CONSOLE_H + +#define CONSOLE_USE_COLOR255 16 + +#include <nds/jtypes.h> + +#ifdef __cplusplus +extern "C" { +#endif +/*! \fn void consoleInit(u16* font, u16* charBase, u16 numCharacters, u8 charStart, u16* map, u8 pal, u8 bitDepth) + \brief Initialise the console. + \param font base address of the 16 color font to use + \param charBase VRAM address to load the font + \param numCharacters number of characters in the font + \param charStart ascii code of the first character in the font + \param map base address of the map to use for printing + \param pal 16 color palette index to use + \param bitDepth 256/16 color tile flag. + + Initializes the console with the given parameters. When pal is greater than 15 and + bitDepth is 16 then all non zero entries in the font are set to index 255. When bitDepth + is not 16 then the font tiles are created as 8bit (256 color). + +*/ +void consoleInit(u16* font, u16* charBase, u16 numCharacters, u8 charStart, u16* map, u8 pal, u8 bitDepth); +/*! \fn void consoleInitDefault(u16* map, u16* charBase, u8 bitDepth) + \brief Initialize the console with some default parameters. + \param charBase VRAM address to load the font + \param map base address of the map to use for printing + \param bitDepth 256/16 color tile flag + + This function calls consoleInit() with the default built in font and character ranges, the parameters given + are as for that function. +*/ +void consoleInitDefault(u16* map, u16* charBase, u8 bitDepth); + +/*! \fn void consoleDemoInit(void) +\brief Initialize the console to a default state for prototyping. +This function sets the console to use sub display, VRAM_C, and BG0 and enables MODE_0_2D on the +sub display. It is intended for use in prototyping applications which need print ability and not actual +game use. Print functionality can be utilized with just this call. +*/ +void consoleDemoInit(void); +/*! \fn void consoleClear(void) +\brief Clears the screan by iprintf("\x1b[2J"); +*/ +void consoleClear(void); +#ifdef __cplusplus +} +#endif + +#endif |