added cvsignore
[btb/d2x.git] / include / gr.h
1 /* $Id: gr.h,v 1.12 2002-08-15 05:42:33 btb Exp $ */
2 /*
3 THE COMPUTER CODE CONTAINED HEREIN IS THE SOLE PROPERTY OF PARALLAX
4 SOFTWARE CORPORATION ("PARALLAX").  PARALLAX, IN DISTRIBUTING THE CODE TO
5 END-USERS, AND SUBJECT TO ALL OF THE TERMS AND CONDITIONS HEREIN, GRANTS A
6 ROYALTY-FREE, PERPETUAL LICENSE TO SUCH END-USERS FOR USE BY SUCH END-USERS
7 IN USING, DISPLAYING,  AND CREATING DERIVATIVE WORKS THEREOF, SO LONG AS
8 SUCH USE, DISPLAY OR CREATION IS FOR NON-COMMERCIAL, ROYALTY OR REVENUE
9 FREE PURPOSES.  IN NO EVENT SHALL THE END-USER USE THE COMPUTER CODE
10 CONTAINED HEREIN FOR REVENUE-BEARING PURPOSES.  THE END-USER UNDERSTANDS
11 AND AGREES TO THE TERMS HEREIN AND ACCEPTS THE SAME BY USE OF THIS FILE.
12 COPYRIGHT 1993-1999 PARALLAX SOFTWARE CORPORATION.  ALL RIGHTS RESERVED.
13 */
14
15 #ifndef _GR_H
16 #define _GR_H
17
18 #include "pstypes.h"
19 #include "fix.h"
20
21 extern int Gr_transparency_color;
22
23 #define TRANSPARENCY_COLOR  Gr_transparency_color   // palette entry of transparency color -- 255 on pc, 0 on the mac
24
25 #define GR_FADE_LEVELS 34
26 #define GR_ACTUAL_FADE_LEVELS 32
27
28 #define GWIDTH  grd_curcanv->cv_bitmap.bm_w
29 #define GHEIGHT grd_curcanv->cv_bitmap.bm_h
30 #define SWIDTH  (grd_curscreen->sc_w)
31 #define SHEIGHT (grd_curscreen->sc_h)
32
33
34 extern int Gr_scanline_darkening_level;
35
36 typedef struct _grs_point {
37         fix x,y;
38 } grs_point;
39
40 //these are control characters that have special meaning in the font code
41
42 #define CC_COLOR        1   //next char is new foreground color
43 #define CC_LSPACING     2   //next char specifies line spacing
44 #define CC_UNDERLINE    3   //next char is underlined
45
46 //now have string versions of these control characters (can concat inside a string)
47
48 #define CC_COLOR_S      "\x1"   //next char is new foreground color
49 #define CC_LSPACING_S   "\x2"   //next char specifies line spacing
50 #define CC_UNDERLINE_S  "\x3"   //next char is underlined
51
52 #define BM_LINEAR   0
53 #define BM_MODEX    1
54 #define BM_SVGA     2
55 #define BM_RGB15    3   //5 bits each r,g,b stored at 16 bits
56 #define BM_SVGA15   4
57 #ifdef OGL
58 #define BM_OGL      5
59 #endif
60
61 //@@// Define these modes for Gameplay too, since the game was developed under
62 //@@// DOS, we will adapt these modes to other systems thru rendering.
63 #define SM(w,h) ((((u_int32_t)w)<<16)+(((u_int32_t)h)&0xFFFF))
64 #define SM_W(m) (m>>16)
65 #define SM_H(m) (m&0xFFFF)
66
67 #define SM_ORIGINAL 0
68 /*
69 #define SM_ORIGINAL     -1
70 #define SM_320x200C     0
71 #define SM_320x200U     1
72 #define SM_320x240U     2
73 #define SM_360x200U     3
74 #define SM_360x240U     4
75 #define SM_376x282U     5
76 #define SM_320x400U     6
77 #define SM_320x480U     7
78 #define SM_360x400U     8
79 #define SM_360x480U     9
80 #define SM_360x360U     10
81 #define SM_376x308U     11
82 #define SM_376x564U     12
83 #define SM_640x400V     13
84 #define SM_640x480V     14
85 #define SM_800x600V     15
86 #define SM_1024x768V    16
87 #define SM_640x480V15   17
88 #define SM_800x600V15   18
89 #define SM_1280x1024V    19
90 */
91
92 #define BM_FLAG_TRANSPARENT         1
93 #define BM_FLAG_SUPER_TRANSPARENT   2
94 #define BM_FLAG_NO_LIGHTING         4
95 #define BM_FLAG_RLE                 8   // A run-length encoded bitmap.
96 #define BM_FLAG_PAGED_OUT           16  // This bitmap's data is paged out.
97 #define BM_FLAG_RLE_BIG             32  // for bitmaps that RLE to > 255 per row (i.e. cockpits)
98
99 typedef struct _grs_bitmap {
100         short   bm_x,bm_y;  // Offset from parent's origin
101         short   bm_w,bm_h;  // width,height
102         byte    bm_type;    // 0=Linear, 1=ModeX, 2=SVGA
103         byte    bm_flags;   // bit 0 on means it has transparency.
104                             // bit 1 on means it has supertransparency
105                             // bit 2 on means it doesn't get passed through lighting.
106         short   bm_rowsize; // unsigned char offset to next row
107         unsigned char *     bm_data;    // ptr to pixel data...
108                                         //   Linear = *parent+(rowsize*y+x)
109                                         //   ModeX = *parent+(rowsize*y+x/4)
110                                         //   SVGA = *parent+(rowsize*y+x)
111         unsigned short      bm_handle;  //for application.  initialized to 0
112         ubyte   avg_color;  //  Average color of all pixels in texture map.
113         byte    unused;     //  to 4-byte align.
114 #ifdef OGL
115         struct _ogl_texture *gltexture;
116         struct _grs_bitmap  *bm_parent;
117 #endif
118 } grs_bitmap;
119
120 //font structure
121 typedef struct _grs_font {
122         short       ft_w;           // Width in pixels
123         short       ft_h;           // Height in pixels
124         short       ft_flags;       // Proportional?
125         short       ft_baseline;    //
126         ubyte       ft_minchar;     // First char defined by this font
127         ubyte       ft_maxchar;     // Last char defined by this font
128         short       ft_bytewidth;   // Width in unsigned chars
129         ubyte     * ft_data;        // Ptr to raw data.
130         ubyte    ** ft_chars;       // Ptrs to data for each char (required for prop font)
131         short     * ft_widths;      // Array of widths (required for prop font)
132         ubyte     * ft_kerndata;    // Array of kerning triplet data
133 #ifdef OGL
134         // These fields do not participate in disk i/o!
135         grs_bitmap *ft_bitmaps;
136         grs_bitmap ft_parent_bitmap;
137 #endif
138 } grs_font;
139
140 #define GRS_FONT_SIZE 28    // how much space it takes up on disk
141
142 typedef struct _grs_canvas {
143         grs_bitmap  cv_bitmap;      // the bitmap for this canvas
144         short       cv_color;       // current color
145         short       cv_drawmode;    // fill,XOR,etc.
146         grs_font *  cv_font;        // the currently selected font
147         short       cv_font_fg_color;   // current font foreground color (-1==Invisible)
148         short       cv_font_bg_color;   // current font background color (-1==Invisible)
149 } grs_canvas;
150
151 //shortcuts
152 #define cv_w cv_bitmap.bm_w
153 #define cv_h cv_bitmap.bm_h
154
155 typedef struct _grs_screen {    // This is a video screen
156         grs_canvas  sc_canvas;  // Represents the entire screen
157         int     sc_mode;        // Video mode number
158         short   sc_w, sc_h;     // Actual Width and Height
159         fix     sc_aspect;      //aspect ratio (w/h) for this screen
160 } grs_screen;
161
162
163 //=========================================================================
164 // System functions:
165 // setup and set mode. this creates a grs_screen structure and sets
166 // grd_curscreen to point to it.  grs_curcanv points to this screen's
167 // canvas.  Saves the current VGA state and screen mode.
168
169 int gr_init(void);
170
171 // This function sets up the main screen.  It should be called whenever
172 // the video mode changes.
173 int gr_init_screen(int mode, int w, int h, int x, int y, int rowsize, ubyte *data);
174
175 int gr_check_mode(u_int32_t mode);
176 int gr_set_mode(u_int32_t mode);
177
178
179 // These 4 functions actuall change screen colors.
180
181 extern void gr_pal_fade_out(unsigned char * pal);
182 extern void gr_pal_fade_in(unsigned char * pal);
183 extern void gr_pal_clear(void);
184 extern void gr_pal_setblock( int start, int number, unsigned char * pal );
185 extern void gr_pal_getblock( int start, int number, unsigned char * pal );
186
187
188 extern unsigned char *gr_video_memory;
189                                                     // All graphic modules will define this value.
190
191 //shut down the 2d.  Restore the screen mode.
192 void gr_close(void);
193
194 //=========================================================================
195 // Canvas functions:
196
197 // Makes a new canvas. allocates memory for the canvas and its bitmap,
198 // including the raw pixel buffer.
199
200 grs_canvas *gr_create_canvas(int w, int h);
201 #if defined(POLY_ACC)
202 grs_canvas *gr_create_canvas2(int w, int h, int type);
203 #endif
204
205 // Creates a canvas that is part of another canvas.  this can be used to make
206 // a window on the screen.  the canvas structure is malloc'd; the address of
207 // the raw pixel data is inherited from the parent canvas.
208
209 grs_canvas *gr_create_sub_canvas(grs_canvas *canv,int x,int y,int w, int h);
210
211 // Initialize the specified canvas. the raw pixel data buffer is passed as
212 // a parameter. no memory allocation is performed.
213
214 void gr_init_canvas(grs_canvas *canv,unsigned char *pixdata,int pixtype, int w,int h);
215
216 // Initialize the specified sub canvas. no memory allocation is performed.
217
218 void gr_init_sub_canvas(grs_canvas *new,grs_canvas *src,int x,int y,int w, int h);
219
220 // Free up the canvas and its pixel data.
221
222 void gr_free_canvas(grs_canvas *canv);
223
224 // Free up the canvas. do not free the pixel data, which belongs to the
225 // parent canvas.
226
227 void gr_free_sub_canvas(grs_canvas *canv);
228
229 // Clear the current canvas to the specified color
230 void gr_clear_canvas(int color);
231
232 //=========================================================================
233 // Bitmap functions:
234
235 // Allocate a bitmap and its pixel data buffer.
236 grs_bitmap *gr_create_bitmap(int w,int h);
237
238 // Allocated a bitmap and makes its data be raw_data that is already somewhere.
239 grs_bitmap *gr_create_bitmap_raw(int w, int h, unsigned char * raw_data );
240
241 #if defined(POLY_ACC)
242 // Allocates a bitmap of a specific type. data is either NULL or raw data.
243 grs_bitmap *gr_create_bitmap2(int w, int h, int type, void *data );
244 #endif
245
246 // Creates a bitmap which is part of another bitmap
247 grs_bitmap *gr_create_sub_bitmap(grs_bitmap *bm,int x,int y,int w, int h);
248
249 // Free the bitmap and its pixel data
250 void gr_free_bitmap(grs_bitmap *bm);
251
252 // Free the bitmap's data
253 void gr_free_bitmap_data (grs_bitmap *bm);
254 void gr_init_bitmap_data (grs_bitmap *bm);
255
256 // Free the bitmap, but not the pixel data buffer
257 void gr_free_sub_bitmap(grs_bitmap *bm);
258
259 void gr_bm_pixel( grs_bitmap * bm, int x, int y, unsigned char color );
260 void gr_bm_upixel( grs_bitmap * bm, int x, int y, unsigned char color );
261 void gr_bm_ubitblt( int w, int h, int dx, int dy, int sx, int sy, grs_bitmap * src, grs_bitmap * dest);
262 void gr_bm_ubitbltm(int w, int h, int dx, int dy, int sx, int sy, grs_bitmap * src, grs_bitmap * dest);
263
264 #ifdef MACINTOSH
265 void gr_bm_ubitblt_double(int w, int h, int dx, int dy, int sx, int sy, grs_bitmap *src, grs_bitmap *dest);
266 void gr_linear_movsd_double(ubyte *src, ubyte *dest, int num_pixels);
267 #endif
268
269 void gr_update_buffer( void * sbuf1, void * sbuf2, void * dbuf, int size );
270
271 //=========================================================================
272 // Color functions:
273
274 // When this function is called, the guns are set to gr_palette, and
275 // the palette stays the same until gr_close is called
276
277 void gr_use_palette_table(char * filename );
278 void gr_copy_palette(ubyte *gr_palette, ubyte *pal, int size);
279
280 //=========================================================================
281 // Drawing functions:
282
283 // For solid, XOR, or other fill modes.
284 int gr_set_drawmode(int mode);
285
286 // Sets the color in the current canvas.  should be a macro
287 // Use: gr_setcolor(int color);
288 void gr_setcolor(int color);
289
290 // Draw a polygon into the current canvas in the current color and drawmode.
291 // verts points to an ordered list of x,y pairs.  the polygon should be
292 // convex; a concave polygon will be handled in some reasonable manner,
293 // but not necessarily shaded as a concave polygon. It shouldn't hang.
294 // probably good solution is to shade from minx to maxx on each scan line.
295 // int should really be fix
296 int gr_poly(int nverts,int *verts);
297 int gr_upoly(int nverts,int *verts);
298
299
300 // Draws a point into the current canvas in the current color and drawmode.
301 void gr_pixel(int x,int y);
302 void gr_upixel(int x,int y);
303
304 // Gets a pixel;
305 unsigned char gr_gpixel( grs_bitmap * bitmap, int x, int y );
306 unsigned char gr_ugpixel( grs_bitmap * bitmap, int x, int y );
307
308 // Draws a line into the current canvas in the current color and drawmode.
309 int gr_line(fix x0,fix y0,fix x1,fix y1);
310 int gr_uline(fix x0,fix y0,fix x1,fix y1);
311
312 // Draws an anti-aliased line into the current canvas in the current color and drawmode.
313 int gr_aaline(fix x0,fix y0,fix x1,fix y1);
314 int gr_uaaline(fix x0,fix y0,fix x1,fix y1);
315
316 // Draw the bitmap into the current canvas at the specified location.
317 void gr_bitmap(int x,int y,grs_bitmap *bm);
318 void gr_ubitmap(int x,int y,grs_bitmap *bm);
319 void gr_bitmap_scale_to(grs_bitmap *src, grs_bitmap *dst);
320 void show_fullscr(grs_bitmap *bm);
321
322 // bitmap function with transparency
323 void gr_bitmapm( int x, int y, grs_bitmap *bm );
324 void gr_ubitmapm( int x, int y, grs_bitmap *bm );
325
326 // Draw a rectangle into the current canvas.
327 void gr_rect(int left,int top,int right,int bot);
328 void gr_urect(int left,int top,int right,int bot);
329
330 // Draw a filled circle
331 int gr_disk(fix x,fix y,fix r);
332 int gr_udisk(fix x,fix y,fix r);
333
334 // Draw an outline circle
335 int gr_circle(fix x,fix y,fix r);
336 int gr_ucircle(fix x,fix y,fix r);
337
338 // Draw an unfilled rectangle into the current canvas
339 void gr_box(int left,int top,int right,int bot);
340 void gr_ubox(int left,int top,int right,int bot);
341
342 void gr_scanline( int x1, int x2, int y );
343 void gr_uscanline( int x1, int x2, int y );
344
345
346 // Reads in a font file... current font set to this one.
347 grs_font * gr_init_font( char * fontfile );
348 void gr_close_font( grs_font * font );
349
350 //remap a font, re-reading its data & palette
351 void gr_remap_font( grs_font *font, char * fontname, char *font_data );
352
353 //remap (by re-reading) all the color fonts
354 void gr_remap_color_fonts();
355
356 // Writes a string using current font. Returns the next column after last char.
357 void gr_set_fontcolor( int fg, int bg );
358 void gr_set_curfont( grs_font * new );
359 int gr_string(int x, int y, char *s );
360 int gr_ustring(int x, int y, char *s );
361 int gr_printf( int x, int y, char * format, ... );
362 int gr_uprintf( int x, int y, char * format, ... );
363 void gr_get_string_size(char *s, int *string_width, int *string_height, int *average_width );
364
365
366 //  From roller.c
367 void rotate_bitmap(grs_bitmap *bp, grs_point *vertbuf, int light_value);
368
369 // From scale.c
370 void scale_bitmap(grs_bitmap *bp, grs_point *vertbuf, int orientation );
371
372 //===========================================================================
373 // Global variables
374 extern grs_canvas *grd_curcanv;             //active canvas
375 extern grs_screen *grd_curscreen;           //active screen
376 extern unsigned char Test_bitmap_data[64*64];
377
378 //shortcut to look at current font
379 #define grd_curfont grd_curcanv->cv_font
380
381 extern unsigned int FixDivide( unsigned int x, unsigned int y );
382
383 extern void gr_show_canvas( grs_canvas *canv );
384 extern void gr_set_current_canvas( grs_canvas *canv );
385
386 //flags for fonts
387 #define FT_COLOR        1
388 #define FT_PROPORTIONAL 2
389 #define FT_KERNED       4
390
391 extern void gr_vesa_update( grs_bitmap * source1, grs_bitmap * dest, grs_bitmap * source2 );
392
393 // Special effects
394 extern void gr_snow_out(int num_dots);
395
396 extern void test_rotate_bitmap(void);
397 extern void rotate_bitmap(grs_bitmap *bp, grs_point *vertbuf, int light_value);
398
399 extern ubyte gr_palette[256*3];
400 extern ubyte gr_fade_table[256*GR_FADE_LEVELS];
401 extern ubyte gr_inverse_table[32*32*32];
402
403 extern ushort gr_palette_selector;
404 extern ushort gr_inverse_table_selector;
405 extern ushort gr_fade_table_selector;
406
407 // Remaps a bitmap into the current palette. If transparent_color is
408 // between 0 and 255 then all occurances of that color are mapped to
409 // whatever color the 2d uses for transparency. This is normally used
410 // right after a call to iff_read_bitmap like this:
411 //              iff_error = iff_read_bitmap(filename,new,BM_LINEAR,newpal);
412 //              if (iff_error != IFF_NO_ERROR) Error("Can't load IFF file <%s>, error=%d",filename,iff_error);
413 //              if ( iff_has_transparency )
414 //                      gr_remap_bitmap( new, newpal, iff_transparent_color );
415 //              else
416 //                      gr_remap_bitmap( new, newpal, -1 );
417 extern void gr_remap_bitmap( grs_bitmap * bmp, ubyte * palette, int transparent_color, int super_transparent_color );
418
419 // Same as above, but searches using gr_find_closest_color which uses
420 // 18-bit accurracy instead of 15bit when translating colors.
421 extern void gr_remap_bitmap_good( grs_bitmap * bmp, ubyte * palette, int transparent_color, int super_transparent_color );
422
423 extern void gr_palette_step_up( int r, int g, int b );
424
425 extern void gr_bitmap_check_transparency( grs_bitmap * bmp );
426
427 // Allocates a selector that has a base address at 'address' and length 'size'.
428 // Returns 0 if successful... BE SURE TO CHECK the return value since there
429 // is a limited number of selectors available!!!
430 extern int get_selector( void * address, int size, unsigned int * selector );
431
432 // Assigns a selector to a bitmap. Returns 0 if successful.  BE SURE TO CHECK
433 // this return value since there is a limited number of selectors!!!!!!!
434 extern int gr_bitmap_assign_selector( grs_bitmap * bmp );
435
436 //#define GR_GETCOLOR(r,g,b) (gr_inverse_table[( (((r)&31)<<10) | (((g)&31)<<5) | ((b)&31) )])
437 //#define gr_getcolor(r,g,b) (gr_inverse_table[( (((r)&31)<<10) | (((g)&31)<<5) | ((b)&31) )])
438 //#define BM_XRGB(r,g,b) (gr_inverse_table[( (((r)&31)<<10) | (((g)&31)<<5) | ((b)&31) )])
439
440 #define BM_RGB(r,g,b) ( (((r)&31)<<10) | (((g)&31)<<5) | ((b)&31) )
441 #define BM_XRGB(r,g,b) gr_find_closest_color( (r)*2,(g)*2,(b)*2 )
442 #define GR_GETCOLOR(r,g,b) gr_find_closest_color( (r)*2,(g)*2,(b)*2 )
443 #define gr_getcolor(r,g,b) gr_find_closest_color( (r)*2,(g)*2,(b)*2 )
444
445 // Given: r,g,b, each in range of 0-63, return the color index that
446 // best matches the input.
447 int gr_find_closest_color( int r, int g, int b );
448 int gr_find_closest_color_15bpp( int rgb );
449
450 extern void gr_merge_textures( ubyte * lower, ubyte * upper, ubyte * dest );
451 extern void gr_merge_textures_1( ubyte * lower, ubyte * upper, ubyte * dest );
452 extern void gr_merge_textures_2( ubyte * lower, ubyte * upper, ubyte * dest );
453 extern void gr_merge_textures_3( ubyte * lower, ubyte * upper, ubyte * dest );
454
455 extern void gr_update(void);
456
457 /*
458  * currently SDL and OGL are the only things that supports toggling
459  * fullscreen.  otherwise add other checks to the #if -MPM
460  */
461 #if (defined(SDL_VIDEO) || defined(OGL))
462 #define GR_SUPPORTS_FULLSCREEN_TOGGLE
463
464 /*
465  * must return 0 if windowed, 1 if fullscreen
466  */
467 int gr_check_fullscreen(void);
468
469 /*
470  * returns state after toggling (ie, same as if you had called
471  * check_fullscreen immediatly after)
472  */
473 int gr_toggle_fullscreen(void);
474
475 #endif
476
477 int gr_toggle_fullscreen_menu(void);//returns state after toggling (ie, same as if you had called check_fullscreen immediatly after)
478
479 #endif