-
-
Notifications
You must be signed in to change notification settings - Fork 517
/
main_sdl.cpp
3601 lines (3236 loc) · 114 KB
/
main_sdl.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
This file is part of Warzone 2100.
Copyright (C) 2011-2020 Warzone 2100 Project
Warzone 2100 is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
Warzone 2100 is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with Warzone 2100; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
/**
* @file main_sdl.cpp
*
* SDL backend code
*/
// Get platform defines before checking for them!
#include "lib/framework/wzapp.h"
#include "lib/framework/input.h"
#include "lib/framework/utf.h"
#include "lib/ivis_opengl/pieclip.h"
#include "lib/ivis_opengl/piemode.h"
#include "lib/ivis_opengl/screen.h"
#include "lib/exceptionhandler/dumpinfo.h"
#include "lib/gamelib/gtime.h"
#include "src/configuration.h"
#include "src/warzoneconfig.h"
#include "src/game.h"
#include "gfx_api_sdl.h"
#include "gfx_api_gl_sdl.h"
#if defined( _MSC_VER )
// Silence warning when using MSVC ARM64 compiler
// warning C4121: 'SDL_hid_device_info': alignment of a member was sensitive to packing
#pragma warning( push )
#pragma warning( disable : 4121 )
#endif
#include <SDL.h>
#include <SDL_thread.h>
#include <SDL_clipboard.h>
#if defined(HAVE_SDL_VULKAN_H)
#include <SDL_vulkan.h>
#endif
#include <SDL_version.h>
#if defined( _MSC_VER )
#pragma warning( pop )
#endif
#include "wz2100icon.h"
#include "cursors_sdl.h"
#include <algorithm>
#include <map>
#include <locale.h>
#include <atomic>
#include <chrono>
#if defined(WZ_OS_MAC)
#include "cocoa_sdl_helpers.h"
#include "cocoa_wz_menus.h"
#endif
#include <nonstd/optional.hpp>
using nonstd::optional;
using nonstd::nullopt;
void mainLoop();
// used in crash reports & version info
const char *BACKEND = "SDL";
std::map<KEY_CODE, SDL_Keycode> KEY_CODE_to_SDLKey;
std::map<SDL_Keycode, KEY_CODE > SDLKey_to_KEY_CODE;
int realmain(int argc, char *argv[]);
// the main stub which calls realmain() aka, WZ's main startup routines
int main(int argc, char *argv[])
{
return realmain(argc, argv);
}
// At this time, we only have 1 window.
static SDL_Window *WZwindow = nullptr;
static optional<video_backend> WZbackend = video_backend::opengl;
#if defined(WZ_OS_MAC) || defined(WZ_OS_WIN)
// on macOS, SDL_WINDOW_FULLSCREEN_DESKTOP *must* be used (or high-DPI fullscreen toggling breaks)
const WINDOW_MODE WZ_SDL_DEFAULT_FULLSCREEN_MODE = WINDOW_MODE::desktop_fullscreen;
#else
const WINDOW_MODE WZ_SDL_DEFAULT_FULLSCREEN_MODE = WINDOW_MODE::fullscreen;
#endif
static WINDOW_MODE altEnterToggleFullscreenMode = WZ_SDL_DEFAULT_FULLSCREEN_MODE;
// The screen that the game window is on.
int screenIndex = 0;
// The logical resolution of the game in the game's coordinate system (points).
unsigned int screenWidth = 0;
unsigned int screenHeight = 0;
// The logical resolution of the SDL window in the window's coordinate system (points) - i.e. not accounting for the Game Display Scale setting.
unsigned int windowWidth = 0;
unsigned int windowHeight = 0;
// The current display scale factor.
unsigned int current_displayScale = 100;
float current_displayScaleFactor = 1.f;
struct QueuedWindowDimensions
{
int width;
int height;
bool recenter;
};
optional<QueuedWindowDimensions> deferredDimensionReset = nullopt;
static std::vector<screeninfo> displaylist; // holds all our possible display lists
std::atomic<Uint32> wzSDLAppEvent((Uint32)-1);
enum wzSDLAppEventCodes
{
MAINTHREADEXEC
};
/* The possible states for keys */
enum KEY_STATE
{
KEY_UP,
KEY_PRESSED,
KEY_DOWN,
KEY_RELEASED,
KEY_PRESSRELEASE, // When a key goes up and down in a frame
KEY_DOUBLECLICK, // Only used by mouse keys
KEY_DRAG // Only used by mouse keys
};
struct INPUT_STATE
{
KEY_STATE state; /// Last key/mouse state
UDWORD lastdown; /// last key/mouse button down timestamp
Vector2i pressPos; ///< Location of last mouse press event.
Vector2i releasePos; ///< Location of last mouse release event.
};
// Clipboard routines
bool has_scrap(void);
bool get_scrap(char **dst);
/// constant for the interval between 2 singleclicks for doubleclick event in ms
#define DOUBLE_CLICK_INTERVAL 250
/* The current state of the keyboard */
static INPUT_STATE aKeyState[KEY_MAXSCAN]; // NOTE: SDL_NUM_SCANCODES is the max, but KEY_MAXSCAN is our limit
/* The current location of the mouse */
static Uint16 mouseXPos = 0;
static Uint16 mouseYPos = 0;
static Vector2i mouseWheelSpeed;
static bool mouseInWindow = true;
/* How far the mouse has to move to start a drag */
#define DRAG_THRESHOLD 5
/* Which button is being used for a drag */
static MOUSE_KEY_CODE dragKey;
/* The start of a possible drag by the mouse */
static int dragX = 0;
static int dragY = 0;
/* The current mouse button state */
static INPUT_STATE aMouseState[MOUSE_END];
static MousePresses mousePresses;
/* The current screen resizing state for this iteration through the game loop, in the game coordinate system */
struct ScreenSizeChange
{
ScreenSizeChange(unsigned int oldWidth, unsigned int oldHeight, unsigned int newWidth, unsigned int newHeight)
: oldWidth(oldWidth)
, oldHeight(oldHeight)
, newWidth(newWidth)
, newHeight(newHeight)
{ }
unsigned int oldWidth;
unsigned int oldHeight;
unsigned int newWidth;
unsigned int newHeight;
};
static ScreenSizeChange* currentScreenResizingStatus = nullptr;
/* The size of the input buffer */
#define INPUT_MAXSTR 256
/* The input string buffer */
struct InputKey
{
UDWORD key;
utf_32_char unicode;
};
static InputKey pInputBuffer[INPUT_MAXSTR];
static InputKey *pStartBuffer, *pEndBuffer;
static utf_32_char *utf8Buf; // is like the old 'unicode' from SDL 1.x
void* GetTextEventsOwner = nullptr;
static optional<int> wzQuitExitCode;
bool wzReduceDisplayScalingIfNeeded(int currWidth, int currHeight);
/**************************/
/*** Misc support ***/
/**************************/
WzString wzGetPlatform()
{
return WzString::fromUtf8(SDL_GetPlatform());
}
// Get system RAM (in MiB)
uint32_t wzGetSystemRAM()
{
auto systemRAMResult = SDL_GetSystemRAM();
return (systemRAMResult > 0) ? static_cast<uint32_t>(systemRAMResult) : 0;
}
// See if we have TEXT in the clipboard
bool has_scrap(void)
{
return SDL_HasClipboardText();
}
// Set the clipboard text
bool wzSetClipboardText(const char *src)
{
if (SDL_SetClipboardText(src))
{
debug(LOG_ERROR, "Could not put clipboard text because : %s", SDL_GetError());
return false;
}
return true;
}
// Get text from the clipboard
bool get_scrap(char **dst)
{
if (has_scrap())
{
char *cliptext = SDL_GetClipboardText();
if (!cliptext)
{
debug(LOG_ERROR, "Could not get clipboard text because : %s", SDL_GetError());
return false;
}
*dst = cliptext;
return true;
}
else
{
// wasn't text or no text in the clipboard
return false;
}
}
void StartTextInput(void* pTextInputRequester, const WzTextInputRect& textInputRect)
{
if (!GetTextEventsOwner)
{
SDL_Rect rect;
rect.x = textInputRect.x;
rect.y = textInputRect.y;
rect.w = textInputRect.width;
rect.h = textInputRect.height;
SDL_SetTextInputRect(&rect);
SDL_StartTextInput(); // enable text events
debug(LOG_INPUT, "SDL text events started");
}
else if (pTextInputRequester != GetTextEventsOwner)
{
debug(LOG_INPUT, "StartTextInput called by new input requester before old requester called StopTextInput");
}
GetTextEventsOwner = pTextInputRequester;
// on some platforms, it seems like we also need to call SDL_SetTextInputRect every frame to properly set the text input rect (?)
SDL_Rect rect;
rect.x = textInputRect.x;
rect.y = textInputRect.y;
rect.w = textInputRect.width;
rect.h = textInputRect.height;
SDL_SetTextInputRect(&rect);
}
void StopTextInput(void* pTextInputResigner)
{
if (!GetTextEventsOwner)
{
debug(LOG_INPUT, "Ignoring StopTextInput call when text input is already disabled");
return;
}
if (pTextInputResigner != GetTextEventsOwner)
{
// Rejecting StopTextInput from regsigner who is not the last requester
debug(LOG_INPUT, "Ignoring StopTextInput call from resigner that is not the last requester (i.e. caller of StartTextInput)");
return;
}
SDL_StopTextInput(); // disable text events
GetTextEventsOwner = nullptr;
debug(LOG_INPUT, "SDL text events stopped");
}
bool isInTextInputMode()
{
bool result = (GetTextEventsOwner != nullptr);
ASSERT((SDL_IsTextInputActive() != SDL_FALSE) == result, "How did GetTextEvents state and SDL_IsTextInputActive get out of sync?");
return result;
}
bool wzHasTouchInputDevices()
{
return SDL_GetNumTouchDevices() > 0;
}
bool wzSeemsLikeNonTouchPlatform()
{
return !wzHasTouchInputDevices() || (SDL_HasScreenKeyboardSupport() == SDL_FALSE);
}
/* Put a character into a text buffer overwriting any text under the cursor */
WzString wzGetSelection()
{
WzString retval;
static char *scrap = nullptr;
if (get_scrap(&scrap))
{
retval = WzString::fromUtf8(scrap);
}
return retval;
}
std::vector<screeninfo> wzAvailableResolutions()
{
return displaylist;
}
screeninfo wzGetCurrentFullscreenDisplayMode()
{
screeninfo result = {};
if (WZwindow == nullptr)
{
debug(LOG_WARNING, "wzGetCurrentFullscreenDisplayMode called when window is not available");
return {};
}
SDL_DisplayMode current = { 0, 0, 0, 0, 0 };
int currScreen = SDL_GetWindowDisplayIndex(WZwindow);
if (currScreen < 0)
{
debug(LOG_WZ, "Failed to get current screen index: %s", SDL_GetError());
currScreen = 0;
}
if (SDL_GetWindowDisplayMode(WZwindow, ¤t) != 0)
{
// Failed to get current fullscreen display mode for window?
debug(LOG_WZ, "Failed to get current WindowDisplayMode: %s", SDL_GetError());
return {};
}
result.screen = currScreen;
result.width = current.w;
result.height = current.h;
result.refresh_rate = current.refresh_rate;
return result;
}
std::vector<unsigned int> wzAvailableDisplayScales()
{
static const unsigned int wzDisplayScales[] = { 100, 125, 150, 200, 250, 300, 400, 500 };
return std::vector<unsigned int>(wzDisplayScales, wzDisplayScales + (sizeof(wzDisplayScales) / sizeof(wzDisplayScales[0])));
}
static std::vector<video_backend>& sortGfxBackendsForCurrentSystem(std::vector<video_backend>& backends)
{
#if defined(_WIN32) && defined(WZ_BACKEND_DIRECTX) && (defined(_M_ARM64) || defined(_M_ARM))
// On ARM-based Windows, DirectX should be first (for compatibility)
std::stable_sort(backends.begin(), backends.end(), [](video_backend a, video_backend b) -> bool {
if (a == b) { return false; }
if (a == video_backend::directx) { return true; }
return false;
});
#else
// currently, no-op
#endif
return backends;
}
std::vector<video_backend> wzAvailableGfxBackends()
{
std::vector<video_backend> availableBackends;
availableBackends.push_back(video_backend::opengl);
#if !defined(WZ_OS_MAC) // OpenGL ES is not supported on macOS, and WZ doesn't currently ship with an OpenGL ES library on macOS
availableBackends.push_back(video_backend::opengles);
#endif
#if defined(WZ_VULKAN_ENABLED) && defined(HAVE_SDL_VULKAN_H)
availableBackends.push_back(video_backend::vulkan);
#endif
#if defined(WZ_BACKEND_DIRECTX)
availableBackends.push_back(video_backend::directx);
#endif
sortGfxBackendsForCurrentSystem(availableBackends);
return availableBackends;
}
video_backend wzGetDefaultGfxBackendForCurrentSystem()
{
// SDL backend supports: OpenGL, OpenGLES, Vulkan (if compiled with support), DirectX (on Windows, via LibANGLE)
#if defined(_WIN32) && defined(WZ_BACKEND_DIRECTX) && (defined(_M_ARM64) || defined(_M_ARM))
// On ARM-based Windows, DirectX should be the default (for compatibility)
return video_backend::directx;
#else
// Future TODO examples:
// - Default to Vulkan backend on macOS versions > 10.??, to use Metal via MoltenVK (needs testing - and may require exclusions depending on hardware?)
// - Default to DirectX (via LibANGLE) backend on Windows, depending on Windows version (and possibly hardware? / DirectX-level support?)
// - Check if Vulkan appears to be properly supported on a Windows / Linux system, and default to Vulkan backend?
// For now, default to OpenGL (which automatically falls back to OpenGL ES if needed)
return video_backend::opengl;
#endif
}
static video_backend wzGetNextFallbackGfxBackendForCurrentSystem(const video_backend& current_failed_backend)
{
video_backend next_backend;
#if defined(_WIN32) && defined(WZ_BACKEND_DIRECTX)
switch (current_failed_backend)
{
case video_backend::opengl:
// offer DirectX as a fallback option if OpenGL failed
next_backend = video_backend::directx;
break;
#if (defined(_M_ARM64) || defined(_M_ARM))
case video_backend::directx:
// since DirectX is the default on ARM-based Windows, offer OpenGL as an alternative
next_backend = video_backend::opengl;
break;
#endif
default:
// offer usual default
next_backend = wzGetDefaultGfxBackendForCurrentSystem();
break;
}
#elif defined(WZ_OS_MAC)
switch (current_failed_backend)
{
case video_backend::opengl:
// offer Vulkan (which uses Vulkan -> Metal) as a fallback option if OpenGL failed
next_backend = video_backend::vulkan;
break;
default:
// offer usual default
next_backend = wzGetDefaultGfxBackendForCurrentSystem();
break;
}
#else
next_backend = wzGetDefaultGfxBackendForCurrentSystem();
#endif
// sanity-check: verify that next_backend is in available backends
const auto available = wzAvailableGfxBackends();
if (std::find(available.begin(), available.end(), next_backend) == available.end())
{
// next_backend does not exist in the list of available backends, so default to wzGetDefaultGfxBackendForCurrentSystem()
next_backend = wzGetDefaultGfxBackendForCurrentSystem();
}
return next_backend;
}
void SDL_WZBackend_GetDrawableSize(SDL_Window* window,
int* w,
int* h)
{
if (!WZbackend.has_value())
{
return;
}
switch (WZbackend.value())
{
#if defined(WZ_BACKEND_DIRECTX)
case video_backend::directx: // because DirectX is supported via OpenGLES (LibANGLE)
#endif
case video_backend::opengl:
case video_backend::opengles:
return SDL_GL_GetDrawableSize(window, w, h);
case video_backend::vulkan:
#if defined(HAVE_SDL_VULKAN_H)
return SDL_Vulkan_GetDrawableSize(window, w, h);
#else
SDL_version compiled_version;
SDL_VERSION(&compiled_version);
debug(LOG_FATAL, "The version of SDL used for compilation (%u.%u.%u) did not have the SDL_vulkan.h header", (unsigned int)compiled_version.major, (unsigned int)compiled_version.minor, (unsigned int)compiled_version.patch);
if (w) { w = 0; }
if (h) { h = 0; }
return;
#endif
case video_backend::num_backends:
debug(LOG_FATAL, "Should never happen");
return;
}
}
void setDisplayScale(unsigned int displayScale)
{
ASSERT(displayScale >= 100, "Invalid display scale: %u", displayScale);
current_displayScale = displayScale;
current_displayScaleFactor = (float)displayScale / 100.f;
}
unsigned int wzGetCurrentDisplayScale()
{
return current_displayScale;
}
void wzShowMouse(bool visible)
{
SDL_ShowCursor(visible ? SDL_ENABLE : SDL_DISABLE);
}
int wzGetTicks()
{
return SDL_GetTicks();
}
void wzDisplayDialog(DialogType type, const char *title, const char *message)
{
if (!WZbackend.has_value())
{
// while this could be thread_local, thread_local may not yet be supported on all platforms properly
// and wzDisplayDialog should probably be called **only** on the main thread anyway
static bool processingDialog = false;
if (!processingDialog)
{
// in headless mode, do not display a messagebox (which might block the main thread)
// but just log the details
processingDialog = true;
debug(LOG_INFO, "Suppressed dialog (headless):\n\tTitle: %s\n\tMessage: %s", title, message);
processingDialog = false;
}
return;
}
Uint32 sdl_messagebox_flags = 0;
switch (type)
{
case Dialog_Error:
sdl_messagebox_flags = SDL_MESSAGEBOX_ERROR;
break;
case Dialog_Warning:
sdl_messagebox_flags = SDL_MESSAGEBOX_WARNING;
break;
case Dialog_Information:
sdl_messagebox_flags = SDL_MESSAGEBOX_INFORMATION;
break;
}
SDL_ShowSimpleMessageBox(sdl_messagebox_flags, title, message, WZwindow);
}
WINDOW_MODE wzGetCurrentWindowMode()
{
if (!WZbackend.has_value())
{
// return a dummy value
return WINDOW_MODE::windowed;
}
if (WZwindow == nullptr)
{
debug(LOG_WARNING, "wzGetCurrentWindowMode called when window is not available");
return WINDOW_MODE::windowed;
}
Uint32 flags = SDL_GetWindowFlags(WZwindow);
if ((flags & SDL_WINDOW_FULLSCREEN_DESKTOP) == SDL_WINDOW_FULLSCREEN_DESKTOP)
{
return WINDOW_MODE::desktop_fullscreen;
}
else if (flags & SDL_WINDOW_FULLSCREEN)
{
return WINDOW_MODE::fullscreen;
}
else
{
return WINDOW_MODE::windowed;
}
}
std::vector<WINDOW_MODE> wzSupportedWindowModes()
{
#if defined(WZ_OS_MAC)
// on macOS, SDL_WINDOW_FULLSCREEN_DESKTOP *must* be used (or high-DPI fullscreen toggling breaks)
// thus "classic" fullscreen is not supported
return {WINDOW_MODE::desktop_fullscreen, WINDOW_MODE::windowed};
#else
return {WINDOW_MODE::desktop_fullscreen, WINDOW_MODE::windowed, WINDOW_MODE::fullscreen};
#endif
}
bool wzIsSupportedWindowMode(WINDOW_MODE mode)
{
auto supportedModes = wzSupportedWindowModes();
return std::any_of(supportedModes.begin(), supportedModes.end(), [mode](WINDOW_MODE i) -> bool {
return i == mode;
});
}
WINDOW_MODE wzGetNextWindowMode(WINDOW_MODE currentMode)
{
auto supportedModes = wzSupportedWindowModes();
ASSERT_OR_RETURN(WINDOW_MODE::windowed, !supportedModes.empty(), "No supported fullscreen / windowed modes available?");
auto it = std::find(supportedModes.begin(), supportedModes.end(), currentMode);
if (it == supportedModes.end())
{
// we appear to be in an unsupported mode - so default to the first
return *supportedModes.begin();
}
++it;
if (it == supportedModes.end()) { it = supportedModes.begin(); }
return *it;
}
WINDOW_MODE wzAltEnterToggleFullscreen()
{
// toggles out of and into the "last" fullscreen mode
auto mode = wzGetCurrentWindowMode();
switch (mode)
{
case WINDOW_MODE::desktop_fullscreen:
// fall-through
case WINDOW_MODE::fullscreen:
altEnterToggleFullscreenMode = mode;
if (wzChangeWindowMode(WINDOW_MODE::windowed))
{
mode = WINDOW_MODE::windowed;
}
break;
case WINDOW_MODE::windowed:
// use altEnterToggleFullscreenMode
if (wzChangeWindowMode(altEnterToggleFullscreenMode))
{
mode = altEnterToggleFullscreenMode;
}
break;
}
return mode;
}
bool wzSetToggleFullscreenMode(WINDOW_MODE fullscreenMode)
{
switch (fullscreenMode)
{
case WINDOW_MODE::fullscreen:
case WINDOW_MODE::desktop_fullscreen:
{
if (!wzIsSupportedWindowMode(fullscreenMode))
{
// not a supported mode on this system!
return false;
}
altEnterToggleFullscreenMode = fullscreenMode;
return true;
}
default:
return false;
}
}
WINDOW_MODE wzGetToggleFullscreenMode()
{
return altEnterToggleFullscreenMode;
}
bool wzChangeWindowMode(WINDOW_MODE mode)
{
auto currMode = wzGetCurrentWindowMode();
if (currMode == mode)
{
// already in this mode
return true;
}
if (!wzIsSupportedWindowMode(mode))
{
// not a supported mode on this system
return false;
}
debug(LOG_INFO, "Changing window mode: %s -> %s", to_display_string(currMode).c_str(), to_display_string(mode).c_str());
int sdl_result = -1;
switch (mode)
{
case WINDOW_MODE::desktop_fullscreen:
sdl_result = SDL_SetWindowFullscreen(WZwindow, SDL_WINDOW_FULLSCREEN_DESKTOP);
if (sdl_result != 0) { return false; }
wzSetWindowIsResizable(false);
break;
case WINDOW_MODE::windowed:
{
int currDisplayIndex = SDL_GetWindowDisplayIndex(WZwindow);
if (currDisplayIndex < 0)
{
currDisplayIndex = screenIndex;
}
// disable fullscreen mode
sdl_result = SDL_SetWindowFullscreen(WZwindow, 0);
if (sdl_result != 0) { return false; }
wzSetWindowIsResizable(true);
// Determine the maximum usable windowed size for this display/screen, and cap the desired window size at that
int desiredWidth = war_GetWidth(), desiredHeight = war_GetHeight();
SDL_Rect displayUsableBounds = { 0, 0, 0, 0 };
#if defined(WZ_OS_MAC)
// SDL currently triggers an internal assert when calling SDL_GetDisplayUsableBounds here on macOS - so use SDL_GetDisplayBounds for now
if (SDL_GetDisplayBounds(currDisplayIndex, &displayUsableBounds) == 0)
#else
if (SDL_GetDisplayUsableBounds(currDisplayIndex, &displayUsableBounds) == 0)
#endif
{
if (displayUsableBounds.w > 0 && displayUsableBounds.h > 0)
{
desiredWidth = std::min(displayUsableBounds.w, desiredWidth);
desiredHeight = std::min(displayUsableBounds.h, desiredHeight);
}
}
// restore the old windowed size
SDL_SetWindowSize(WZwindow, desiredWidth, desiredHeight);
// Position the window (centered) on the screen (for its new size)
SDL_SetWindowPosition(WZwindow, SDL_WINDOWPOS_CENTERED_DISPLAY(currDisplayIndex), SDL_WINDOWPOS_CENTERED_DISPLAY(currDisplayIndex));
// Workaround for issues properly restoring window dimensions when changing from fullscreen -> windowed (on some platforms)
deferredDimensionReset = QueuedWindowDimensions {desiredWidth, desiredHeight, true};
break;
}
case WINDOW_MODE::fullscreen:
{
sdl_result = SDL_SetWindowFullscreen(WZwindow, SDL_WINDOW_FULLSCREEN);
if (sdl_result != 0) { return false; }
wzSetWindowIsResizable(false);
int currWidth = 0, currHeight = 0;
SDL_GetWindowSize(WZwindow, &currWidth, &currHeight);
wzReduceDisplayScalingIfNeeded(currWidth, currHeight);
break;
}
}
return sdl_result == 0;
}
bool wzIsFullscreen()
{
if (WZwindow == nullptr)
{
// NOTE: Can't use debug(...) to log here or it will risk overwriting fatal error messages,
// as `_debug(...)` calls this function
return false;
}
Uint32 flags = SDL_GetWindowFlags(WZwindow);
if ((flags & SDL_WINDOW_FULLSCREEN) || (flags & SDL_WINDOW_FULLSCREEN_DESKTOP))
{
return true;
}
return false;
}
bool wzIsMaximized()
{
if (WZwindow == nullptr)
{
debug(LOG_WARNING, "wzIsMaximized called when window is not available");
return false;
}
Uint32 flags = SDL_GetWindowFlags(WZwindow);
if (flags & SDL_WINDOW_MAXIMIZED)
{
return true;
}
return false;
}
void wzQuit(int exitCode)
{
if (!wzQuitExitCode.has_value())
{
wzQuitExitCode = exitCode;
}
// Create a quit event to halt game loop.
SDL_Event quitEvent;
quitEvent.type = SDL_QUIT;
SDL_PushEvent(&quitEvent);
}
int wzGetQuitExitCode()
{
return wzQuitExitCode.value_or(0);
}
void wzGrabMouse()
{
if (!WZbackend.has_value())
{
return;
}
if (WZwindow == nullptr)
{
debug(LOG_WARNING, "wzGrabMouse called when window is not available - ignoring");
return;
}
SDL_SetWindowGrab(WZwindow, SDL_TRUE);
}
void wzReleaseMouse()
{
if (!WZbackend.has_value())
{
return;
}
if (WZwindow == nullptr)
{
debug(LOG_WARNING, "wzReleaseMouse called when window is not available - ignoring");
return;
}
SDL_SetWindowGrab(WZwindow, SDL_FALSE);
}
void wzDelay(unsigned int delay)
{
SDL_Delay(delay);
}
/**************************/
/*** Thread support ***/
/**************************/
WZ_THREAD *wzThreadCreate(int (*threadFunc)(void *), void *data, const char* name)
{
const char* defaultName = "wzThread";
if (name == nullptr)
name = defaultName;
return (WZ_THREAD *)SDL_CreateThread(threadFunc, name, data);
}
unsigned long wzThreadID(WZ_THREAD *thread)
{
SDL_threadID threadID = SDL_GetThreadID((SDL_Thread *)thread);
return threadID;
}
int wzThreadJoin(WZ_THREAD *thread)
{
int result;
SDL_WaitThread((SDL_Thread *)thread, &result);
return result;
}
void wzThreadDetach(WZ_THREAD *thread)
{
SDL_DetachThread((SDL_Thread *)thread);
}
void wzThreadStart(WZ_THREAD *thread)
{
(void)thread; // no-op
}
void wzYieldCurrentThread()
{
SDL_Delay(40);
}
WZ_MUTEX *wzMutexCreate()
{
return (WZ_MUTEX *)SDL_CreateMutex();
}
void wzMutexDestroy(WZ_MUTEX *mutex)
{
SDL_DestroyMutex((SDL_mutex *)mutex);
}
void wzMutexLock(WZ_MUTEX *mutex)
{
SDL_LockMutex((SDL_mutex *)mutex);
}
void wzMutexUnlock(WZ_MUTEX *mutex)
{
SDL_UnlockMutex((SDL_mutex *)mutex);
}
WZ_SEMAPHORE *wzSemaphoreCreate(int startValue)
{
return (WZ_SEMAPHORE *)SDL_CreateSemaphore(startValue);
}
void wzSemaphoreDestroy(WZ_SEMAPHORE *semaphore)
{
SDL_DestroySemaphore((SDL_sem *)semaphore);
}
void wzSemaphoreWait(WZ_SEMAPHORE *semaphore)
{
SDL_SemWait((SDL_sem *)semaphore);
}
void wzSemaphorePost(WZ_SEMAPHORE *semaphore)
{
SDL_SemPost((SDL_sem *)semaphore);
}
// Asynchronously executes exec->doExecOnMainThread() on the main thread
// `exec` should be a subclass of `WZ_MAINTHREADEXEC`
//
// `exec` must be allocated on the heap since the main event loop takes ownership of it
// and will handle deleting it once it has been processed.
// It is not safe to access `exec` after calling wzAsyncExecOnMainThread.
//
// No guarantees are made about when execFunc() will be called relative to the
// calling of this function - this function may return before, during, or after
// execFunc()'s execution on the main thread.
void wzAsyncExecOnMainThread(WZ_MAINTHREADEXEC *exec)
{
Uint32 _wzSDLAppEvent = wzSDLAppEvent.load();
assert(_wzSDLAppEvent != ((Uint32)-1));
if (_wzSDLAppEvent == ((Uint32)-1)) {
// The app-defined event has not yet been registered with SDL
return;
}
SDL_Event execEvent;
SDL_memset(&execEvent, 0, sizeof(execEvent));
execEvent.type = _wzSDLAppEvent;
execEvent.user.code = wzSDLAppEventCodes::MAINTHREADEXEC;
execEvent.user.data1 = exec;
assert(execEvent.user.data1 != nullptr);
execEvent.user.data2 = 0;
SDL_PushEvent(&execEvent);
// receiver handles deleting `exec` on the main thread after doExecOnMainThread() has been called
}
/*!
** The keycodes we care about
**/
static inline void initKeycodes()
{
KEY_CODE_to_SDLKey.insert(std::pair<KEY_CODE, SDL_Keycode>(KEY_ESC, SDLK_ESCAPE));
KEY_CODE_to_SDLKey.insert(std::pair<KEY_CODE, SDL_Keycode>(KEY_1, SDLK_1));
KEY_CODE_to_SDLKey.insert(std::pair<KEY_CODE, SDL_Keycode>(KEY_2, SDLK_2));
KEY_CODE_to_SDLKey.insert(std::pair<KEY_CODE, SDL_Keycode>(KEY_3, SDLK_3));
KEY_CODE_to_SDLKey.insert(std::pair<KEY_CODE, SDL_Keycode>(KEY_4, SDLK_4));
KEY_CODE_to_SDLKey.insert(std::pair<KEY_CODE, SDL_Keycode>(KEY_5, SDLK_5));
KEY_CODE_to_SDLKey.insert(std::pair<KEY_CODE, SDL_Keycode>(KEY_6, SDLK_6));
KEY_CODE_to_SDLKey.insert(std::pair<KEY_CODE, SDL_Keycode>(KEY_7, SDLK_7));
KEY_CODE_to_SDLKey.insert(std::pair<KEY_CODE, SDL_Keycode>(KEY_8, SDLK_8));
KEY_CODE_to_SDLKey.insert(std::pair<KEY_CODE, SDL_Keycode>(KEY_9, SDLK_9));
KEY_CODE_to_SDLKey.insert(std::pair<KEY_CODE, SDL_Keycode>(KEY_0, SDLK_0));
KEY_CODE_to_SDLKey.insert(std::pair<KEY_CODE, SDL_Keycode>(KEY_MINUS, SDLK_MINUS));
KEY_CODE_to_SDLKey.insert(std::pair<KEY_CODE, SDL_Keycode>(KEY_EQUALS, SDLK_EQUALS));
KEY_CODE_to_SDLKey.insert(std::pair<KEY_CODE, SDL_Keycode>(KEY_BACKSPACE, SDLK_BACKSPACE));
KEY_CODE_to_SDLKey.insert(std::pair<KEY_CODE, SDL_Keycode>(KEY_TAB, SDLK_TAB));
KEY_CODE_to_SDLKey.insert(std::pair<KEY_CODE, SDL_Keycode>(KEY_Q, SDLK_q));
KEY_CODE_to_SDLKey.insert(std::pair<KEY_CODE, SDL_Keycode>(KEY_W, SDLK_w));
KEY_CODE_to_SDLKey.insert(std::pair<KEY_CODE, SDL_Keycode>(KEY_E, SDLK_e));
KEY_CODE_to_SDLKey.insert(std::pair<KEY_CODE, SDL_Keycode>(KEY_R, SDLK_r));
KEY_CODE_to_SDLKey.insert(std::pair<KEY_CODE, SDL_Keycode>(KEY_T, SDLK_t));
KEY_CODE_to_SDLKey.insert(std::pair<KEY_CODE, SDL_Keycode>(KEY_Y, SDLK_y));
KEY_CODE_to_SDLKey.insert(std::pair<KEY_CODE, SDL_Keycode>(KEY_U, SDLK_u));
KEY_CODE_to_SDLKey.insert(std::pair<KEY_CODE, SDL_Keycode>(KEY_I, SDLK_i));
KEY_CODE_to_SDLKey.insert(std::pair<KEY_CODE, SDL_Keycode>(KEY_O, SDLK_o));
KEY_CODE_to_SDLKey.insert(std::pair<KEY_CODE, SDL_Keycode>(KEY_P, SDLK_p));
KEY_CODE_to_SDLKey.insert(std::pair<KEY_CODE, SDL_Keycode>(KEY_LBRACE, SDLK_LEFTBRACKET));
KEY_CODE_to_SDLKey.insert(std::pair<KEY_CODE, SDL_Keycode>(KEY_RBRACE, SDLK_RIGHTBRACKET));
KEY_CODE_to_SDLKey.insert(std::pair<KEY_CODE, SDL_Keycode>(KEY_RETURN, SDLK_RETURN));
KEY_CODE_to_SDLKey.insert(std::pair<KEY_CODE, SDL_Keycode>(KEY_LCTRL, SDLK_LCTRL));
KEY_CODE_to_SDLKey.insert(std::pair<KEY_CODE, SDL_Keycode>(KEY_A, SDLK_a));
KEY_CODE_to_SDLKey.insert(std::pair<KEY_CODE, SDL_Keycode>(KEY_S, SDLK_s));
KEY_CODE_to_SDLKey.insert(std::pair<KEY_CODE, SDL_Keycode>(KEY_D, SDLK_d));
KEY_CODE_to_SDLKey.insert(std::pair<KEY_CODE, SDL_Keycode>(KEY_F, SDLK_f));
KEY_CODE_to_SDLKey.insert(std::pair<KEY_CODE, SDL_Keycode>(KEY_G, SDLK_g));
KEY_CODE_to_SDLKey.insert(std::pair<KEY_CODE, SDL_Keycode>(KEY_H, SDLK_h));
KEY_CODE_to_SDLKey.insert(std::pair<KEY_CODE, SDL_Keycode>(KEY_J, SDLK_j));
KEY_CODE_to_SDLKey.insert(std::pair<KEY_CODE, SDL_Keycode>(KEY_K, SDLK_k));
KEY_CODE_to_SDLKey.insert(std::pair<KEY_CODE, SDL_Keycode>(KEY_L, SDLK_l));
KEY_CODE_to_SDLKey.insert(std::pair<KEY_CODE, SDL_Keycode>(KEY_SEMICOLON, SDLK_SEMICOLON));
KEY_CODE_to_SDLKey.insert(std::pair<KEY_CODE, SDL_Keycode>(KEY_QUOTE, SDLK_QUOTE));
KEY_CODE_to_SDLKey.insert(std::pair<KEY_CODE, SDL_Keycode>(KEY_BACKQUOTE, SDLK_BACKQUOTE));
KEY_CODE_to_SDLKey.insert(std::pair<KEY_CODE, SDL_Keycode>(KEY_LSHIFT, SDLK_LSHIFT));
KEY_CODE_to_SDLKey.insert(std::pair<KEY_CODE, SDL_Keycode>(KEY_LMETA, SDLK_LGUI));
KEY_CODE_to_SDLKey.insert(std::pair<KEY_CODE, SDL_Keycode>(KEY_LSUPER, SDLK_LGUI));
KEY_CODE_to_SDLKey.insert(std::pair<KEY_CODE, SDL_Keycode>(KEY_BACKSLASH, SDLK_BACKSLASH));
KEY_CODE_to_SDLKey.insert(std::pair<KEY_CODE, SDL_Keycode>(KEY_Z, SDLK_z));