1 // ============================================================================
2 // Artsoft Retro-Game Library
3 // ----------------------------------------------------------------------------
4 // (c) 1995-2014 by Artsoft Entertainment
7 // http://www.artsoft.org/
8 // ----------------------------------------------------------------------------
10 // ============================================================================
19 #if defined(PLATFORM_MACOSX)
21 #elif defined(PLATFORM_WIN32)
23 #elif defined(PLATFORM_ANDROID)
30 /* the additional 'b' is needed for Win32 to open files in binary mode */
31 #define MODE_READ "rb"
32 #define MODE_WRITE "wb"
33 #define MODE_APPEND "ab"
35 #define DEFAULT_DEPTH 0
39 #define BLIT_INVERSE 2
40 #define BLIT_ON_BACKGROUND 3
42 /* values for fullscreen status */
43 #define FULLSCREEN_NOT_AVAILABLE FALSE
44 #define FULLSCREEN_AVAILABLE TRUE
46 /* values for window scaling */
47 #define WINDOW_SCALING_NOT_AVAILABLE FALSE
48 #define WINDOW_SCALING_AVAILABLE TRUE
50 #define MIN_WINDOW_SCALING_PERCENT 30
51 #define STD_WINDOW_SCALING_PERCENT 100
52 #define MAX_WINDOW_SCALING_PERCENT 400
53 #define STEP_WINDOW_SCALING_PERCENT 10
55 /* values for window scaling quality */
56 #define SCALING_QUALITY_NEAREST "nearest"
57 #define SCALING_QUALITY_LINEAR "linear"
58 #define SCALING_QUALITY_BEST "best"
60 #define SCALING_QUALITY_DEFAULT SCALING_QUALITY_LINEAR
62 /* values for screen rendering mode */
63 #define STR_SPECIAL_RENDERING_OFF "stream_texture_only"
64 #define STR_SPECIAL_RENDERING_BITMAP "bitmap_and_stream_texture"
65 #define STR_SPECIAL_RENDERING_TARGET "target_texture_only"
66 #define STR_SPECIAL_RENDERING_DOUBLE "stream_and_target_texture"
68 #if defined(TARGET_SDL2)
69 #define STR_SPECIAL_RENDERING_DEFAULT STR_SPECIAL_RENDERING_DOUBLE
71 #define STR_SPECIAL_RENDERING_DEFAULT STR_SPECIAL_RENDERING_BITMAP
74 #define SPECIAL_RENDERING_OFF 0
75 #define SPECIAL_RENDERING_BITMAP 1
76 #define SPECIAL_RENDERING_TARGET 2
77 #define SPECIAL_RENDERING_DOUBLE 3
79 #if defined(TARGET_SDL2)
80 #define SPECIAL_RENDERING_DEFAULT SPECIAL_RENDERING_DOUBLE
82 #define SPECIAL_RENDERING_DEFAULT SPECIAL_RENDERING_BITMAP
85 /* values for touch control */
86 #define TOUCH_CONTROL_VIRTUAL_BUTTONS "virtual_buttons"
87 #define TOUCH_CONTROL_WIPE_GESTURES "wipe_gestures"
88 #define TOUCH_CONTROL_FOLLOW_FINGER "follow_finger"
90 #define TOUCH_CONTROL_DEFAULT TOUCH_CONTROL_VIRTUAL_BUTTONS
92 #define TOUCH_MOVE_DISTANCE_DEFAULT 2
93 #define TOUCH_DROP_DISTANCE_DEFAULT 5
96 /* values for special settings for mobile devices */
97 #if defined(PLATFORM_ANDROID)
98 #define USE_TOUCH_INPUT_OVERLAY
99 #define USE_COMPLETE_DISPLAY
100 #define HAS_SCREEN_KEYBOARD
101 #define SCREEN_KEYBOARD_POS(h) ((h) / 2)
105 /* default input keys */
106 #define DEFAULT_KEY_LEFT KSYM_Left
107 #define DEFAULT_KEY_RIGHT KSYM_Right
108 #define DEFAULT_KEY_UP KSYM_Up
109 #define DEFAULT_KEY_DOWN KSYM_Down
110 #if defined(PLATFORM_MACOSX)
111 #define DEFAULT_KEY_SNAP KSYM_Control_L
112 #define DEFAULT_KEY_DROP KSYM_KP_Enter
114 #define DEFAULT_KEY_SNAP KSYM_Control_L
115 #define DEFAULT_KEY_DROP KSYM_Control_R
117 #define DEFAULT_KEY_OKAY KSYM_Return
118 #define DEFAULT_KEY_CANCEL KSYM_Escape
120 /* default shortcut keys */
121 #define DEFAULT_KEY_SAVE_GAME KSYM_F1
122 #define DEFAULT_KEY_LOAD_GAME KSYM_F2
123 #define DEFAULT_KEY_TOGGLE_PAUSE KSYM_space
124 #define DEFAULT_KEY_FOCUS_PLAYER_1 KSYM_F5
125 #define DEFAULT_KEY_FOCUS_PLAYER_2 KSYM_F6
126 #define DEFAULT_KEY_FOCUS_PLAYER_3 KSYM_F7
127 #define DEFAULT_KEY_FOCUS_PLAYER_4 KSYM_F8
128 #define DEFAULT_KEY_FOCUS_PLAYER_ALL KSYM_F9
129 #define DEFAULT_KEY_TAPE_EJECT KSYM_UNDEFINED
130 #define DEFAULT_KEY_TAPE_EXTRA KSYM_UNDEFINED
131 #define DEFAULT_KEY_TAPE_STOP KSYM_UNDEFINED
132 #define DEFAULT_KEY_TAPE_PAUSE KSYM_UNDEFINED
133 #define DEFAULT_KEY_TAPE_RECORD KSYM_UNDEFINED
134 #define DEFAULT_KEY_TAPE_PLAY KSYM_UNDEFINED
135 #define DEFAULT_KEY_SOUND_SIMPLE KSYM_UNDEFINED
136 #define DEFAULT_KEY_SOUND_LOOPS KSYM_UNDEFINED
137 #define DEFAULT_KEY_SOUND_MUSIC KSYM_UNDEFINED
138 #define DEFAULT_KEY_SNAP_LEFT KSYM_UNDEFINED
139 #define DEFAULT_KEY_SNAP_RIGHT KSYM_UNDEFINED
140 #define DEFAULT_KEY_SNAP_UP KSYM_UNDEFINED
141 #define DEFAULT_KEY_SNAP_DOWN KSYM_UNDEFINED
143 /* default debug setup keys and values */
144 #define DEFAULT_FRAME_DELAY_0 20 // 100 % speed
145 #define DEFAULT_FRAME_DELAY_1 500 // 4 % speed
146 #define DEFAULT_FRAME_DELAY_2 250 // 8 % speed
147 #define DEFAULT_FRAME_DELAY_3 125 // 16 % speed
148 #define DEFAULT_FRAME_DELAY_4 60 // 33 % speed
149 #define DEFAULT_FRAME_DELAY_5 40 // 50 % speed
150 #define DEFAULT_FRAME_DELAY_6 30 // 66 % speed
151 #define DEFAULT_FRAME_DELAY_7 10 // 200 % speed
152 #define DEFAULT_FRAME_DELAY_8 5 // 400 % speed
153 #define DEFAULT_FRAME_DELAY_9 0 // maximum speed
155 #define DEFAULT_KEY_FRAME_DELAY_0 KSYM_0
156 #define DEFAULT_KEY_FRAME_DELAY_1 KSYM_1
157 #define DEFAULT_KEY_FRAME_DELAY_2 KSYM_2
158 #define DEFAULT_KEY_FRAME_DELAY_3 KSYM_3
159 #define DEFAULT_KEY_FRAME_DELAY_4 KSYM_4
160 #define DEFAULT_KEY_FRAME_DELAY_5 KSYM_5
161 #define DEFAULT_KEY_FRAME_DELAY_6 KSYM_6
162 #define DEFAULT_KEY_FRAME_DELAY_7 KSYM_7
163 #define DEFAULT_KEY_FRAME_DELAY_8 KSYM_8
164 #define DEFAULT_KEY_FRAME_DELAY_9 KSYM_9
166 #define NUM_DEBUG_FRAME_DELAY_KEYS 10
168 #define DEFAULT_FRAME_DELAY_USE_MOD_KEY FALSE
169 #define DEFAULT_FRAME_DELAY_GAME_ONLY TRUE
171 /* values for key_status */
172 #define KEY_NOT_PRESSED FALSE
173 #define KEY_RELEASED FALSE
174 #define KEY_PRESSED TRUE
176 /* values for button status */
177 #define MB_NOT_PRESSED FALSE
178 #define MB_NOT_RELEASED TRUE
179 #define MB_RELEASED FALSE
180 #define MB_PRESSED TRUE
181 #define MB_MENU_CHOICE FALSE
182 #define MB_MENU_MARK TRUE
183 #define MB_MENU_INITIALIZE (-1)
184 #define MB_MENU_LEAVE (-2)
185 #define MB_LEFTBUTTON 1
186 #define MB_MIDDLEBUTTON 2
187 #define MB_RIGHTBUTTON 3
188 #define MB_WHEEL_UP 4
189 #define MB_WHEEL_DOWN 5
190 #define MB_WHEEL_LEFT 6
191 #define MB_WHEEL_RIGHT 7
192 #define IS_WHEEL_BUTTON_VERTICAL(b) ((b) == MB_WHEEL_UP || \
193 (b) == MB_WHEEL_DOWN)
194 #define IS_WHEEL_BUTTON_HORIZONTAL(b) ((b) == MB_WHEEL_LEFT || \
195 (b) == MB_WHEEL_RIGHT)
196 #define IS_WHEEL_BUTTON(b) (IS_WHEEL_BUTTON_VERTICAL(b) || \
197 IS_WHEEL_BUTTON_HORIZONTAL(b))
198 #define DEFAULT_WHEEL_STEPS 3
200 #define BUTTON_STEPSIZE(b) ((b) == MB_LEFTBUTTON ? 1 : \
201 (b) == MB_MIDDLEBUTTON ? 5 : \
202 (b) == MB_RIGHTBUTTON ? 10 : 1)
204 /* values for move directions */
205 #define MV_BIT_LEFT 0
206 #define MV_BIT_RIGHT 1
208 #define MV_BIT_DOWN 3
210 #define NUM_DIRECTIONS 4
212 /* diagonal movement directions are used in a different contect than buttons */
213 #define MV_BIT_UPLEFT 4
214 #define MV_BIT_UPRIGHT 5
215 #define MV_BIT_DOWNLEFT 6
216 #define MV_BIT_DOWNRIGHT 7
218 #define NUM_DIRECTIONS_FULL 8
220 /* values for special "button" bitmasks */
224 #define NUM_PLAYER_ACTIONS 6
226 /* values for special "focus player" bitmasks */
227 #define BIT_SET_FOCUS 6
229 /* values for drawing stages for global animations */
230 #define DRAW_GLOBAL_ANIM_STAGE_1 1
231 #define DRAW_GLOBAL_ANIM_STAGE_2 2
233 /* values for drawing target (various functions) */
234 #define DRAW_TO_BACKBUFFER 0
235 #define DRAW_TO_FIELDBUFFER 1
236 #define DRAW_TO_SCREEN 2
237 #define DRAW_TO_FADE_SOURCE 3
238 #define DRAW_TO_FADE_TARGET 4
240 /* values for move directions and special "button" key bitmasks */
242 #define MV_LEFT (1 << MV_BIT_LEFT)
243 #define MV_RIGHT (1 << MV_BIT_RIGHT)
244 #define MV_UP (1 << MV_BIT_UP)
245 #define MV_DOWN (1 << MV_BIT_DOWN)
247 #define MV_UPLEFT (MV_UP | MV_LEFT)
248 #define MV_UPRIGHT (MV_UP | MV_RIGHT)
249 #define MV_DOWNLEFT (MV_DOWN | MV_LEFT)
250 #define MV_DOWNRIGHT (MV_DOWN | MV_RIGHT)
252 #define MV_HORIZONTAL (MV_LEFT | MV_RIGHT)
253 #define MV_VERTICAL (MV_UP | MV_DOWN)
254 #define MV_ALL_DIRECTIONS (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
255 #define MV_ANY_DIRECTION (MV_ALL_DIRECTIONS)
256 #define MV_NO_DIRECTION (MV_NONE)
258 #define KEY_BUTTON_1 (1 << BUTTON_1)
259 #define KEY_BUTTON_2 (1 << BUTTON_2)
260 #define KEY_BUTTON_SNAP KEY_BUTTON_1
261 #define KEY_BUTTON_DROP KEY_BUTTON_2
262 #define KEY_MOTION (MV_LEFT | MV_RIGHT | MV_UP | MV_DOWN)
263 #define KEY_BUTTON (KEY_BUTTON_1 | KEY_BUTTON_2)
264 #define KEY_ACTION (KEY_MOTION | KEY_BUTTON)
266 #define KEY_SET_FOCUS (1 << BIT_SET_FOCUS)
268 #define MV_DIR_FROM_BIT(x) ((x) < NUM_DIRECTIONS ? 1 << (x) : \
269 (x) == MV_BIT_UPLEFT ? MV_UPLEFT : \
270 (x) == MV_BIT_UPRIGHT ? MV_UPRIGHT : \
271 (x) == MV_BIT_DOWNLEFT ? MV_DOWNLEFT : \
272 (x) == MV_BIT_DOWNRIGHT ? MV_DOWNRIGHT : \
275 #define MV_DIR_TO_BIT(x) ((x) == MV_LEFT ? MV_BIT_LEFT : \
276 (x) == MV_RIGHT ? MV_BIT_RIGHT : \
277 (x) == MV_UP ? MV_BIT_UP : \
278 (x) == MV_DOWN ? MV_BIT_DOWN : \
279 (x) == MV_UPLEFT ? MV_BIT_UPLEFT : \
280 (x) == MV_UPRIGHT ? MV_BIT_UPRIGHT : \
281 (x) == MV_DOWNLEFT ? MV_BIT_DOWNLEFT : \
282 (x) == MV_DOWNRIGHT ? MV_BIT_DOWNRIGHT : \
285 #define MV_DIR_OPPOSITE(x) ((x) == MV_LEFT ? MV_RIGHT : \
286 (x) == MV_RIGHT ? MV_LEFT : \
287 (x) == MV_UP ? MV_DOWN : \
288 (x) == MV_DOWN ? MV_UP : \
289 (x) == MV_UPLEFT ? MV_DOWNRIGHT : \
290 (x) == MV_UPRIGHT ? MV_DOWNLEFT : \
291 (x) == MV_DOWNLEFT ? MV_UPRIGHT : \
292 (x) == MV_DOWNRIGHT ? MV_UPLEFT : \
295 /* values for animation mode (frame order and direction) */
296 /* (stored in level files -- never change existing values) */
298 #define ANIM_LOOP (1 << 0)
299 #define ANIM_LINEAR (1 << 1)
300 #define ANIM_PINGPONG (1 << 2)
301 #define ANIM_PINGPONG2 (1 << 3)
302 #define ANIM_RANDOM (1 << 4)
303 #define ANIM_CE_VALUE (1 << 5)
304 #define ANIM_CE_SCORE (1 << 6)
305 #define ANIM_CE_DELAY (1 << 7)
306 #define ANIM_REVERSE (1 << 8)
307 #define ANIM_OPAQUE_PLAYER (1 << 9)
309 /* values for special (non game element) animation modes */
310 /* (not stored in level files -- can be changed, if needed) */
311 #define ANIM_HORIZONTAL (1 << 10)
312 #define ANIM_VERTICAL (1 << 11)
313 #define ANIM_CENTERED (1 << 12)
314 #define ANIM_STATIC_PANEL (1 << 13)
315 #define ANIM_ALL (1 << 14)
316 #define ANIM_ONCE (1 << 15)
318 #define ANIM_DEFAULT ANIM_LOOP
320 /* values for special drawing styles (currently only for crumbled graphics) */
322 #define STYLE_ACCURATE_BORDERS (1 << 0)
323 #define STYLE_INNER_CORNERS (1 << 1)
325 #define STYLE_DEFAULT STYLE_NONE
327 /* values for special global animation events */
328 #define ANIM_EVENT_NONE 0
329 #define ANIM_EVENT_SELF (1 << 16)
330 #define ANIM_EVENT_ANY (1 << 17)
332 #define ANIM_EVENT_ANIM_BIT 0
333 #define ANIM_EVENT_PART_BIT 8
335 #define ANIM_EVENT_ANIM_MASK (0xff << ANIM_EVENT_ANIM_BIT)
336 #define ANIM_EVENT_PART_MASK (0xff << ANIM_EVENT_PART_BIT)
338 #define ANIM_EVENT_DEFAULT ANIM_EVENT_NONE
340 /* values for fade mode */
341 #define FADE_TYPE_NONE 0
342 #define FADE_TYPE_FADE_IN (1 << 0)
343 #define FADE_TYPE_FADE_OUT (1 << 1)
344 #define FADE_TYPE_TRANSFORM (1 << 2)
345 #define FADE_TYPE_CROSSFADE (1 << 3)
346 #define FADE_TYPE_MELT (1 << 4)
347 #define FADE_TYPE_CURTAIN (1 << 5)
348 #define FADE_TYPE_SKIP (1 << 6)
350 #define FADE_MODE_NONE (FADE_TYPE_NONE)
351 #define FADE_MODE_FADE_IN (FADE_TYPE_FADE_IN)
352 #define FADE_MODE_FADE_OUT (FADE_TYPE_FADE_OUT)
353 #define FADE_MODE_FADE (FADE_TYPE_FADE_IN | FADE_TYPE_FADE_OUT)
354 #define FADE_MODE_TRANSFORM (FADE_TYPE_TRANSFORM | FADE_TYPE_FADE_IN)
355 #define FADE_MODE_CROSSFADE (FADE_MODE_TRANSFORM | FADE_TYPE_CROSSFADE)
356 #define FADE_MODE_MELT (FADE_MODE_TRANSFORM | FADE_TYPE_MELT)
357 #define FADE_MODE_CURTAIN (FADE_MODE_TRANSFORM | FADE_TYPE_CURTAIN)
358 #define FADE_MODE_SKIP_FADE_IN (FADE_TYPE_SKIP | FADE_TYPE_FADE_IN)
359 #define FADE_MODE_SKIP_FADE_OUT (FADE_TYPE_SKIP | FADE_TYPE_FADE_OUT)
361 #define FADE_MODE_DEFAULT FADE_MODE_FADE
363 /* values for toon positions */
364 #define POS_UNDEFINED -1
375 /* values for text alignment */
376 #define ALIGN_LEFT (1 << 0)
377 #define ALIGN_RIGHT (1 << 1)
378 #define ALIGN_CENTER (1 << 2)
379 #define ALIGN_DEFAULT ALIGN_LEFT
381 #define VALIGN_TOP (1 << 0)
382 #define VALIGN_BOTTOM (1 << 1)
383 #define VALIGN_MIDDLE (1 << 2)
384 #define VALIGN_DEFAULT VALIGN_TOP
386 #define ALIGNED_XPOS(x,w,a) ((a) == ALIGN_CENTER ? (x) - (w) / 2 : \
387 (a) == ALIGN_RIGHT ? (x) - (w) : (x))
388 #define ALIGNED_YPOS(y,h,v) ((v) == VALIGN_MIDDLE ? (y) - (h) / 2 : \
389 (v) == VALIGN_BOTTOM ? (y) - (h) : (y))
390 #define ALIGNED_TEXT_XPOS(p) ALIGNED_XPOS((p)->x, (p)->width, (p)->align)
391 #define ALIGNED_TEXT_YPOS(p) ALIGNED_YPOS((p)->y, (p)->height, (p)->valign)
393 /* values for redraw_mask */
394 #define REDRAW_NONE (0)
395 #define REDRAW_ALL (1 << 0)
396 #define REDRAW_FIELD (1 << 1)
397 #define REDRAW_DOOR_1 (1 << 2)
398 #define REDRAW_DOOR_2 (1 << 3)
399 #define REDRAW_DOOR_3 (1 << 4)
400 #define REDRAW_FPS (1 << 5)
402 #define REDRAW_DOORS (REDRAW_DOOR_1 | \
406 #define IN_GFX_FIELD_PLAY(x, y) (x >= gfx.sx && x < gfx.sx + gfx.sxsize && \
407 y >= gfx.sy && y < gfx.sy + gfx.sysize)
408 #define IN_GFX_FIELD_FULL(x, y) (x >= gfx.real_sx && \
409 x < gfx.real_sx + gfx.full_sxsize && \
410 y >= gfx.real_sy && \
411 y < gfx.real_sy + gfx.full_sysize)
412 #define IN_GFX_DOOR_1(x, y) (x >= gfx.dx && x < gfx.dx + gfx.dxsize && \
413 y >= gfx.dy && y < gfx.dy + gfx.dysize)
414 #define IN_GFX_DOOR_2(x, y) (x >= gfx.vx && x < gfx.vx + gfx.vxsize && \
415 y >= gfx.vy && y < gfx.vy + gfx.vysize)
416 #define IN_GFX_DOOR_3(x, y) (x >= gfx.ex && x < gfx.ex + gfx.exsize && \
417 y >= gfx.ey && y < gfx.ey + gfx.eysize)
419 /* values for mouse cursor */
420 #define CURSOR_DEFAULT 0
421 #define CURSOR_NONE 1
422 #define CURSOR_PLAYFIELD 2
424 /* fundamental game speed values */
425 #define ONE_SECOND_DELAY 1000 /* delay value for one second */
426 #define MENU_FRAME_DELAY 20 /* frame delay in milliseconds */
427 #define GAME_FRAME_DELAY 20 /* frame delay in milliseconds */
428 #define FFWD_FRAME_DELAY 10 /* 200% speed for fast forward */
429 #define FRAMES_PER_SECOND (ONE_SECOND_DELAY / GAME_FRAME_DELAY)
430 #define FRAMES_PER_SECOND_SP 35
432 /* maximum playfield size supported by libgame functions */
433 #define MAX_PLAYFIELD_WIDTH 128
434 #define MAX_PLAYFIELD_HEIGHT 128
436 /* maximum number of parallel players supported by libgame functions */
437 #define MAX_PLAYERS 4
439 /* maximum allowed length of player name */
440 #define MAX_PLAYER_NAME_LEN 10
442 /* maximum number of levels in a level set */
443 #define MAX_LEVELS 1000
445 /* maximum number of global animation and parts */
446 #define MAX_GLOBAL_ANIMS 32
447 #define MAX_GLOBAL_ANIM_PARTS 32
449 /* default name for empty highscore entry */
450 #define EMPTY_PLAYER_NAME "no name"
452 /* default name for unknown player names */
453 #define ANONYMOUS_NAME "anonymous"
455 /* default for other unknown names */
456 #define UNKNOWN_NAME "unknown"
458 /* default name for new levels */
459 #define NAMELESS_LEVEL_NAME "nameless level"
461 /* default text for non-existant artwork */
462 #define NOT_AVAILABLE "(not available)"
464 /* default value for undefined filename */
465 #define UNDEFINED_FILENAME "[NONE]"
467 /* default value for undefined levelset */
468 #define UNDEFINED_LEVELSET "[NONE]"
470 /* default value for undefined parameter */
471 #define ARG_DEFAULT "[DEFAULT]"
473 /* default values for undefined configuration file parameters */
474 #define ARG_UNDEFINED "-1000000"
475 #define ARG_UNDEFINED_VALUE (-1000000)
477 /* default value for off-screen positions */
478 #define POS_OFFSCREEN (-1000000)
480 /* definitions for game sub-directories */
482 #define RO_GAME_DIR "."
486 #define RW_GAME_DIR "."
489 #define RO_BASE_PATH RO_GAME_DIR
490 #define RW_BASE_PATH RW_GAME_DIR
492 /* directory names */
493 #define GRAPHICS_DIRECTORY "graphics"
494 #define SOUNDS_DIRECTORY "sounds"
495 #define MUSIC_DIRECTORY "music"
496 #define LEVELS_DIRECTORY "levels"
497 #define TAPES_DIRECTORY "tapes"
498 #define SCORES_DIRECTORY "scores"
499 #define DOCS_DIRECTORY "docs"
500 #define CACHE_DIRECTORY "cache"
501 #define CONF_DIRECTORY "conf"
503 #define GFX_CLASSIC_SUBDIR "gfx_classic"
504 #define SND_CLASSIC_SUBDIR "snd_classic"
505 #define MUS_CLASSIC_SUBDIR "mus_classic"
507 #define GFX_DEFAULT_SUBDIR (setup.internal.default_graphics_set)
508 #define SND_DEFAULT_SUBDIR (setup.internal.default_sounds_set)
509 #define MUS_DEFAULT_SUBDIR (setup.internal.default_music_set)
511 #define GFX_FALLBACK_FILENAME (setup.internal.fallback_graphics_file)
512 #define SND_FALLBACK_FILENAME (setup.internal.fallback_sounds_file)
513 #define MUS_FALLBACK_FILENAME (setup.internal.fallback_music_file)
515 #define DEFAULT_LEVELSET (setup.internal.default_level_series)
517 /* file names and filename extensions */
518 #define LEVELSETUP_DIRECTORY "levelsetup"
519 #define SETUP_FILENAME "setup.conf"
520 #define AUTOSETUP_FILENAME "autosetup.conf"
521 #define LEVELSETUP_FILENAME "levelsetup.conf"
522 #define EDITORSETUP_FILENAME "editorsetup.conf"
523 #define EDITORCASCADE_FILENAME "editorcascade.conf"
524 #define HELPANIM_FILENAME "helpanim.conf"
525 #define HELPTEXT_FILENAME "helptext.conf"
526 #define LEVELINFO_FILENAME "levelinfo.conf"
527 #define GRAPHICSINFO_FILENAME "graphicsinfo.conf"
528 #define SOUNDSINFO_FILENAME "soundsinfo.conf"
529 #define MUSICINFO_FILENAME "musicinfo.conf"
530 #define ARTWORKINFO_CACHE_FILE "artworkinfo.cache"
531 #define LEVELTEMPLATE_FILENAME "template.level"
532 #define LEVELFILE_EXTENSION "level"
533 #define TAPEFILE_EXTENSION "tape"
534 #define SCOREFILE_EXTENSION "score"
536 #define GAMECONTROLLER_BASENAME "gamecontrollerdb.txt"
538 #define LOG_OUT_BASENAME "stdout.txt"
539 #define LOG_ERR_BASENAME "stderr.txt"
545 #define STRING_PARENT_DIRECTORY ".."
546 #define STRING_TOP_DIRECTORY "/"
548 #define CHAR_PATH_SEPARATOR_UNIX '/'
549 #define CHAR_PATH_SEPARATOR_DOS '\\'
551 #define STRING_PATH_SEPARATOR_UNIX "/"
552 #define STRING_PATH_SEPARATOR_DOS "\\"
554 #define STRING_NEWLINE_UNIX "\n"
555 #define STRING_NEWLINE_DOS "\r\n"
557 #if defined(PLATFORM_WIN32)
558 #define CHAR_PATH_SEPARATOR CHAR_PATH_SEPARATOR_DOS
559 #define STRING_PATH_SEPARATOR STRING_PATH_SEPARATOR_DOS
560 #define STRING_NEWLINE STRING_NEWLINE_DOS
562 #define CHAR_PATH_SEPARATOR CHAR_PATH_SEPARATOR_UNIX
563 #define STRING_PATH_SEPARATOR STRING_PATH_SEPARATOR_UNIX
564 #define STRING_NEWLINE STRING_NEWLINE_UNIX
568 /* areas in bitmap PIX_DOOR */
569 /* meaning in PIX_DB_DOOR: (3 PAGEs)
570 PAGEX1: 1. buffer for DOOR_1
571 PAGEX2: 2. buffer for DOOR_1
572 PAGEX3: buffer for animations
575 /* these values are hard-coded to be able to use them in initialization */
576 #define DOOR_GFX_PAGE_WIDTH 100 /* should be set to "gfx.dxsize" */
577 #define DOOR_GFX_PAGE_HEIGHT 280 /* should be set to "gfx.dysize" */
579 #define DOOR_GFX_PAGESIZE (DOOR_GFX_PAGE_WIDTH)
580 #define DOOR_GFX_PAGEX1 (0 * DOOR_GFX_PAGESIZE)
581 #define DOOR_GFX_PAGEX2 (1 * DOOR_GFX_PAGESIZE)
582 #define DOOR_GFX_PAGEX3 (2 * DOOR_GFX_PAGESIZE)
583 #define DOOR_GFX_PAGEX4 (3 * DOOR_GFX_PAGESIZE)
584 #define DOOR_GFX_PAGEX5 (4 * DOOR_GFX_PAGESIZE)
585 #define DOOR_GFX_PAGEX6 (5 * DOOR_GFX_PAGESIZE)
586 #define DOOR_GFX_PAGEX7 (6 * DOOR_GFX_PAGESIZE)
587 #define DOOR_GFX_PAGEX8 (7 * DOOR_GFX_PAGESIZE)
588 #define DOOR_GFX_PAGEY1 (0)
589 #define DOOR_GFX_PAGEY2 (DOOR_GFX_PAGE_HEIGHT)
592 /* macros for version handling */
593 #define VERSION_MAJOR(x) ((x) / 1000000)
594 #define VERSION_MINOR(x) (((x) % 1000000) / 10000)
595 #define VERSION_PATCH(x) (((x) % 10000) / 100)
596 #define VERSION_BUILD(x) ((x) % 100)
597 #define VERSION_IDENT(a,b,c,d) ((a) * 1000000 + (b) * 10000 + (c) * 100 + (d))
600 /* macros for parent/child process identification */
601 #if defined(PLATFORM_UNIX)
602 #define IS_PARENT_PROCESS() (audio.mixer_pid != getpid())
603 #define IS_CHILD_PROCESS() (audio.mixer_pid == getpid())
604 #define HAS_CHILD_PROCESS() (audio.mixer_pid > 0)
606 #define IS_PARENT_PROCESS() TRUE
607 #define IS_CHILD_PROCESS() FALSE
608 #define HAS_CHILD_PROCESS() FALSE
612 /* values for artwork type */
613 #define ARTWORK_TYPE_GRAPHICS 0
614 #define ARTWORK_TYPE_SOUNDS 1
615 #define ARTWORK_TYPE_MUSIC 2
617 #define NUM_ARTWORK_TYPES 3
620 /* values for tree type (chosen to match artwork type) */
621 #define TREE_TYPE_UNDEFINED -1
622 #define TREE_TYPE_GRAPHICS_DIR ARTWORK_TYPE_GRAPHICS
623 #define TREE_TYPE_SOUNDS_DIR ARTWORK_TYPE_SOUNDS
624 #define TREE_TYPE_MUSIC_DIR ARTWORK_TYPE_MUSIC
625 #define TREE_TYPE_LEVEL_DIR 3
626 #define TREE_TYPE_LEVEL_NR 4
628 #define NUM_TREE_TYPES 5
630 #define INFOTEXT_UNDEFINED ""
631 #define INFOTEXT_GRAPHICS_DIR "Custom Graphics"
632 #define INFOTEXT_SOUNDS_DIR "Custom Sounds"
633 #define INFOTEXT_MUSIC_DIR "Custom Music"
634 #define INFOTEXT_LEVEL_DIR "Level Sets"
635 #define INFOTEXT_LEVEL_NR "Levels"
637 #define TREE_INFOTEXT(t) ((t) == TREE_TYPE_LEVEL_NR ? \
638 INFOTEXT_LEVEL_NR : \
639 (t) == TREE_TYPE_LEVEL_DIR ? \
640 INFOTEXT_LEVEL_DIR : \
641 (t) == TREE_TYPE_GRAPHICS_DIR ? \
642 INFOTEXT_GRAPHICS_DIR : \
643 (t) == TREE_TYPE_SOUNDS_DIR ? \
644 INFOTEXT_SOUNDS_DIR : \
645 (t) == TREE_TYPE_MUSIC_DIR ? \
646 INFOTEXT_MUSIC_DIR : \
649 /* values for artwork handling */
650 #define LEVELDIR_ARTWORK_SET_PTR(leveldir, type) \
651 ((type) == ARTWORK_TYPE_GRAPHICS ? \
652 &(leveldir)->graphics_set : \
653 (type) == ARTWORK_TYPE_SOUNDS ? \
654 &(leveldir)->sounds_set : \
655 &(leveldir)->music_set)
657 #define LEVELDIR_ARTWORK_SET(leveldir, type) \
658 ((type) == ARTWORK_TYPE_GRAPHICS ? \
659 (leveldir)->graphics_set : \
660 (type) == ARTWORK_TYPE_SOUNDS ? \
661 (leveldir)->sounds_set : \
662 (leveldir)->music_set)
664 #define LEVELDIR_ARTWORK_PATH_PTR(leveldir, type) \
665 ((type) == ARTWORK_TYPE_GRAPHICS ? \
666 &(leveldir)->graphics_path : \
667 (type) == ARTWORK_TYPE_SOUNDS ? \
668 &(leveldir)->sounds_path : \
669 &(leveldir)->music_path)
671 #define LEVELDIR_ARTWORK_PATH(leveldir, type) \
672 ((type) == ARTWORK_TYPE_GRAPHICS ? \
673 (leveldir)->graphics_path : \
674 (type) == ARTWORK_TYPE_SOUNDS ? \
675 (leveldir)->sounds_path : \
676 (leveldir)->music_path)
678 #define SETUP_ARTWORK_SET(setup, type) \
679 ((type) == ARTWORK_TYPE_GRAPHICS ? \
680 (setup).graphics_set : \
681 (type) == ARTWORK_TYPE_SOUNDS ? \
682 (setup).sounds_set : \
685 #define SETUP_OVERRIDE_ARTWORK(setup, type) \
686 ((type) == ARTWORK_TYPE_GRAPHICS ? \
687 (setup).override_level_graphics : \
688 (type) == ARTWORK_TYPE_SOUNDS ? \
689 (setup).override_level_sounds : \
690 (setup).override_level_music)
692 #define GFX_OVERRIDE_ARTWORK(type) \
693 ((type) == ARTWORK_TYPE_GRAPHICS ? \
694 gfx.override_level_graphics : \
695 (type) == ARTWORK_TYPE_SOUNDS ? \
696 gfx.override_level_sounds : \
697 gfx.override_level_music)
699 #define ARTWORK_FIRST_NODE(artwork, type) \
700 ((type) == ARTWORK_TYPE_GRAPHICS ? \
701 (artwork).gfx_first : \
702 (type) == ARTWORK_TYPE_SOUNDS ? \
703 (artwork).snd_first : \
706 #define ARTWORK_CURRENT_IDENTIFIER_PTR(artwork, type) \
707 ((type) == ARTWORK_TYPE_GRAPHICS ? \
708 &(artwork).gfx_current_identifier : \
709 (type) == ARTWORK_TYPE_SOUNDS ? \
710 &(artwork).snd_current_identifier : \
711 &(artwork).mus_current_identifier)
713 #define ARTWORK_CURRENT_IDENTIFIER(artwork, type) \
714 ((type) == ARTWORK_TYPE_GRAPHICS ? \
715 (artwork).gfx_current_identifier : \
716 (type) == ARTWORK_TYPE_SOUNDS ? \
717 (artwork).snd_current_identifier : \
718 (artwork).mus_current_identifier)
720 #define ARTWORKINFO_FILENAME(type) \
721 ((type) == ARTWORK_TYPE_GRAPHICS ? \
722 GRAPHICSINFO_FILENAME : \
723 (type) == ARTWORK_TYPE_SOUNDS ? \
724 SOUNDSINFO_FILENAME : \
725 (type) == ARTWORK_TYPE_MUSIC ? \
726 MUSICINFO_FILENAME : "")
728 #define ARTWORK_DIRECTORY(type) \
729 ((type) == ARTWORK_TYPE_GRAPHICS ? \
730 GRAPHICS_DIRECTORY : \
731 (type) == ARTWORK_TYPE_SOUNDS ? \
733 (type) == ARTWORK_TYPE_MUSIC ? \
734 MUSIC_DIRECTORY : "")
736 #define OPTIONS_ARTWORK_DIRECTORY(type) \
737 ((type) == ARTWORK_TYPE_GRAPHICS ? \
738 options.graphics_directory : \
739 (type) == ARTWORK_TYPE_SOUNDS ? \
740 options.sounds_directory : \
741 (type) == ARTWORK_TYPE_MUSIC ? \
742 options.music_directory : "")
744 #define UPDATE_BUSY_STATE() \
746 if (gfx.draw_busy_anim_function != NULL) \
747 gfx.draw_busy_anim_function(); \
751 /* structure definitions */
755 char *command_basepath; /* path to the program binary */
756 char *command_basename; /* base filename of the program binary */
758 char *config_filename; /* optional global program config filename */
760 char *maindata_path; /* main game data (installation) directory */
762 char *userdata_subdir; /* personal user game data directory */
763 char *userdata_path; /* resulting full path to game data directory */
773 char *log_filename[NUM_LOGS]; /* log filenames for out/err messages */
774 FILE *log_file[NUM_LOGS]; /* log file handles for out/err files */
775 FILE *log_file_default[NUM_LOGS]; /* default log file handles (out/err) */
783 char *version_string;
785 char *(*window_title_function)(void);
786 void (*exit_message_function)(char *, va_list);
787 void (*exit_function)(int);
789 boolean global_scores;
790 boolean many_scores_per_name;
800 char *ro_base_directory;
801 char *rw_base_directory;
802 char *level_directory;
803 char *graphics_directory;
804 char *sounds_directory;
805 char *music_directory;
806 char *docs_directory;
807 char *conf_directory;
809 char *execute_command;
820 struct VideoSystemInfo
823 int width, height, depth;
824 int window_width, window_height;
825 int display_width, display_height;
826 int screen_width, screen_height;
827 int screen_xoffset, screen_yoffset;
829 boolean fullscreen_available;
830 boolean fullscreen_enabled;
831 boolean fullscreen_initial;
833 boolean window_scaling_available;
834 int window_scaling_percent;
835 char *window_scaling_quality;
836 int screen_rendering_mode;
838 unsigned int frame_delay;
839 unsigned int frame_delay_value;
843 int shifted_up_pos_last;
844 unsigned int shifted_up_delay;
845 unsigned int shifted_up_delay_value;
850 struct AudioSystemInfo
852 boolean sound_available;
853 boolean loops_available;
854 boolean music_available;
856 boolean sound_enabled;
857 boolean sound_deactivated; /* for temporarily disabling sound */
866 int first_sound_channel;
869 struct FontBitmapInfo
873 int src_x, src_y; /* start position of animation frames */
874 int width, height; /* width/height of each animation frame */
876 int draw_xoffset; /* offset for drawing font characters */
877 int draw_yoffset; /* offset for drawing font characters */
880 int num_chars_per_line;
887 int real_sx, real_sy;
888 int full_sxsize, full_sysize;
889 int scrollbuffer_width, scrollbuffer_height;
891 int game_tile_size, standard_tile_size;
902 int win_xsize, win_ysize;
904 int draw_deactivation_mask;
905 int draw_background_mask;
907 Bitmap *field_save_buffer;
909 Bitmap *background_bitmap;
910 int background_bitmap_mask;
912 Bitmap *fade_bitmap_backup;
913 Bitmap *fade_bitmap_source;
914 Bitmap *fade_bitmap_target;
915 Bitmap *fade_bitmap_black;
917 int fade_border_source_status;
918 int fade_border_target_status;
919 Bitmap *masked_border_bitmap_ptr;
921 Bitmap *final_screen_bitmap;
923 boolean clipping_enabled;
925 int clip_width, clip_height;
927 boolean override_level_graphics;
928 boolean override_level_sounds;
929 boolean override_level_music;
931 boolean draw_init_text;
934 struct FontBitmapInfo *font_bitmap_info;
935 int (*select_font_function)(int);
936 int (*get_font_from_token_function)(char *);
938 int anim_random_frame;
940 void (*draw_busy_anim_function)(void);
941 void (*draw_global_anim_function)(int, int);
942 void (*draw_global_border_function)(int);
949 boolean enabled; /* overlay generally enabled or disabled */
950 boolean active; /* overlay activated (depending on game mode) */
956 int nr[MAX_PLAYERS]; /* joystick number for each player */
959 struct SetupJoystickInfo
961 char *device_name; /* device name of player's joystick */
963 int xleft, xmiddle, xright;
964 int yupper, ymiddle, ylower;
968 struct SetupKeyboardInfo
970 Key left, right, up, down;
974 struct SetupTouchInfo
981 struct SetupInputInfo
983 boolean use_joystick;
984 struct SetupJoystickInfo joy;
985 struct SetupKeyboardInfo key;
988 struct SetupEditorInfo
990 boolean el_boulderdash;
991 boolean el_emerald_mine;
992 boolean el_emerald_mine_club;
996 boolean el_diamond_caves;
997 boolean el_dx_boulderdash;
999 boolean el_mirror_magic;
1000 boolean el_deflektor;
1003 boolean el_steel_chars;
1007 boolean el_user_defined;
1010 boolean el_headlines;
1015 boolean show_element_token;
1017 boolean use_template_for_new_levels;
1020 struct SetupAutoSetupInfo
1022 int editor_zoom_tilesize;
1025 struct SetupEditorCascadeInfo
1038 boolean el_steel_chars;
1046 struct SetupShortcutInfo
1052 Key focus_player[MAX_PLAYERS];
1053 Key focus_player_all;
1072 struct SetupSystemInfo
1074 char *sdl_videodriver;
1075 char *sdl_audiodriver;
1076 int audio_fragment_size;
1079 struct SetupInternalInfo
1081 char *program_title;
1082 char *program_version;
1083 char *program_author;
1084 char *program_email;
1085 char *program_website;
1086 char *program_copyright;
1087 char *program_company;
1089 char *program_icon_file;
1091 char *default_graphics_set;
1092 char *default_sounds_set;
1093 char *default_music_set;
1095 char *fallback_graphics_file;
1096 char *fallback_sounds_file;
1097 char *fallback_music_file;
1099 char *default_level_series;
1101 int default_window_width;
1102 int default_window_height;
1104 boolean choose_from_top_leveldir;
1105 boolean show_scaling_in_title;
1108 struct SetupDebugInfo
1110 int frame_delay[10];
1111 Key frame_delay_key[10];
1112 boolean frame_delay_use_mod_key;
1113 boolean frame_delay_game_only;
1114 boolean show_frames_per_second;
1122 boolean sound_loops;
1123 boolean sound_music;
1124 boolean sound_simple;
1126 boolean scroll_delay;
1127 boolean scroll_delay_value;
1128 char *engine_snapshot_mode;
1129 int engine_snapshot_memory;
1130 boolean fade_screens;
1132 boolean show_titlescreen;
1133 boolean quick_doors;
1136 boolean skip_levels;
1137 boolean increment_levels;
1140 int window_scaling_percent;
1141 char *window_scaling_quality;
1142 char *screen_rendering_mode;
1143 boolean ask_on_escape;
1144 boolean ask_on_escape_editor;
1145 boolean quick_switch;
1146 boolean input_on_focus;
1147 boolean prefer_aga_graphics;
1148 int game_frame_delay;
1149 boolean sp_show_border_elements;
1150 boolean small_game_graphics;
1151 boolean show_snapshot_buttons;
1156 int override_level_graphics; /* not boolean -- can also be "AUTO" */
1157 int override_level_sounds; /* not boolean -- can also be "AUTO" */
1158 int override_level_music; /* not boolean -- can also be "AUTO" */
1164 struct SetupAutoSetupInfo auto_setup;
1165 struct SetupEditorInfo editor;
1166 struct SetupEditorCascadeInfo editor_cascade;
1167 struct SetupShortcutInfo shortcut;
1168 struct SetupInputInfo input[MAX_PLAYERS];
1169 struct SetupTouchInfo touch;
1170 struct SetupSystemInfo system;
1171 struct SetupInternalInfo internal;
1172 struct SetupDebugInfo debug;
1174 struct OptionInfo options;
1179 struct TreeInfo **node_top; /* topmost node in tree */
1180 struct TreeInfo *node_parent; /* parent level directory info */
1181 struct TreeInfo *node_group; /* level group sub-directory info */
1182 struct TreeInfo *next; /* next level series structure node */
1184 int cl_first; /* internal control field for setup screen */
1185 int cl_cursor; /* internal control field for setup screen */
1187 int type; /* type of tree content */
1189 /* fields for "type == TREE_TYPE_LEVEL_DIR" */
1191 char *subdir; /* tree info sub-directory basename (may be ".") */
1192 char *fullpath; /* complete path relative to tree base directory */
1193 char *basepath; /* absolute base path of tree base directory */
1194 char *identifier; /* identifier string for configuration files */
1195 char *name; /* tree info name, as displayed in selection menues */
1196 char *name_sorting; /* optional sorting name for correct name sorting */
1197 char *author; /* level or artwork author name */
1198 char *year; /* optional year of creation for levels or artwork */
1199 char *imported_from; /* optional comment for imported levels or artwork */
1200 char *imported_by; /* optional comment for imported levels or artwork */
1201 char *tested_by; /* optional comment to name people who tested a set */
1203 char *graphics_set_ecs; /* special EMC custom graphics set (ECS graphics) */
1204 char *graphics_set_aga; /* special EMC custom graphics set (AGA graphics) */
1205 char *graphics_set; /* optional custom graphics set (level tree only) */
1206 char *sounds_set; /* optional custom sounds set (level tree only) */
1207 char *music_set; /* optional custom music set (level tree only) */
1208 char *graphics_path; /* path to optional custom graphics set (level only) */
1209 char *sounds_path; /* path to optional custom sounds set (level only) */
1210 char *music_path; /* path to optional custom music set (level only) */
1212 char *level_filename; /* filename of level file (for packed level file) */
1213 char *level_filetype; /* type of levels in level directory or level file */
1215 char *special_flags; /* flags for special actions performed on level file */
1217 int levels; /* number of levels in level series */
1218 int first_level; /* first level number (to allow start with 0 or 1) */
1219 int last_level; /* last level number (automatically calculated) */
1220 int sort_priority; /* sort levels by 'sort_priority' and then by name */
1222 boolean latest_engine;/* force level set to use the latest game engine */
1224 boolean level_group; /* directory contains more level series directories */
1225 boolean parent_link; /* entry links back to parent directory */
1226 boolean in_user_dir; /* user defined levels are stored in home directory */
1227 boolean user_defined; /* levels in user directory and marked as "private" */
1228 boolean readonly; /* readonly levels can not be changed with editor */
1229 boolean handicap; /* level set has no handicap when set to "false" */
1230 boolean skip_levels; /* levels can be skipped when set to "true" */
1232 int color; /* color to use on selection screen for this level */
1233 char *class_desc; /* description of level series class */
1234 int handicap_level; /* number of the lowest unsolved level */
1236 char *infotext; /* optional text to describe the tree type (headline) */
1239 typedef struct TreeInfo TreeInfo;
1240 typedef struct TreeInfo LevelDirTree;
1241 typedef struct TreeInfo ArtworkDirTree;
1242 typedef struct TreeInfo GraphicsDirTree;
1243 typedef struct TreeInfo SoundsDirTree;
1244 typedef struct TreeInfo MusicDirTree;
1248 GraphicsDirTree *gfx_first;
1249 GraphicsDirTree *gfx_current;
1250 SoundsDirTree *snd_first;
1251 SoundsDirTree *snd_current;
1252 MusicDirTree *mus_first;
1253 MusicDirTree *mus_current;
1255 char *gfx_current_identifier;
1256 char *snd_current_identifier;
1257 char *mus_current_identifier;
1260 struct ValueTextInfo
1272 struct ConfigTypeInfo
1279 struct TokenIntPtrInfo
1289 char *default_filename;
1292 char **default_parameter; /* array of file parameters */
1293 char **parameter; /* array of file parameters */
1296 boolean fallback_to_default;
1297 boolean default_is_cloned;
1300 struct SetupFileList
1305 struct SetupFileList *next;
1310 char *source_filename; /* primary key for node list */
1314 struct PropertyMapping
1324 struct ArtworkListInfo
1326 int type; /* type of artwork */
1328 int num_file_list_entries;
1329 int num_dynamic_file_list_entries;
1330 struct FileInfo *file_list; /* static artwork file array */
1331 struct FileInfo *dynamic_file_list; /* dynamic artwrk file array */
1333 int num_suffix_list_entries;
1334 struct ConfigTypeInfo *suffix_list; /* parameter suffixes array */
1336 int num_base_prefixes;
1337 int num_ext1_suffixes;
1338 int num_ext2_suffixes;
1339 int num_ext3_suffixes;
1340 char **base_prefixes; /* base token prefixes array */
1341 char **ext1_suffixes; /* property suffixes array 1 */
1342 char **ext2_suffixes; /* property suffixes array 2 */
1343 char **ext3_suffixes; /* property suffixes array 3 */
1345 int num_ignore_tokens;
1346 char **ignore_tokens; /* file tokens to be ignored */
1348 int num_property_mapping_entries;
1349 struct PropertyMapping *property_mapping; /* mapping token -> artwork */
1351 int sizeof_artwork_list_entry;
1353 struct ListNodeInfo **artwork_list; /* static artwork node array */
1354 struct ListNodeInfo **dynamic_artwork_list; /* dynamic artwrk node array */
1355 struct ListNode *content_list; /* dynamic artwork node list */
1357 void *(*load_artwork)(char *); /* constructor function */
1358 void (*free_artwork)(void *); /* destructor function */
1378 struct RectWithBorder
1392 struct DoorPartPosInfo
1399 int start_step_opening;
1400 int start_step_closing;
1401 boolean draw_masked;
1408 int xoffset; /* special case for tape date and time */
1409 int xoffset2; /* special case for tape date */
1412 int size; /* also used for suffix ".digits" */
1414 boolean draw_masked;
1415 boolean draw_player; /* special case for network player buttons */
1416 int sort_priority; /* also used for suffix ".draw_order" */
1427 /* ========================================================================= */
1428 /* exported variables */
1429 /* ========================================================================= */
1431 extern struct ProgramInfo program;
1432 extern struct OptionInfo options;
1433 extern struct VideoSystemInfo video;
1434 extern struct AudioSystemInfo audio;
1435 extern struct GfxInfo gfx;
1436 extern struct OverlayInfo overlay;
1437 extern struct AnimInfo anim;
1438 extern struct ArtworkInfo artwork;
1439 extern struct JoystickInfo joystick;
1440 extern struct SetupInfo setup;
1442 extern LevelDirTree *leveldir_first_all;
1443 extern LevelDirTree *leveldir_first;
1444 extern LevelDirTree *leveldir_current;
1445 extern int level_nr;
1447 extern struct LevelStats level_stats[];
1449 extern DrawWindow *window;
1450 extern DrawBuffer *backbuffer;
1451 extern DrawBuffer *drawto;
1453 extern int button_status;
1454 extern boolean motion_status;
1455 extern int wheel_steps;
1456 #if defined(TARGET_SDL2)
1457 extern boolean keyrepeat_status;
1460 extern int redraw_mask;
1462 extern int FrameCounter;
1465 /* function definitions */
1467 void InitProgramInfo(char *, char *, char *, char *, char *, char *, char *,
1470 void InitScoresInfo();
1471 void SetWindowTitle();
1473 void InitWindowTitleFunction(char *(*window_title_function)(void));
1474 void InitExitMessageFunction(void (*exit_message_function)(char *, va_list));
1475 void InitExitFunction(void (*exit_function)(int));
1476 void InitPlatformDependentStuff(void);
1477 void ClosePlatformDependentStuff(void);
1479 void InitGfxFieldInfo(int, int, int, int, int, int, int, int, Bitmap *);
1480 void InitGfxTileSizeInfo(int, int);
1481 void InitGfxDoor1Info(int, int, int, int);
1482 void InitGfxDoor2Info(int, int, int, int);
1483 void InitGfxDoor3Info(int, int, int, int);
1484 void InitGfxWindowInfo(int, int);
1485 void InitGfxScrollbufferInfo(int, int);
1486 void InitGfxClipRegion(boolean, int, int, int, int);
1487 void InitGfxDrawBusyAnimFunction(void (*draw_busy_anim_function)(void));
1488 void InitGfxDrawGlobalAnimFunction(void (*draw_global_anim_function)(int, int));
1489 void InitGfxDrawGlobalBorderFunction(void (*draw_global_border_function)(int));
1490 void InitGfxCustomArtworkInfo();
1491 void InitGfxOtherSettings();
1492 void InitOverlayInfo();
1493 void SetOverlayEnabled(boolean);
1494 void SetOverlayActive(boolean);
1495 boolean GetOverlayActive();
1496 void SetDrawDeactivationMask(int);
1497 int GetDrawDeactivationMask(void);
1498 void SetDrawBackgroundMask(int);
1499 void SetWindowBackgroundBitmap(Bitmap *);
1500 void SetMainBackgroundBitmap(Bitmap *);
1501 void SetDoorBackgroundBitmap(Bitmap *);
1502 void SetRedrawMaskFromArea(int, int, int, int);
1504 void LimitScreenUpdates(boolean);
1506 void InitVideoDisplay(void);
1507 void CloseVideoDisplay(void);
1508 void InitVideoBuffer(int, int, int, boolean);
1509 Bitmap *CreateBitmapStruct(void);
1510 Bitmap *CreateBitmap(int, int, int);
1511 void ReCreateBitmap(Bitmap **, int, int);
1512 void FreeBitmap(Bitmap *);
1513 void BlitBitmap(Bitmap *, Bitmap *, int, int, int, int, int, int);
1514 void BlitBitmapTiled(Bitmap *, Bitmap *, int, int, int, int, int, int, int,int);
1515 void FadeRectangle(int, int, int, int, int, int, int,
1516 void (*draw_border_function)(void));
1517 void FillRectangle(Bitmap *, int, int, int, int, Pixel);
1518 void ClearRectangle(Bitmap *, int, int, int, int);
1519 void ClearRectangleOnBackground(Bitmap *, int, int, int, int);
1520 void BlitBitmapMasked(Bitmap *, Bitmap *, int, int, int, int, int, int);
1521 boolean DrawingDeactivatedField(void);
1522 boolean DrawingDeactivated(int, int, int, int);
1523 boolean DrawingOnBackground(int, int);
1524 boolean DrawingAreaChanged();
1525 void BlitBitmapOnBackground(Bitmap *, Bitmap *, int, int, int, int, int, int);
1526 void BlitTexture(Bitmap *, int, int, int, int, int, int);
1527 void BlitTextureMasked(Bitmap *, int, int, int, int, int, int);
1528 void BlitToScreen(Bitmap *, int, int, int, int, int, int);
1529 void BlitToScreenMasked(Bitmap *, int, int, int, int, int, int);
1530 void DrawSimpleBlackLine(Bitmap *, int, int, int, int);
1531 void DrawSimpleWhiteLine(Bitmap *, int, int, int, int);
1532 void DrawLines(Bitmap *, struct XY *, int, Pixel);
1533 Pixel GetPixel(Bitmap *, int, int);
1534 Pixel GetPixelFromRGB(Bitmap *, unsigned int,unsigned int,unsigned int);
1535 Pixel GetPixelFromRGBcompact(Bitmap *, unsigned int);
1537 void KeyboardAutoRepeatOn(void);
1538 void KeyboardAutoRepeatOff(void);
1539 boolean SetVideoMode(boolean);
1540 void SetVideoFrameDelay(unsigned int);
1541 unsigned int GetVideoFrameDelay();
1542 boolean ChangeVideoModeIfNeeded(boolean);
1544 Bitmap *LoadImage(char *);
1545 Bitmap *LoadCustomImage(char *);
1546 void ReloadCustomImage(Bitmap *, char *);
1548 void ReCreateGameTileSizeBitmap(Bitmap **);
1549 void CreateBitmapWithSmallBitmaps(Bitmap **, int, int);
1550 void CreateBitmapTextures(Bitmap **);
1551 void FreeBitmapTextures(Bitmap **);
1552 void ScaleBitmap(Bitmap **, int);
1554 void SetMouseCursor(int);
1556 void OpenAudio(void);
1557 void CloseAudio(void);
1558 void SetAudioMode(boolean);
1560 boolean PendingEvent(void);
1561 void WaitEvent(Event *event);
1562 void PeekEvent(Event *event);
1563 void CheckQuitEvent(void);
1564 Key GetEventKey(KeyEvent *, boolean);
1565 KeyMod HandleKeyModState(Key, int);
1566 KeyMod GetKeyModState();
1567 KeyMod GetKeyModStateFromEvents();
1568 void StartTextInput(int, int, int, int);
1569 void StopTextInput();
1570 boolean CheckCloseWindowEvent(ClientMessageEvent *);
1572 void InitJoysticks();
1573 boolean ReadJoystick(int, int *, int *, boolean *, boolean *);
1574 boolean CheckJoystickOpened(int);
1575 void ClearJoystickState();
1577 #endif /* SYSTEM_H */