1 /*****************************************************************************/
5 /* Tiny graphics interface */
9 /* (C) 2002-2004 Ullrich von Bassewitz */
10 /* Römerstrasse 52 */
11 /* D-70794 Filderstadt */
12 /* EMail: uz@cc65.org */
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. */
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: */
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 */
32 /*****************************************************************************/
42 #include <tgi/tgi-mode.h>
45 #include <tgi/tgi-error.h>
50 /*****************************************************************************/
52 /*****************************************************************************/
56 /* Constants used for tgi_textstyle */
57 #define TGI_TEXT_HORIZONTAL 0
58 #define TGI_TEXT_VERTICAL 1
62 /*****************************************************************************/
64 /*****************************************************************************/
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
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()
81 void __fastcall__ tgi_unload (void);
82 /* Uninstall, then unload the currently loaded driver. Will call tgi_done if
86 void __fastcall__ tgi_install (void* driver);
87 /* Install an already loaded driver. */
89 void __fastcall__ tgi_uninstall (void);
90 /* Uninstall the currently loaded driver but do not unload it. Will call
91 * tgi_done if necessary.
94 void __fastcall__ tgi_init (void);
95 /* Initialize the already loaded graphics driver. */
97 void __fastcall__ tgi_done (void);
98 /* End graphics mode, switch back to text mode. Will NOT uninstall or unload
102 unsigned char __fastcall__ tgi_geterror (void);
103 /* Return the error code for the last operation. This will also clear the
107 const char* __fastcall__ tgi_geterrormsg (unsigned char code);
108 /* Get an error message describing the error in code. */
110 void __fastcall__ tgi_clear (void);
111 /* Clear the screen. */
113 unsigned __fastcall__ tgi_getpagecount (void);
114 /* Returns the number of screen pages available. */
116 void __fastcall__ tgi_setviewpage (unsigned char page);
117 /* Set the visible page. Will set an error if the page is not available. */
119 void __fastcall__ tgi_setdrawpage (unsigned char page);
120 /* Set the drawable page. Will set an error if the page is not available. */
122 unsigned char __fastcall__ tgi_getcolorcount (void);
123 /* Get the number of available colors. */
125 unsigned char __fastcall__ tgi_getmaxcolor (void);
126 /* Return the maximum supported color number (the number of colors would
127 * then be getmaxcolor()+1).
130 void __fastcall__ tgi_setcolor (unsigned char color);
131 /* Set the current drawing color. */
133 unsigned char __fastcall__ tgi_getcolor (void);
134 /* Return the current drawing color. */
136 void __fastcall__ tgi_setpalette (const unsigned char* palette);
137 /* Set the palette (not available with all drivers/hardware). palette is
138 * a pointer to as many entries as there are colors.
141 const unsigned char* __fastcall__ tgi_getpalette (void);
142 /* Return the current palette. */
144 const unsigned char* __fastcall__ tgi_getdefpalette (void);
145 /* Return the default palette. */
147 unsigned __fastcall__ tgi_getxres (void);
148 /* Return the resolution in X direction. */
150 unsigned __fastcall__ tgi_getmaxx (void);
151 /* Return the maximum x coordinate. The resolution in x direction is
155 unsigned __fastcall__ tgi_getyres (void);
156 /* Return the resolution in Y direction. */
158 unsigned __fastcall__ tgi_getmaxy (void);
159 /* Return the maximum y coordinate. The resolution in y direction is
163 unsigned char __fastcall__ tgi_getpixel (int x, int y);
164 /* Get the color value of a pixel. */
166 void __fastcall__ tgi_setpixel (int x, int y);
167 /* Plot a pixel in the current drawing color. */
169 void __fastcall__ tgi_gotoxy (int x, int y);
170 /* Set the graphics cursor to the given position. */
172 void __fastcall__ tgi_line (int x1, int y1, int x2, int y2);
173 /* Draw a line in the current drawing color. The graphics cursor will
174 * be set to x2/y2 by this call.
177 void __fastcall__ tgi_lineto (int x2, int y2);
178 /* Draw a line in the current drawing color from the graphics cursor to the
179 * new end point. The graphics cursor will be updated to x2/y2.
182 void __fastcall__ tgi_circle (int x, int y, unsigned char radius);
183 /* Draw a circle in the current drawing color. */
185 void __fastcall__ tgi_bar (int x1, int y1, int x2, int y2);
186 /* Draw a bar (a filled rectangle) using the current color. */
188 void __fastcall__ tgi_textstyle (unsigned char magx, unsigned char magy,
190 /* Set the style for text output. */
192 unsigned __fastcall__ tgi_textwidth (const char* s);
193 /* Calculate the width of the text in pixels according to the current text
197 unsigned __fastcall__ tgi_textheight (const char* s);
198 /* Calculate the height of the text in pixels according to the current text
202 void __fastcall__ tgi_outtext (const char* s);
203 /* Output text at the current graphics cursor position. The graphics cursor
204 * is moved to the end of the text.
207 void __fastcall__ tgi_outtextxy (int x, int y, const char* s);
208 /* Output text at the given cursor position. The graphics cursor is moved to
209 * the end of the text.
212 unsigned __fastcall__ tgi_ioctl (unsigned char code, unsigned val);
213 /* Call the driver specific control function. What this function does for
214 * a specific code depends on the driver. The driver will set an error
215 * for unknown codes or values.