gc/ogc/consol.h

   1 #ifndef __CONSOL_H__
   2 #define __CONSOL_H__
   3
   4 /*!
   5  * \file consol.h
   6  * \brief Console subsystem
   7  *
   8  */
   9
  10 #include "gx_struct.h"
  11
  12 /* macros to support old function names */
  13 #define console_init     CON_Init
  14 #define SYS_ConsoleInit  CON_InitEx
  15
  16 #ifdef __cplusplus
  17         extern "C" {
  18 #endif
  19
  20 /*!
  21  * \fn CON_Init(void *framebuffer,int xstart,int ystart,int xres,int yres,int stride)
  22  * \brief Initializes the console subsystem with given parameters
  23  *
  24  * \param[in] framebuffer pointer to the framebuffer used for drawing the characters
  25  * \param[in] xstart,ystart start position of the console output in pixel
  26  * \param[in] xres,yres size of the console in pixel
  27  * \param[in] stride size of one line of the framebuffer in bytes
  28  *
  29  * \return none
  30  */
  31 void CON_Init(void *framebuffer,int xstart,int ystart,int xres,int yres,int stride);
  32
  33 /*!
  34  * \fn s32 CON_InitEx(GXRModeObj *rmode, s32 conXOrigin,s32 conYOrigin,s32 conWidth,s32 conHeight)
  35  * \brief Initialize stdout console
  36  * \param[in] rmode pointer to the video/render mode configuration
  37  * \param[in] conXOrigin starting pixel in X direction of the console output on the external framebuffer
  38  * \param[in] conYOrigin starting pixel in Y direction of the console output on the external framebuffer
  39  * \param[in] conWidth width of the console output 'window' to be drawn
  40  * \param[in] conHeight height of the console output 'window' to be drawn
  41  *
  42  * \return 0 on success, <0 on error
  43  */
  44 s32 CON_InitEx(GXRModeObj *rmode, s32 conXOrigin,s32 conYOrigin,s32 conWidth,s32 conHeight);
  45
  46 /*!
  47  * \fn CON_GetMetrics(int *cols, int *rows)
  48  * \brief retrieve the columns and rows of the current console
  49  *
  50  * \param[out] cols,rows number of columns and rows of the current console
  51  *
  52  * \return none
  53  */
  54 void CON_GetMetrics(int *cols, int *rows);
  55
  56 /*!
  57  * \fn CON_GetPosition(int *col, int *row)
  58  * \brief retrieve the current cursor position of the current console
  59  *
  60  * \param[out] col,row current cursor position
  61  *
  62  * \return none
  63  */
  64 void CON_GetPosition(int *cols, int *rows);
  65
  66 /*!
  67  * \fn CON_EnableGecko(int channel, int safe)
  68  * \brief Enable or disable the USB gecko console.
  69  *
  70  * \param[in] channel EXI channel, or -1 ¨to disable the gecko console
  71  * \param[in] safe If true, use safe mode (wait for peer)
  72  *
  73  * \return none
  74  */
  75 void CON_EnableGecko(int channel,int safe);
  76
  77 #ifdef __cplusplus
  78         }
  79 #endif
  80
  81 #endif