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-2003 Ullrich von Bassewitz                                       */
  10 /*               Römerstrasse 52                                             */
  11 /*               D-70794 Filderstadt                                         */
  12 /* EMail:        uz@cc65.org                                                 */
  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 /* Load and install the matching driver for the given mode. Will just load
  70  * the driver and check if loading was successul. Will not switch to gaphics
  71  * mode.
  72  */
  73
  74 void __fastcall__ tgi_load_driver (const char* name);
  75 /* Load and install the given driver. This function is identical to tgi_load
  76  * with the only difference that the name of the driver is specified
  77  * explicitly. You should NOT use this function in most cases, use tgi_load()
  78  * instead.
  79  */
  80
  81 void __fastcall__ tgi_unload (void);
  82 /* Uninstall, then unload the currently loaded driver. Will call tgi_done if
  83  * necessary.
  84  */
  85
  86 void __fastcall__ tgi_install (void* driver);
  87 /* Install an already loaded driver. */
  88
  89 void __fastcall__ tgi_uninstall (void);
  90 /* Uninstall the currently loaded driver but do not unload it. Will call
  91  * tgi_done if necessary.
  92  */
  93
  94 void __fastcall__ tgi_init (void);
  95 /* Initialize the already loaded graphics driver. */
  96
  97 void __fastcall__ tgi_done (void);
  98 /* End graphics mode, switch back to text mode. Will NOT uninstall or unload
  99  * the driver!
 100  */
 101
 102 unsigned char __fastcall__ tgi_geterror (void);
 103 /* Return the error code for the last operation. This will also clear the
 104  * error.
 105  */
 106
 107 void __fastcall__ tgi_clear (void);
 108 /* Clear the screen. */
 109
 110 void __fastcall__ tgi_getpagecount (void);
 111 /* Returns the number of screen pages available. */
 112
 113 void __fastcall__ tgi_setviewpage (unsigned char page);
 114 /* Set the visible page. Will set an error if the page is not available. */
 115
 116 void __fastcall__ tgi_setdrawpage (unsigned char page);
 117 /* Set the drawable page. Will set an error if the page is not available. */
 118
 119 unsigned char __fastcall__ tgi_getcolorcount (void);
 120 /* Get the number of available colors. */
 121
 122 unsigned char __fastcall__ tgi_getmaxcolor (void);
 123 /* Return the maximum supported color number (the number of colors would
 124  * then be getmaxcolor()+1).
 125  */
 126
 127 void __fastcall__ tgi_setcolor (unsigned char color);
 128 /* Set the current drawing color. */
 129
 130 unsigned char __fastcall__ tgi_getcolor (void);
 131 /* Return the current drawing color. */
 132
 133 void __fastcall__ tgi_setpalette (const unsigned char* palette);
 134 /* Set the palette (not available with all drivers/hardware). palette is
 135  * a pointer to as many entries as there are colors.
 136  */
 137
 138 const unsigned char* __fastcall__ tgi_getpalette (void);
 139 /* Return the current palette. */
 140
 141 const unsigned char* __fastcall__ tgi_getdefpalette (void);
 142 /* Return the default palette. */
 143
 144 unsigned __fastcall__ tgi_getxres (void);
 145 /* Return the resolution in X direction. */
 146
 147 unsigned __fastcall__ tgi_getmaxx (void);
 148 /* Return the maximum x coordinate. The resolution in x direction is
 149  * getmaxx() + 1
 150  */
 151
 152 unsigned __fastcall__ tgi_getyres (void);
 153 /* Return the resolution in Y direction. */
 154
 155 unsigned __fastcall__ tgi_getmaxy (void);
 156 /* Return the maximum y coordinate. The resolution in y direction is
 157  * getmaxy() + 1
 158  */
 159
 160 unsigned char __fastcall__ tgi_getpixel (int x, int y);
 161 /* Get the color value of a pixel. */
 162
 163 void __fastcall__ tgi_setpixel (int x, int y);
 164 /* Plot a pixel in the current drawing color. */
 165
 166 void __fastcall__ tgi_gotoxy (int x, int y);
 167 /* Set the graphics cursor to the given position. */
 168
 169 void __fastcall__ tgi_line (int x1, int y1, int x2, int y2);
 170 /* Draw a line in the current drawing color. The graphics cursor will
 171  * be set to x2/y2 by this call.
 172  */
 173
 174 void __fastcall__ tgi_lineto (int x2, int y2);
 175 /* Draw a line in the current drawing color from the graphics cursor to the
 176  * new end point. The graphics cursor will be updated to x2/y2.
 177  */
 178
 179 void __fastcall__ tgi_circle (int x, int y, unsigned char radius);
 180 /* Draw a circle in the current drawing color. */
 181
 182 void __fastcall__ tgi_bar (int x1, int y1, int x2, int y2);
 183 /* Draw a bar (a filled rectangle) using the current color. */
 184
 185 void __fastcall__ tgi_textstyle (unsigned char magx, unsigned char magy,
 186                                  unsigned char dir);
 187 /* Set the style for text output. */
 188
 189 unsigned __fastcall__ tgi_textwidth (const char* s);
 190 /* Calculate the width of the text in pixels according to the current text
 191  * style.
 192  */
 193
 194 unsigned __fastcall__ tgi_textheight (const char* s);
 195 /* Calculate the height of the text in pixels according to the current text
 196  * style.
 197  */
 198
 199 void __fastcall__ tgi_outtext (const char* s);
 200 /* Output text at the current graphics cursor position. The graphics cursor
 201  * is moved to the end of the text.
 202  */
 203
 204 void __fastcall__ tgi_outtextxy (int x, int y, const char* s);
 205 /* Output text at the given cursor position. The graphics cursor is moved to
 206  * the end of the text.
 207  */
 208
 209
 210
 211 /* End of tgi.h */
 212 #endif
 213
 214
 215