git.sur5r.net Git - cc65/blob - include/tgi.h

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                                     tgi.h                                 */
   4 /*                                                                           */
   5 /*                            Tiny graphics interface                        */
   6 /*                                                                           */
   7 /*                                                                           */
   8 /*                                                                           */
   9 /* (C) 2002      Ullrich von Bassewitz                                       */
  10 /*               Wacholderweg 14                                             */
  11 /*               D-70597 Stuttgart                                           */
  12 /* EMail:        uz@musoftware.de                                            */
  13 /*                                                                           */
  14 /*                                                                           */
  15 /* This software is provided 'as-is', without any expressed or implied       */
  16 /* warranty.  In no event will the authors be held liable for any damages    */
  17 /* arising from the use of this software.                                    */
  18 /*                                                                           */
  19 /* Permission is granted to anyone to use this software for any purpose,     */
  20 /* including commercial applications, and to alter it and redistribute it    */
  21 /* freely, subject to the following restrictions:                            */
  22 /*                                                                           */
  23 /* 1. The origin of this software must not be misrepresented; you must not   */
  24 /*    claim that you wrote the original software. If you use this software   */
  25 /*    in a product, an acknowledgment in the product documentation would be  */
  26 /*    appreciated but is not required.                                       */
  27 /* 2. Altered source versions must be plainly marked as such, and must not   */
  28 /*    be misrepresented as being the original software.                      */
  29 /* 3. This notice may not be removed or altered from any source              */
  30 /*    distribution.                                                          */
  31 /*                                                                           */
  32 /*****************************************************************************/
  33
  34
  35
  36 #ifndef _TGI_H
  37 #define _TGI_H
  38
  39
  40
  41 #ifndef _TGI_MODE_H
  42 #include "tgi/tgi-mode.h"
  43 #endif
  44 #ifndef _TGI_ERROR_H
  45 #include "tgi/tgi-error.h"
  46 #endif
  47
  48
  49
  50 /*****************************************************************************/
  51 /*                                  Definitions                              */
  52 /*****************************************************************************/
  53
  54
  55
  56 /* Constants used for tgi_textstyle */
  57 #define TGI_TEXT_HORIZONTAL     0
  58 #define TGI_TEXT_VERTICAL       1
  59
  60
  61
  62 /*****************************************************************************/
  63 /*                                 Functions                                 */
  64 /*****************************************************************************/
  65
  66
  67
  68 void __fastcall__ tgi_load (unsigned char mode);
  69 /* Install the matching driver for the given mode. Will just load the driver
  70  * and check if loading was successul. Will not switch to gaphics mode.
  71  */
  72
  73 void __fastcall__ tgi_load_driver (const char* name);
  74 /* Install the given driver. This function is identical to tgi_load with the
  75  * only difference that the name of the driver is specified explicitly. You
  76  * should NOT use this function in most cases, use tgi_load() instead.
  77  */
  78
  79 void __fastcall__ tgi_unload (void);
  80 /* Unload the currently loaded driver. Will call tgi_done if necessary. */
  81
  82 void __fastcall__ tgi_init (unsigned char mode);
  83 /* Initialize the given graphics mode. */
  84
  85 void __fastcall__ tgi_done (void);
  86 /* End graphics mode, switch back to text mode. Will NOT unload the driver! */
  87
  88 unsigned char __fastcall__ tgi_geterror (void);
  89 /* Return the error code for the last operation. This will also clear the
  90  * error.
  91  */
  92
  93 void __fastcall__ tgi_clear (void);
  94 /* Clear the screen. */
  95
  96 void __fastcall__ tgi_getpagecount (void);
  97 /* Returns the number of screen pages available. */
  98
  99 void __fastcall__ tgi_setviewpage (unsigned char page);
 100 /* Set the visible page. Will set an error if the page is not available. */
 101
 102 void __fastcall__ tgi_setdrawpage (unsigned char page);
 103 /* Set the drawable page. Will set an error if the page is not available. */
 104
 105 unsigned char __fastcall__ tgi_getcolorcount (void);
 106 /* Get the number of available colors. */
 107
 108 unsigned char __fastcall__ tgi_getmaxcolor (void);
 109 /* Return the maximum supported color number (the number of colors would
 110  * then be getmaxcolor()+1).
 111  */
 112
 113 void __fastcall__ tgi_setcolor (unsigned char color);
 114 /* Set the current drawing color. */
 115
 116 unsigned char __fastcall__ tgi_getcolor (void);
 117 /* Return the current drawing color. */
 118
 119 void __fastcall__ tgi_setpalette (const unsigned char* palette);
 120 /* Set the palette (not available with all drivers/hardware). palette is
 121  * a pointer to as many entries as there are colors.
 122  */
 123
 124 const unsigned char* __fastcall__ tgi_getpalette (void);
 125 /* Return the current palette. Will return NULL for drivers that do not
 126  * support palettes.
 127  */
 128
 129 const unsigned char* __fastcall__ tgi_getdefpalette (void);
 130 /* Return the default palette. Will return NULL for drivers that do not
 131  * support palettes.
 132  */
 133
 134 unsigned __fastcall__ tgi_getxres (void);
 135 /* Return the resolution in X direction. */
 136
 137 unsigned __fastcall__ tgi_getmaxx (void);
 138 /* Return the maximum x coordinate. The resolution in x direction is
 139  * getmaxx() + 1
 140  */
 141
 142 unsigned __fastcall__ tgi_getyres (void);
 143 /* Return the resolution in Y direction. */
 144
 145 unsigned __fastcall__ tgi_getmaxy (void);
 146 /* Return the maximum y coordinate. The resolution in y direction is
 147  * getmaxy() + 1
 148  */
 149
 150 unsigned char __fastcall__ tgi_getpixel (int x, int y);
 151 /* Get the color value of a pixel. */
 152
 153 void __fastcall__ tgi_setpixel (int x, int y);
 154 /* Plot a pixel in the current drawing color. */
 155
 156 void __fastcall__ tgi_gotoxy (int x, int y);
 157 /* Set the graphics cursor to the given position. */
 158
 159 void __fastcall__ tgi_line (int x1, int y1, int x2, int y2);
 160 /* Draw a line in the current drawing color. The graphics cursor will
 161  * be set to x2/y2 by this call.
 162  */
 163
 164 void __fastcall__ tgi_lineto (int x2, int y2);
 165 /* Draw a line in the current drawing color from the graphics cursor to the
 166  * new end point. The graphics cursor will be updated to x2/y2.
 167  */
 168
 169 void __fastcall__ tgi_circle (int x, int y, unsigned char radius);
 170 /* Draw a circle in the current drawing color. */
 171
 172 void __fastcall__ tgi_bar (int x1, int y1, int x2, int y2);
 173 /* Draw a bar (a filled rectangle) using the current color. */
 174
 175 void __fastcall__ tgi_textstyle (unsigned char magx, unsigned char magy,
 176                                  unsigned char dir);
 177 /* Set the style for text output. */
 178
 179 unsigned __fastcall__ tgi_textwidth (const char* s);
 180 /* Calculate the width of the text in pixels according to the current text
 181  * style.
 182  */
 183
 184 unsigned __fastcall__ tgi_textheight (const char* s);
 185 /* Calculate the height of the text in pixels according to the current text
 186  * style.
 187  */
 188
 189 void __fastcall__ tgi_outtext (const char* s);
 190 /* Output text at the current graphics cursor position. The graphics cursor
 191  * is moved to the end of the text.
 192  */
 193
 194 void __fastcall__ tgi_outtextxy (int x, int y, const char* s);
 195 /* Output text at the given cursor position. The graphics cursor is moved to
 196  * the end of the text.
 197  */
 198
 199
 200
 201 /* End of tgi.h */
 202 #endif
 203
 204
 205