1 /*****************************************************************************/
5 /* Tiny graphics interface */
9 /* (C) 2002-2009, Ullrich von Bassewitz */
10 /* Roemerstrasse 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 /*****************************************************************************/
57 #define TGI_COLOR_BLACK 0
58 #define TGI_COLOR_WHITE 1
60 /* Font constants for use with tgi_textstyle */
61 #define TGI_FONT_BITMAP 0
62 #define TGI_FONT_VECTOR 1
64 /* Direction constants for use with tgi_textstyle */
65 #define TGI_TEXT_HORIZONTAL 0
66 #define TGI_TEXT_VERTICAL 1
68 /* The name of the standard tgi driver for a platform */
69 extern const char tgi_stddrv[];
71 /* The default tgi mode for a platform */
72 extern const unsigned char tgi_stdmode;
74 /* A vector font definition */
75 typedef struct tgi_vectorfont tgi_vectorfont;
79 /*****************************************************************************/
81 /*****************************************************************************/
85 void __fastcall__ tgi_load (unsigned char mode);
86 /* Load and install the matching driver for the given mode. Will just load
87 * the driver and check if loading was successul. Will not switch to gaphics
91 void __fastcall__ tgi_load_driver (const char* name);
92 /* Load and install the given driver. This function is identical to tgi_load
93 * with the only difference that the name of the driver is specified
97 void __fastcall__ tgi_unload (void);
98 /* Uninstall, then unload the currently loaded driver. Will call tgi_done if
102 void __fastcall__ tgi_install (void* driver);
103 /* Install an already loaded driver. */
105 void __fastcall__ tgi_uninstall (void);
106 /* Uninstall the currently loaded driver but do not unload it. Will call
107 * tgi_done if necessary.
110 void __fastcall__ tgi_init (void);
111 /* Initialize the already loaded graphics driver. */
113 void __fastcall__ tgi_done (void);
114 /* End graphics mode, switch back to text mode. Will NOT uninstall or unload
118 const tgi_vectorfont* __fastcall__ tgi_load_vectorfont (const char* name);
119 /* Load a vector font into memory and return it. In case of errors, NULL is
120 * returned and an error is set, which can be retrieved using tgi_geterror.
123 void __fastcall__ tgi_register_vectorfont (const tgi_vectorfont* font);
124 /* Register a vector font for use. More than one vector font can be loaded,
125 * but only one can be active. This function is used to tell which one. Call
126 * with a NULL pointer to unregister the currently registered font.
129 void tgi_free_vectorfont (const tgi_vectorfont* font);
130 /* Free a vector font that was previously loaded. */
132 unsigned char __fastcall__ tgi_geterror (void);
133 /* Return the error code for the last operation. This will also clear the
137 const char* __fastcall__ tgi_geterrormsg (unsigned char code);
138 /* Get an error message describing the error in code. */
140 void __fastcall__ tgi_clear (void);
141 /* Clear the drawpage. */
143 unsigned __fastcall__ tgi_getpagecount (void);
144 /* Returns the number of screen pages available. */
146 void __fastcall__ tgi_setviewpage (unsigned char page);
147 /* Set the visible page. Will set an error if the page is not available. */
149 void __fastcall__ tgi_setdrawpage (unsigned char page);
150 /* Set the drawable page. Will set an error if the page is not available. */
152 unsigned char __fastcall__ tgi_getcolorcount (void);
153 /* Get the number of available colors. */
155 unsigned char __fastcall__ tgi_getmaxcolor (void);
156 /* Return the maximum supported color number (the number of colors would
157 * then be getmaxcolor()+1).
160 void __fastcall__ tgi_setcolor (unsigned char color);
161 /* Set the current drawing color. */
163 unsigned char __fastcall__ tgi_getcolor (void);
164 /* Return the current drawing color. */
166 void __fastcall__ tgi_setpalette (const unsigned char* palette);
167 /* Set the palette (not available with all drivers/hardware). palette is
168 * a pointer to as many entries as there are colors.
171 const unsigned char* __fastcall__ tgi_getpalette (void);
172 /* Return the current palette. */
174 const unsigned char* __fastcall__ tgi_getdefpalette (void);
175 /* Return the default palette. */
177 unsigned __fastcall__ tgi_getxres (void);
178 /* Return the resolution in X direction. */
180 unsigned __fastcall__ tgi_getmaxx (void);
181 /* Return the maximum x coordinate. The resolution in x direction is
185 unsigned __fastcall__ tgi_getyres (void);
186 /* Return the resolution in Y direction. */
188 unsigned __fastcall__ tgi_getmaxy (void);
189 /* Return the maximum y coordinate. The resolution in y direction is
193 unsigned char __fastcall__ tgi_getpixel (int x, int y);
194 /* Get the color value of a pixel. */
196 void __fastcall__ tgi_setpixel (int x, int y);
197 /* Plot a pixel in the current drawing color. */
199 void __fastcall__ tgi_gotoxy (int x, int y);
200 /* Set the graphics cursor to the given position. */
202 void __fastcall__ tgi_line (int x1, int y1, int x2, int y2);
203 /* Draw a line in the current drawing color. The graphics cursor will
204 * be set to x2/y2 by this call.
207 void __fastcall__ tgi_lineto (int x2, int y2);
208 /* Draw a line in the current drawing color from the graphics cursor to the
209 * new end point. The graphics cursor will be updated to x2/y2.
212 void __fastcall__ tgi_circle (int x, int y, unsigned char radius);
213 /* Draw a circle in the current drawing color. */
215 void __fastcall__ tgi_bar (int x1, int y1, int x2, int y2);
216 /* Draw a bar (a filled rectangle) using the current color. */
218 void __fastcall__ tgi_textstyle (unsigned magwidth, unsigned magheight,
220 /* Set the style for text output. The scaling factors for width and height
221 * are 8.8 fixed point values. This means that $100 = 1 $200 = 2 etc.
224 unsigned __fastcall__ tgi_textwidth (const char* s);
225 /* Calculate the width of the text in pixels according to the current text
229 unsigned __fastcall__ tgi_textheight (const char* s);
230 /* Calculate the height of the text in pixels according to the current text
234 void __fastcall__ tgi_outtext (const char* s);
235 /* Output text at the current graphics cursor position. The graphics cursor
236 * is moved to the end of the text.
239 void __fastcall__ tgi_outtextxy (int x, int y, const char* s);
240 /* Output text at the given cursor position. The graphics cursor is moved to
241 * the end of the text.
244 unsigned __fastcall__ tgi_ioctl (unsigned char code, unsigned val);
245 /* Call the driver specific control function. What this function does for
246 * a specific code depends on the driver. The driver will set an error
247 * for unknown codes or values.