src/libgame/sdl.h

   1 // ============================================================================
   2 // Artsoft Retro-Game Library
   3 // ----------------------------------------------------------------------------
   4 // (c) 1995-2014 by Artsoft Entertainment
   5 //                  Holger Schemel
   6 //                  info@artsoft.org
   7 //                  http://www.artsoft.org/
   8 // ----------------------------------------------------------------------------
   9 // sdl.h
  10 // ============================================================================
  11
  12 #ifndef SDL_H
  13 #define SDL_H
  14
  15 #include <SDL.h>
  16 #include <SDL_image.h>
  17 #include <SDL_mixer.h>
  18 #include <SDL_net.h>
  19 #include <SDL_thread.h>
  20 #if defined(PLATFORM_WIN32)
  21 #include <SDL_syswm.h>
  22 #endif
  23
  24 /* definitions needed for "system.c" */
  25
  26 #if defined(TARGET_SDL2)
  27 #define SURFACE_FLAGS           (0)
  28 #else
  29 #define SURFACE_FLAGS           (SDL_SWSURFACE)
  30 #endif
  31
  32 #if defined(TARGET_SDL2)
  33 #define SET_TRANSPARENT_PIXEL   (SDL_TRUE)
  34 #define UNSET_TRANSPARENT_PIXEL (SDL_FALSE)
  35 #else
  36 #define SET_TRANSPARENT_PIXEL   (SDL_SRCCOLORKEY)
  37 #define UNSET_TRANSPARENT_PIXEL (0)
  38 #endif
  39
  40 /* system dependent definitions */
  41
  42 #if defined(TARGET_SDL2)
  43 #define TARGET_STRING           "SDL2"
  44 #else
  45 #define TARGET_STRING           "SDL"
  46 #endif
  47
  48 #if defined(PLATFORM_ANDROID)
  49 #define WINDOW_SCALING_STATUS   WINDOW_SCALING_NOT_AVAILABLE
  50 #define FULLSCREEN_STATUS       FULLSCREEN_AVAILABLE
  51 #elif defined(TARGET_SDL2)
  52 #define WINDOW_SCALING_STATUS   WINDOW_SCALING_AVAILABLE
  53 #define FULLSCREEN_STATUS       FULLSCREEN_AVAILABLE
  54 #else   // SDL 1.2
  55 #define WINDOW_SCALING_STATUS   WINDOW_SCALING_NOT_AVAILABLE
  56 #define FULLSCREEN_STATUS       FULLSCREEN_AVAILABLE
  57 #endif
  58
  59 #define CURSOR_MAX_WIDTH        32
  60 #define CURSOR_MAX_HEIGHT       32
  61
  62
  63 /* SDL type definitions */
  64
  65 typedef struct SDLSurfaceInfo   Bitmap;
  66 typedef struct SDLSurfaceInfo   DrawBuffer;
  67 typedef struct SDLSurfaceInfo   DrawWindow;
  68 typedef Uint32                  Pixel;
  69 typedef SDL_Cursor             *Cursor;
  70
  71 #if defined(TARGET_SDL2)
  72 typedef SDL_Keycode             Key;
  73 typedef SDL_Keymod              KeyMod;
  74 #else
  75 typedef SDLKey                  Key;
  76 typedef unsigned int            KeyMod;
  77 #endif
  78
  79 typedef SDL_Event               Event;
  80 typedef SDL_MouseButtonEvent    ButtonEvent;
  81 typedef SDL_MouseMotionEvent    MotionEvent;
  82 #if defined(TARGET_SDL2)
  83 typedef SDL_MouseWheelEvent     WheelEvent;
  84 typedef SDL_TouchFingerEvent    FingerEvent;
  85 typedef SDL_TextInputEvent      TextEvent;
  86 typedef SDL_Event               PauseResumeEvent;
  87 typedef SDL_WindowEvent         WindowEvent;
  88 #endif
  89 typedef SDL_KeyboardEvent       KeyEvent;
  90 typedef SDL_Event               ExposeEvent;
  91 typedef SDL_Event               FocusChangeEvent;
  92 typedef SDL_Event               ClientMessageEvent;
  93
  94
  95 /* structure definitions */
  96
  97 struct SDLSurfaceInfo
  98 {
  99   char *source_filename;
 100
 101   int width, height;
 102   SDL_Surface *surface;
 103   SDL_Surface *surface_masked;
 104 #if defined(TARGET_SDL2)
 105   SDL_Texture *texture;
 106   SDL_Texture *texture_masked;
 107 #endif
 108 };
 109
 110 struct MouseCursorInfo
 111 {
 112   int width, height;
 113   int hot_x, hot_y;
 114
 115   byte data[CURSOR_MAX_WIDTH * CURSOR_MAX_HEIGHT / 8];
 116   byte mask[CURSOR_MAX_WIDTH * CURSOR_MAX_HEIGHT / 8];
 117 };
 118
 119
 120 /* SDL symbol definitions */
 121
 122 #define None                    0L
 123
 124 #define BLACK_PIXEL             0x000000
 125 #define WHITE_PIXEL             0xffffff
 126
 127 #define EVENT_BUTTONPRESS       SDL_MOUSEBUTTONDOWN
 128 #define EVENT_BUTTONRELEASE     SDL_MOUSEBUTTONUP
 129 #define EVENT_MOTIONNOTIFY      SDL_MOUSEMOTION
 130 #if defined(TARGET_SDL2)
 131 #define EVENT_WHEELMOTION       SDL_MOUSEWHEEL
 132 #define EVENT_FINGERPRESS       SDL_FINGERDOWN
 133 #define EVENT_FINGERRELEASE     SDL_FINGERUP
 134 #define EVENT_FINGERMOTION      SDL_FINGERMOTION
 135 #define EVENT_TEXTINPUT         SDL_TEXTINPUT
 136 #endif
 137 #define EVENT_KEYPRESS          SDL_KEYDOWN
 138 #define EVENT_KEYRELEASE        SDL_KEYUP
 139 #define EVENT_EXPOSE            SDL_USEREVENT + 0
 140 #define EVENT_FOCUSIN           SDL_USEREVENT + 1
 141 #define EVENT_FOCUSOUT          SDL_USEREVENT + 2
 142 #define EVENT_CLIENTMESSAGE     SDL_QUIT
 143 #define EVENT_MAPNOTIFY         SDL_USEREVENT + 4
 144 #define EVENT_UNMAPNOTIFY       SDL_USEREVENT + 5
 145
 146 #define KSYM_UNDEFINED          SDLK_UNKNOWN
 147
 148 #define KSYM_Return             SDLK_RETURN
 149 #define KSYM_Escape             SDLK_ESCAPE
 150
 151 #define KSYM_Left               SDLK_LEFT
 152 #define KSYM_Right              SDLK_RIGHT
 153 #define KSYM_Up                 SDLK_UP
 154 #define KSYM_Down               SDLK_DOWN
 155
 156 #ifdef SDLK_KP_LEFT
 157 #define KSYM_KP_Left            SDLK_KP_LEFT
 158 #define KSYM_KP_Right           SDLK_KP_RIGHT
 159 #define KSYM_KP_Up              SDLK_KP_UP
 160 #define KSYM_KP_Down            SDLK_KP_DOWN
 161 #endif
 162
 163 #define KSYM_KP_Enter           SDLK_KP_ENTER
 164 #define KSYM_KP_Add             SDLK_KP_PLUS
 165 #define KSYM_KP_Subtract        SDLK_KP_MINUS
 166 #define KSYM_KP_Multiply        SDLK_KP_MULTIPLY
 167 #define KSYM_KP_Divide          SDLK_KP_DIVIDE
 168 #define KSYM_KP_Separator       SDLK_KP_PERIOD
 169
 170 #define KSYM_Shift_L            SDLK_LSHIFT
 171 #define KSYM_Shift_R            SDLK_RSHIFT
 172 #define KSYM_Control_L          SDLK_LCTRL
 173 #define KSYM_Control_R          SDLK_RCTRL
 174
 175 #if defined(TARGET_SDL2)
 176 #define KSYM_Meta_L             SDLK_LGUI
 177 #define KSYM_Meta_R             SDLK_RGUI
 178 #else
 179 #define KSYM_Meta_L             SDLK_LMETA
 180 #define KSYM_Meta_R             SDLK_RMETA
 181 #endif
 182
 183 #define KSYM_Alt_L              SDLK_LALT
 184 #define KSYM_Alt_R              SDLK_RALT
 185 #if !defined(TARGET_SDL2)
 186 #define KSYM_Super_L            SDLK_LSUPER
 187 #define KSYM_Super_R            SDLK_RSUPER
 188 #endif
 189 #define KSYM_Mode_switch        SDLK_MODE
 190 #define KSYM_Multi_key          SDLK_RCTRL
 191
 192 #define KSYM_BackSpace          SDLK_BACKSPACE
 193 #define KSYM_Delete             SDLK_DELETE
 194 #define KSYM_Insert             SDLK_INSERT
 195 #define KSYM_Tab                SDLK_TAB
 196 #define KSYM_Home               SDLK_HOME
 197 #define KSYM_End                SDLK_END
 198 #define KSYM_Page_Up            SDLK_PAGEUP
 199 #define KSYM_Page_Down          SDLK_PAGEDOWN
 200
 201 #if defined(TARGET_SDL2)
 202 #define KSYM_Select             SDLK_SELECT
 203 #define KSYM_Menu               SDLK_MENU
 204 #define KSYM_Back               SDLK_AC_BACK
 205 #define KSYM_PlayPause          SDLK_AUDIOPLAY
 206 #if defined(PLATFORM_ANDROID)
 207 #define KSYM_Rewind             SDLK_AUDIOREWIND
 208 #define KSYM_FastForward        SDLK_AUDIOFASTFORWARD
 209 #endif
 210 #endif
 211
 212 #define KSYM_space              SDLK_SPACE
 213 #define KSYM_exclam             SDLK_EXCLAIM
 214 #define KSYM_quotedbl           SDLK_QUOTEDBL
 215 #define KSYM_numbersign         SDLK_HASH
 216 #define KSYM_dollar             SDLK_DOLLAR
 217
 218 #if defined(TARGET_SDL2)
 219 #define KSYM_percent            SDLK_PERCENT
 220 #else
 221 #define KSYM_percent            37                      /* undefined in SDL */
 222 #endif
 223
 224 #define KSYM_ampersand          SDLK_AMPERSAND
 225 #define KSYM_apostrophe         SDLK_QUOTE
 226 #define KSYM_parenleft          SDLK_LEFTPAREN
 227 #define KSYM_parenright         SDLK_RIGHTPAREN
 228 #define KSYM_asterisk           SDLK_ASTERISK
 229 #define KSYM_plus               SDLK_PLUS
 230 #define KSYM_comma              SDLK_COMMA
 231 #define KSYM_minus              SDLK_MINUS
 232 #define KSYM_period             SDLK_PERIOD
 233 #define KSYM_slash              SDLK_SLASH
 234
 235 #define KSYM_colon              SDLK_COLON
 236 #define KSYM_semicolon          SDLK_SEMICOLON
 237 #define KSYM_less               SDLK_LESS
 238 #define KSYM_equal              SDLK_EQUALS
 239 #define KSYM_greater            SDLK_GREATER
 240 #define KSYM_question           SDLK_QUESTION
 241 #define KSYM_at                 SDLK_AT
 242
 243 #define KSYM_bracketleft        SDLK_LEFTBRACKET
 244 #define KSYM_backslash          SDLK_BACKSLASH
 245 #define KSYM_bracketright       SDLK_RIGHTBRACKET
 246 #define KSYM_asciicircum        SDLK_CARET
 247 #define KSYM_underscore         SDLK_UNDERSCORE
 248 #define KSYM_grave              SDLK_BACKQUOTE
 249
 250 #define KSYM_quoteleft          KSYM_UNDEFINED          /* undefined */
 251 #define KSYM_braceleft          KSYM_UNDEFINED          /* undefined */
 252 #define KSYM_bar                KSYM_UNDEFINED          /* undefined */
 253 #define KSYM_braceright         KSYM_UNDEFINED          /* undefined */
 254 #define KSYM_asciitilde         KSYM_UNDEFINED          /* undefined */
 255
 256 #if defined(TARGET_SDL2)
 257 #define KSYM_degree             176
 258 #define KSYM_Adiaeresis         196
 259 #define KSYM_Odiaeresis         214
 260 #define KSYM_Udiaeresis         220
 261 #define KSYM_adiaeresis         228
 262 #define KSYM_odiaeresis         246
 263 #define KSYM_udiaeresis         252
 264 #define KSYM_ssharp             223
 265 #else
 266 #define KSYM_degree             SDLK_WORLD_16
 267 #define KSYM_Adiaeresis         SDLK_WORLD_36
 268 #define KSYM_Odiaeresis         SDLK_WORLD_54
 269 #define KSYM_Udiaeresis         SDLK_WORLD_60
 270 #define KSYM_adiaeresis         SDLK_WORLD_68
 271 #define KSYM_odiaeresis         SDLK_WORLD_86
 272 #define KSYM_udiaeresis         SDLK_WORLD_92
 273 #define KSYM_ssharp             SDLK_WORLD_63
 274 #endif
 275
 276 #ifndef SDLK_A
 277 #define SDLK_A                  65
 278 #define SDLK_B                  66
 279 #define SDLK_C                  67
 280 #define SDLK_D                  68
 281 #define SDLK_E                  69
 282 #define SDLK_F                  70
 283 #define SDLK_G                  71
 284 #define SDLK_H                  72
 285 #define SDLK_I                  73
 286 #define SDLK_J                  74
 287 #define SDLK_K                  75
 288 #define SDLK_L                  76
 289 #define SDLK_M                  77
 290 #define SDLK_N                  78
 291 #define SDLK_O                  79
 292 #define SDLK_P                  80
 293 #define SDLK_Q                  81
 294 #define SDLK_R                  82
 295 #define SDLK_S                  83
 296 #define SDLK_T                  84
 297 #define SDLK_U                  85
 298 #define SDLK_V                  86
 299 #define SDLK_W                  87
 300 #define SDLK_X                  88
 301 #define SDLK_Y                  89
 302 #define SDLK_Z                  90
 303 #endif
 304
 305 #define KSYM_A                  SDLK_A
 306 #define KSYM_B                  SDLK_B
 307 #define KSYM_C                  SDLK_C
 308 #define KSYM_D                  SDLK_D
 309 #define KSYM_E                  SDLK_E
 310 #define KSYM_F                  SDLK_F
 311 #define KSYM_G                  SDLK_G
 312 #define KSYM_H                  SDLK_H
 313 #define KSYM_I                  SDLK_I
 314 #define KSYM_J                  SDLK_J
 315 #define KSYM_K                  SDLK_K
 316 #define KSYM_L                  SDLK_L
 317 #define KSYM_M                  SDLK_M
 318 #define KSYM_N                  SDLK_N
 319 #define KSYM_O                  SDLK_O
 320 #define KSYM_P                  SDLK_P
 321 #define KSYM_Q                  SDLK_Q
 322 #define KSYM_R                  SDLK_R
 323 #define KSYM_S                  SDLK_S
 324 #define KSYM_T                  SDLK_T
 325 #define KSYM_U                  SDLK_U
 326 #define KSYM_V                  SDLK_V
 327 #define KSYM_W                  SDLK_W
 328 #define KSYM_X                  SDLK_X
 329 #define KSYM_Y                  SDLK_Y
 330 #define KSYM_Z                  SDLK_Z
 331
 332 #define KSYM_a                  SDLK_a
 333 #define KSYM_b                  SDLK_b
 334 #define KSYM_c                  SDLK_c
 335 #define KSYM_d                  SDLK_d
 336 #define KSYM_e                  SDLK_e
 337 #define KSYM_f                  SDLK_f
 338 #define KSYM_g                  SDLK_g
 339 #define KSYM_h                  SDLK_h
 340 #define KSYM_i                  SDLK_i
 341 #define KSYM_j                  SDLK_j
 342 #define KSYM_k                  SDLK_k
 343 #define KSYM_l                  SDLK_l
 344 #define KSYM_m                  SDLK_m
 345 #define KSYM_n                  SDLK_n
 346 #define KSYM_o                  SDLK_o
 347 #define KSYM_p                  SDLK_p
 348 #define KSYM_q                  SDLK_q
 349 #define KSYM_r                  SDLK_r
 350 #define KSYM_s                  SDLK_s
 351 #define KSYM_t                  SDLK_t
 352 #define KSYM_u                  SDLK_u
 353 #define KSYM_v                  SDLK_v
 354 #define KSYM_w                  SDLK_w
 355 #define KSYM_x                  SDLK_x
 356 #define KSYM_y                  SDLK_y
 357 #define KSYM_z                  SDLK_z
 358
 359 #define KSYM_0                  SDLK_0
 360 #define KSYM_1                  SDLK_1
 361 #define KSYM_2                  SDLK_2
 362 #define KSYM_3                  SDLK_3
 363 #define KSYM_4                  SDLK_4
 364 #define KSYM_5                  SDLK_5
 365 #define KSYM_6                  SDLK_6
 366 #define KSYM_7                  SDLK_7
 367 #define KSYM_8                  SDLK_8
 368 #define KSYM_9                  SDLK_9
 369
 370 #if defined(TARGET_SDL2)
 371 #define KSYM_KP_0               SDLK_KP_0
 372 #define KSYM_KP_1               SDLK_KP_1
 373 #define KSYM_KP_2               SDLK_KP_2
 374 #define KSYM_KP_3               SDLK_KP_3
 375 #define KSYM_KP_4               SDLK_KP_4
 376 #define KSYM_KP_5               SDLK_KP_5
 377 #define KSYM_KP_6               SDLK_KP_6
 378 #define KSYM_KP_7               SDLK_KP_7
 379 #define KSYM_KP_8               SDLK_KP_8
 380 #define KSYM_KP_9               SDLK_KP_9
 381 #else
 382 #define KSYM_KP_0               SDLK_KP0
 383 #define KSYM_KP_1               SDLK_KP1
 384 #define KSYM_KP_2               SDLK_KP2
 385 #define KSYM_KP_3               SDLK_KP3
 386 #define KSYM_KP_4               SDLK_KP4
 387 #define KSYM_KP_5               SDLK_KP5
 388 #define KSYM_KP_6               SDLK_KP6
 389 #define KSYM_KP_7               SDLK_KP7
 390 #define KSYM_KP_8               SDLK_KP8
 391 #define KSYM_KP_9               SDLK_KP9
 392 #endif
 393
 394 #define KSYM_F1                 SDLK_F1
 395 #define KSYM_F2                 SDLK_F2
 396 #define KSYM_F3                 SDLK_F3
 397 #define KSYM_F4                 SDLK_F4
 398 #define KSYM_F5                 SDLK_F5
 399 #define KSYM_F6                 SDLK_F6
 400 #define KSYM_F7                 SDLK_F7
 401 #define KSYM_F8                 SDLK_F8
 402 #define KSYM_F9                 SDLK_F9
 403 #define KSYM_F10                SDLK_F10
 404 #define KSYM_F11                SDLK_F11
 405 #define KSYM_F12                SDLK_F12
 406
 407 #define KSYM_FKEY_FIRST         KSYM_F1
 408 #define KSYM_FKEY_LAST          KSYM_F12
 409 #define KSYM_NUM_FKEYS          (KSYM_FKEY_LAST - KSYM_FKEY_FIRST + 1)
 410
 411 #define KMOD_None               KMOD_NONE
 412 #define KMOD_Shift_L            KMOD_LSHIFT
 413 #define KMOD_Shift_R            KMOD_RSHIFT
 414 #define KMOD_Control_L          KMOD_LCTRL
 415 #define KMOD_Control_R          KMOD_RCTRL
 416
 417 #if defined(TARGET_SDL2)
 418 #define KMOD_Meta_L             KMOD_LGUI
 419 #define KMOD_Meta_R             KMOD_RGUI
 420 #else
 421 #define KMOD_Meta_L             KMOD_LMETA
 422 #define KMOD_Meta_R             KMOD_RMETA
 423 #endif
 424
 425 #define KMOD_Alt_L              KMOD_LALT
 426 #define KMOD_Alt_R              KMOD_RALT
 427
 428 #define KMOD_Shift              (KMOD_Shift_L   | KMOD_Shift_R)
 429 #define KMOD_Control            (KMOD_Control_L | KMOD_Control_R)
 430 #define KMOD_Meta               (KMOD_Meta_L    | KMOD_Meta_R)
 431 #define KMOD_Alt                (KMOD_Alt_L     | KMOD_Alt_R)
 432
 433 /* this only contains "valid" key modifiers (and ignores keys like "NumLock") */
 434 #define KMOD_Valid              (KMOD_Shift   | \
 435                                  KMOD_Control | \
 436                                  KMOD_Meta    | \
 437                                  KMOD_Alt)
 438
 439 #if defined(TARGET_SDL2)
 440 #define KMOD_TextInput          (KMOD_Shift | KMOD_Alt_R)
 441 #endif
 442
 443 /* SDL function definitions */
 444
 445 boolean SDLSetNativeSurface(SDL_Surface **);
 446 SDL_Surface *SDLGetNativeSurface(SDL_Surface *);
 447 void SDLCreateBitmapTextures(Bitmap *);
 448 void SDLFreeBitmapTextures(Bitmap *);
 449
 450 #if defined(TARGET_SDL2)
 451 SDL_Surface *SDL_DisplayFormat(SDL_Surface *);
 452 void SDLSetWindowScaling(int);
 453 void SDLSetWindowScalingQuality(char *);
 454 void SDLSetWindowFullscreen(boolean);
 455 void SDLSetDisplaySize(void);
 456 void SDLSetScreenSizeAndOffsets(int, int);
 457 void SDLSetScreenSizeForRenderer(int, int);
 458 void SDLSetScreenProperties(void);
 459 #endif
 460
 461 void SDLSetScreenRenderingMode(char *);
 462 void SDLRedrawWindow(void);
 463 void SDLSetWindowTitle(void);
 464
 465 void SDLLimitScreenUpdates(boolean);
 466 void SDLInitVideoDisplay(void);
 467 void SDLInitVideoBuffer(boolean);
 468 boolean SDLSetVideoMode(boolean);
 469 void SDLCreateBitmapContent(Bitmap *, int, int, int);
 470 void SDLFreeBitmapPointers(Bitmap *);
 471 void SDLCopyArea(Bitmap *, Bitmap *, int, int, int, int, int, int, int);
 472 void SDLBlitTexture(Bitmap *, int, int, int, int, int, int, int);
 473 void SDLFillRectangle(Bitmap *, int, int, int, int, Uint32);
 474 void SDLFadeRectangle(int, int, int, int, int, int, int,
 475                       void (*draw_border_function)(void));
 476 void SDLDrawSimpleLine(Bitmap *, int, int, int, int, Uint32);
 477 void SDLDrawLine(Bitmap *, int, int, int, int, Uint32);
 478 Pixel SDLGetPixel(Bitmap *, int, int);
 479 void SDLPutPixel(Bitmap *, int, int, Pixel);
 480
 481 void SDLInvertArea(Bitmap *, int, int, int, int, Uint32);
 482 void SDLCopyInverseMasked(Bitmap *, Bitmap *, int, int, int, int, int, int);
 483
 484 Bitmap *SDLZoomBitmap(Bitmap *, int, int);
 485
 486 Bitmap *SDLLoadImage(char *);
 487
 488 void SDLSetMouseCursor(struct MouseCursorInfo *);
 489
 490 void SDLOpenAudio(void);
 491 void SDLCloseAudio(void);
 492
 493 void SDLWaitEvent(Event *);
 494 void SDLHandleWindowManagerEvent(Event *);
 495
 496 void HandleJoystickEvent(Event *);
 497 void SDLInitJoysticks(void);
 498 boolean SDLReadJoystick(int, int *, int *, boolean *, boolean *);
 499 boolean SDLCheckJoystickOpened(int);
 500 void SDLClearJoystickState(void);
 501 boolean SDLOpenJoystick(int);
 502 void SDLCloseJoystick(int);
 503
 504 void PrepareFadeBitmap(int);
 505
 506 void Delay_WithScreenUpdates(unsigned int);
 507
 508 #endif /* SDL_H */