OpenTTD Source 20260311-master-g511d3794ce
sdl2_v.cpp
Go to the documentation of this file.
1/*
2 * This file is part of OpenTTD.
3 * OpenTTD 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, version 2.
4 * OpenTTD 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.
5 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
6 */
7
9
10#include "../stdafx.h"
11#include "../openttd.h"
12#include "../gfx_func.h"
14#include "../thread.h"
15#include "../progress.h"
16#include "../core/math_func.hpp"
18#include "../core/utf8.hpp"
19#include "../fileio_func.h"
20#include "../framerate_type.h"
21#include "../window_func.h"
22#include "sdl2_v.h"
23#include <SDL.h>
24#ifdef __EMSCRIPTEN__
25# include <emscripten.h>
26# include <emscripten/html5.h>
27#endif
28
29#include "../safeguards.h"
30
31void VideoDriver_SDL_Base::MakeDirty(int left, int top, int width, int height)
32{
33 Rect r = {left, top, left + width, top + height};
34 this->dirty_rect = BoundingRect(this->dirty_rect, r);
35}
36
38{
39 if (!CopyPalette(this->local_palette)) return;
40 this->MakeDirty(0, 0, _screen.width, _screen.height);
41}
42
43static const Dimension default_resolutions[] = {
44 { 640, 480 },
45 { 800, 600 },
46 { 1024, 768 },
47 { 1152, 864 },
48 { 1280, 800 },
49 { 1280, 960 },
50 { 1280, 1024 },
51 { 1400, 1050 },
52 { 1600, 1200 },
53 { 1680, 1050 },
54 { 1920, 1200 }
55};
56
57static void FindResolutions()
58{
59 _resolutions.clear();
60
61 for (int display = 0; display < SDL_GetNumVideoDisplays(); display++) {
62 for (int i = 0; i < SDL_GetNumDisplayModes(display); i++) {
63 SDL_DisplayMode mode;
64 SDL_GetDisplayMode(display, i, &mode);
65
66 if (mode.w < 640 || mode.h < 480) continue;
67 if (std::ranges::find(_resolutions, Dimension(mode.w, mode.h)) != _resolutions.end()) continue;
68 _resolutions.emplace_back(mode.w, mode.h);
69 }
70 }
71
72 /* We have found no resolutions, show the default list */
73 if (_resolutions.empty()) {
74 _resolutions.assign(std::begin(default_resolutions), std::end(default_resolutions));
75 }
76
77 SortResolutions();
78}
79
80static void GetAvailableVideoMode(uint *w, uint *h)
81{
82 /* All modes available? */
83 if (!_fullscreen || _resolutions.empty()) return;
84
85 /* Is the wanted mode among the available modes? */
86 if (std::ranges::find(_resolutions, Dimension(*w, *h)) != _resolutions.end()) return;
87
88 /* Use the closest possible resolution */
89 uint best = 0;
90 uint delta = Delta(_resolutions[0].width, *w) * Delta(_resolutions[0].height, *h);
91 for (uint i = 1; i != _resolutions.size(); ++i) {
92 uint newdelta = Delta(_resolutions[i].width, *w) * Delta(_resolutions[i].height, *h);
93 if (newdelta < delta) {
94 best = i;
95 delta = newdelta;
96 }
97 }
98 *w = _resolutions[best].width;
99 *h = _resolutions[best].height;
100}
101
102static uint FindStartupDisplay(uint startup_display)
103{
104 int num_displays = SDL_GetNumVideoDisplays();
105
106 /* If the user indicated a valid monitor, use that. */
107 if (IsInsideBS(startup_display, 0, num_displays)) return startup_display;
108
109 /* Mouse position decides which display to use. */
110 int mx, my;
111 SDL_GetGlobalMouseState(&mx, &my);
112 for (int display = 0; display < num_displays; ++display) {
113 SDL_Rect r;
114 if (SDL_GetDisplayBounds(display, &r) == 0 && IsInsideBS(mx, r.x, r.w) && IsInsideBS(my, r.y, r.h)) {
115 Debug(driver, 1, "SDL2: Mouse is at ({}, {}), use display {} ({}, {}, {}, {})", mx, my, display, r.x, r.y, r.w, r.h);
116 return display;
117 }
118 }
119
120 return 0;
121}
122
129void VideoDriver_SDL_Base::ClientSizeChanged(int w, int h, bool force)
130{
131 /* Allocate backing store of the new size. */
132 if (this->AllocateBackingStore(w, h, force)) {
133 CopyPalette(this->local_palette, true);
134
136
138 }
139}
140
141bool VideoDriver_SDL_Base::CreateMainWindow(uint w, uint h, uint flags)
142{
143 if (this->sdl_window != nullptr) return true;
144
145 flags |= SDL_WINDOW_SHOWN | SDL_WINDOW_RESIZABLE;
146
147 if (_fullscreen) {
148 flags |= SDL_WINDOW_FULLSCREEN;
149 }
150
151 int x = SDL_WINDOWPOS_UNDEFINED, y = SDL_WINDOWPOS_UNDEFINED;
152 SDL_Rect r;
153 if (SDL_GetDisplayBounds(this->startup_display, &r) == 0) {
154 x = r.x + std::max(0, r.w - static_cast<int>(w)) / 2;
155 y = r.y + std::max(0, r.h - static_cast<int>(h)) / 4; // decent desktops have taskbars at the bottom
156 }
157
158 std::string caption = VideoDriver::GetCaption();
159 this->sdl_window = SDL_CreateWindow(
160 caption.c_str(),
161 x, y,
162 w, h,
163 flags);
164
165 if (this->sdl_window == nullptr) {
166 Debug(driver, 0, "SDL2: Couldn't allocate a window to draw on: {}", SDL_GetError());
167 return false;
168 }
169
170 std::string icon_path = FioFindFullPath(BASESET_DIR, "openttd.32.bmp");
171 if (!icon_path.empty()) {
172 /* Give the application an icon */
173 SDL_Surface *icon = SDL_LoadBMP(icon_path.c_str());
174 if (icon != nullptr) {
175 /* Get the colourkey, which will be magenta */
176 uint32_t rgbmap = SDL_MapRGB(icon->format, 255, 0, 255);
177
178 SDL_SetColorKey(icon, SDL_TRUE, rgbmap);
179 SDL_SetWindowIcon(this->sdl_window, icon);
180 SDL_FreeSurface(icon);
181 }
182 }
183
184 return true;
185}
186
187bool VideoDriver_SDL_Base::CreateMainSurface(uint w, uint h, bool resize)
188{
189 GetAvailableVideoMode(&w, &h);
190 Debug(driver, 1, "SDL2: using mode {}x{}", w, h);
191
192 if (!this->CreateMainWindow(w, h)) return false;
193 if (resize) SDL_SetWindowSize(this->sdl_window, w, h);
194 this->ClientSizeChanged(w, h, true);
195
196 /* When in full screen, we will always have the mouse cursor
197 * within the window, even though SDL does not give us the
198 * appropriate event to know this. */
199 if (_fullscreen) _cursor.in_window = true;
200
201 return true;
202}
203
205{
206 /* Emscripten never claims the pointer, so we do not need to change the cursor visibility. */
207#ifndef __EMSCRIPTEN__
208 SDL_ShowCursor(0);
209#endif
210}
211
216{
217 if (!this->edit_box_focused) {
218 SDL_StartTextInput();
219 this->edit_box_focused = true;
220 }
221}
222
227{
228 if (this->edit_box_focused) {
229 SDL_StopTextInput();
230 this->edit_box_focused = false;
231 }
232}
233
235{
236 std::vector<int> rates = {};
237 for (int i = 0; i < SDL_GetNumVideoDisplays(); i++) {
238 SDL_DisplayMode mode = {};
239 if (SDL_GetDisplayMode(i, 0, &mode) != 0) continue;
240 if (mode.refresh_rate != 0) rates.push_back(mode.refresh_rate);
241 }
242 return rates;
243}
244
245
246struct SDLVkMapping {
247 const SDL_Keycode vk_from;
248 const uint8_t vk_count;
249 const uint8_t map_to;
250 const bool unprintable;
251
252 constexpr SDLVkMapping(SDL_Keycode vk_first, SDL_Keycode vk_last, uint8_t map_first, [[maybe_unused]] uint8_t map_last, bool unprintable)
253 : vk_from(vk_first), vk_count(vk_last - vk_first + 1), map_to(map_first), unprintable(unprintable)
254 {
255 assert((vk_last - vk_first) == (map_last - map_first));
256 }
257};
258
259#define AS(x, z) {x, x, z, z, false}
260#define AM(x, y, z, w) {x, y, z, w, false}
261#define AS_UP(x, z) {x, x, z, z, true}
262#define AM_UP(x, y, z, w) {x, y, z, w, true}
263
264static constexpr SDLVkMapping _vk_mapping[] = {
265 /* Pageup stuff + up/down */
266 AS_UP(SDLK_PAGEUP, WKC_PAGEUP),
267 AS_UP(SDLK_PAGEDOWN, WKC_PAGEDOWN),
268 AS_UP(SDLK_UP, WKC_UP),
269 AS_UP(SDLK_DOWN, WKC_DOWN),
270 AS_UP(SDLK_LEFT, WKC_LEFT),
271 AS_UP(SDLK_RIGHT, WKC_RIGHT),
272
273 AS_UP(SDLK_HOME, WKC_HOME),
274 AS_UP(SDLK_END, WKC_END),
275
276 AS_UP(SDLK_INSERT, WKC_INSERT),
277 AS_UP(SDLK_DELETE, WKC_DELETE),
278
279 /* Map letters & digits */
280 AM(SDLK_a, SDLK_z, 'A', 'Z'),
281 AM(SDLK_0, SDLK_9, '0', '9'),
282
283 AS_UP(SDLK_ESCAPE, WKC_ESC),
284 AS_UP(SDLK_PAUSE, WKC_PAUSE),
285 AS_UP(SDLK_BACKSPACE, WKC_BACKSPACE),
286
287 AS(SDLK_SPACE, WKC_SPACE),
288 AS(SDLK_RETURN, WKC_RETURN),
289 AS(SDLK_TAB, WKC_TAB),
290
291 /* Function keys */
292 AM_UP(SDLK_F1, SDLK_F12, WKC_F1, WKC_F12),
293
294 /* Numeric part. */
295 AS(SDLK_KP_1, '1'),
296 AS(SDLK_KP_2, '2'),
297 AS(SDLK_KP_3, '3'),
298 AS(SDLK_KP_4, '4'),
299 AS(SDLK_KP_5, '5'),
300 AS(SDLK_KP_6, '6'),
301 AS(SDLK_KP_7, '7'),
302 AS(SDLK_KP_8, '8'),
303 AS(SDLK_KP_9, '9'),
304 AS(SDLK_KP_0, '0'),
305 AS(SDLK_KP_DIVIDE, WKC_NUM_DIV),
306 AS(SDLK_KP_MULTIPLY, WKC_NUM_MUL),
307 AS(SDLK_KP_MINUS, WKC_NUM_MINUS),
308 AS(SDLK_KP_PLUS, WKC_NUM_PLUS),
309 AS(SDLK_KP_ENTER, WKC_NUM_ENTER),
310 AS(SDLK_KP_PERIOD, WKC_NUM_DECIMAL),
311
312 /* Other non-letter keys */
313 AS(SDLK_SLASH, WKC_SLASH),
314 AS(SDLK_SEMICOLON, WKC_SEMICOLON),
315 AS(SDLK_EQUALS, WKC_EQUALS),
316 AS(SDLK_LEFTBRACKET, WKC_L_BRACKET),
317 AS(SDLK_BACKSLASH, WKC_BACKSLASH),
318 AS(SDLK_RIGHTBRACKET, WKC_R_BRACKET),
319
320 AS(SDLK_QUOTE, WKC_SINGLEQUOTE),
321 AS(SDLK_COMMA, WKC_COMMA),
322 AS(SDLK_MINUS, WKC_MINUS),
323 AS(SDLK_PERIOD, WKC_PERIOD)
324};
325
326static uint ConvertSdlKeyIntoMy(SDL_Keysym *sym, char32_t *character)
327{
328 uint key = 0;
329 bool unprintable = false;
330
331 for (const auto &map : _vk_mapping) {
332 if (IsInsideBS(sym->sym, map.vk_from, map.vk_count)) {
333 key = sym->sym - map.vk_from + map.map_to;
334 unprintable = map.unprintable;
335 break;
336 }
337 }
338
339 /* check scancode for BACKQUOTE key, because we want the key left of "1", not anything else (on non-US keyboards) */
340 if (sym->scancode == SDL_SCANCODE_GRAVE) key = WKC_BACKQUOTE;
341
342 /* META are the command keys on mac */
343 if (sym->mod & KMOD_GUI) key |= WKC_META;
344 if (sym->mod & KMOD_SHIFT) key |= WKC_SHIFT;
345 if (sym->mod & KMOD_CTRL) key |= WKC_CTRL;
346 if (sym->mod & KMOD_ALT) key |= WKC_ALT;
347
348 /* The mod keys have no character. Prevent '?' */
349 if (sym->mod & KMOD_GUI ||
350 sym->mod & KMOD_CTRL ||
351 sym->mod & KMOD_ALT ||
352 unprintable) {
353 *character = WKC_NONE;
354 } else {
355 *character = sym->sym;
356 }
357
358 return key;
359}
360
366static uint ConvertSdlKeycodeIntoMy(SDL_Keycode kc)
367{
368 uint key = 0;
369
370 for (const auto &map : _vk_mapping) {
371 if (IsInsideBS(kc, map.vk_from, map.vk_count)) {
372 key = kc - map.vk_from + map.map_to;
373 break;
374 }
375 }
376
377 /* check scancode for BACKQUOTE key, because we want the key left
378 * of "1", not anything else (on non-US keyboards) */
379 SDL_Scancode sc = SDL_GetScancodeFromKey(kc);
380 if (sc == SDL_SCANCODE_GRAVE) key = WKC_BACKQUOTE;
381
382 return key;
383}
384
386{
387 SDL_Event ev;
388
389 if (!SDL_PollEvent(&ev)) return false;
390
391 switch (ev.type) {
392 case SDL_MOUSEMOTION: {
393 int32_t x = ev.motion.x;
394 int32_t y = ev.motion.y;
395
396 if (_cursor.fix_at) {
397 /* Get all queued mouse events now in case we have to warp the cursor. In the
398 * end, we only care about the current mouse position and not bygone events. */
399 while (SDL_PeepEvents(&ev, 1, SDL_GETEVENT, SDL_MOUSEMOTION, SDL_MOUSEMOTION)) {
400 x = ev.motion.x;
401 y = ev.motion.y;
402 }
403 }
404
405 if (_cursor.UpdateCursorPosition(x, y)) {
406 SDL_WarpMouseInWindow(this->sdl_window, _cursor.pos.x, _cursor.pos.y);
407 }
409 break;
410 }
411
412 case SDL_MOUSEWHEEL: {
413 if (ev.wheel.y > 0) {
414 _cursor.wheel--;
415 } else if (ev.wheel.y < 0) {
416 _cursor.wheel++;
417 }
418
419 /* Handle 2D scrolling. */
420 const float SCROLL_BUILTIN_MULTIPLIER = 14.0f;
421#if SDL_VERSION_ATLEAST(2, 18, 0)
422 _cursor.v_wheel -= ev.wheel.preciseY * SCROLL_BUILTIN_MULTIPLIER * _settings_client.gui.scrollwheel_multiplier;
423 _cursor.h_wheel += ev.wheel.preciseX * SCROLL_BUILTIN_MULTIPLIER * _settings_client.gui.scrollwheel_multiplier;
424#else
425 _cursor.v_wheel -= static_cast<float>(ev.wheel.y * SCROLL_BUILTIN_MULTIPLIER * _settings_client.gui.scrollwheel_multiplier);
426 _cursor.h_wheel += static_cast<float>(ev.wheel.x * SCROLL_BUILTIN_MULTIPLIER * _settings_client.gui.scrollwheel_multiplier);
427#endif
428 _cursor.wheel_moved = true;
429 break;
430 }
431
432 case SDL_MOUSEBUTTONDOWN:
433 if (_rightclick_emulate && SDL_GetModState() & KMOD_CTRL) {
434 ev.button.button = SDL_BUTTON_RIGHT;
435 }
436
437 switch (ev.button.button) {
438 case SDL_BUTTON_LEFT:
439 _left_button_down = true;
440 break;
441
442 case SDL_BUTTON_RIGHT:
443 _right_button_down = true;
445 break;
446
447 default: break;
448 }
450 break;
451
452 case SDL_MOUSEBUTTONUP:
454 _right_button_down = false;
455 _left_button_down = false;
456 _left_button_clicked = false;
457 } else if (ev.button.button == SDL_BUTTON_LEFT) {
458 _left_button_down = false;
459 _left_button_clicked = false;
460 } else if (ev.button.button == SDL_BUTTON_RIGHT) {
461 _right_button_down = false;
462 }
464 break;
465
466 case SDL_QUIT:
467 HandleExitGameRequest();
468 break;
469
470 case SDL_KEYDOWN: // Toggle full-screen on ALT + ENTER/F
471 if ((ev.key.keysym.mod & (KMOD_ALT | KMOD_GUI)) &&
472 (ev.key.keysym.sym == SDLK_RETURN || ev.key.keysym.sym == SDLK_f)) {
473 if (ev.key.repeat == 0) ToggleFullScreen(!_fullscreen);
474 } else {
475 char32_t character;
476
477 uint keycode = ConvertSdlKeyIntoMy(&ev.key.keysym, &character);
478 /* Only handle non-text keys here. Text is handled in
479 * SDL_TEXTINPUT below. */
480 if (!this->edit_box_focused ||
481 keycode == WKC_DELETE ||
482 keycode == WKC_NUM_ENTER ||
483 keycode == WKC_LEFT ||
484 keycode == WKC_RIGHT ||
485 keycode == WKC_UP ||
486 keycode == WKC_DOWN ||
487 keycode == WKC_HOME ||
488 keycode == WKC_END ||
489 keycode & WKC_META ||
490 keycode & WKC_CTRL ||
491 keycode & WKC_ALT ||
492 (keycode >= WKC_F1 && keycode <= WKC_F12) ||
493 !IsValidChar(character, CS_ALPHANUMERAL)) {
494 HandleKeypress(keycode, character);
495 }
496 }
497 break;
498
499 case SDL_TEXTINPUT: {
500 if (!this->edit_box_focused) break;
501 SDL_Keycode kc = SDL_GetKeyFromName(ev.text.text);
502 uint keycode = ConvertSdlKeycodeIntoMy(kc);
503
504 if (keycode == WKC_BACKQUOTE && FocusedWindowIsConsole()) {
505 auto [len, c] = DecodeUtf8(ev.text.text);
506 if (len > 0) HandleKeypress(keycode, c);
507 } else {
508 HandleTextInput(ev.text.text);
509 }
510 break;
511 }
512 case SDL_WINDOWEVENT: {
513 if (ev.window.event == SDL_WINDOWEVENT_EXPOSED) {
514 /* Force a redraw of the entire screen. */
515 this->MakeDirty(0, 0, _screen.width, _screen.height);
516 } else if (ev.window.event == SDL_WINDOWEVENT_SIZE_CHANGED) {
517 int w = std::max(ev.window.data1, 64);
518 int h = std::max(ev.window.data2, 64);
519 CreateMainSurface(w, h, w != ev.window.data1 || h != ev.window.data2);
520 } else if (ev.window.event == SDL_WINDOWEVENT_ENTER) {
521 /* mouse entered the window, enable cursor */
522 _cursor.in_window = true;
523 /* Ensure pointer lock will not occur. */
524 SDL_SetRelativeMouseMode(SDL_FALSE);
525 } else if (ev.window.event == SDL_WINDOWEVENT_LEAVE) {
526 /* mouse left the window, undraw cursor */
527 UndrawMouseCursor();
528 _cursor.in_window = false;
529 }
530 break;
531 }
532 }
533
534 return true;
535}
536
537static std::optional<std::string_view> InitializeSDL()
538{
539 /* Check if the video-driver is already initialized. */
540 if (SDL_WasInit(SDL_INIT_VIDEO) != 0) return std::nullopt;
541
542#ifdef SDL_HINT_APP_NAME
543 SDL_SetHint(SDL_HINT_APP_NAME, "OpenTTD");
544#endif
545
546 if (SDL_InitSubSystem(SDL_INIT_VIDEO) < 0) return SDL_GetError();
547 return std::nullopt;
548}
549
550std::optional<std::string_view> VideoDriver_SDL_Base::Initialize()
551{
552 this->UpdateAutoResolution();
553
554 auto error = InitializeSDL();
555 if (error) return error;
556
557 FindResolutions();
558 Debug(driver, 2, "Resolution for display: {}x{}", _cur_resolution.width, _cur_resolution.height);
559
560 return std::nullopt;
561}
562
563std::optional<std::string_view> VideoDriver_SDL_Base::Start(const StringList &param)
564{
565 if (BlitterFactory::GetCurrentBlitter()->GetScreenDepth() == 0) return "Only real blitters supported";
566
567 auto error = this->Initialize();
568 if (error) return error;
569
570#ifdef SDL_HINT_MOUSE_AUTO_CAPTURE
571 if (GetDriverParamBool(param, "no_mouse_capture")) {
572 /* By default SDL captures the mouse, while a button is pressed.
573 * This is annoying during debugging, when OpenTTD is suspended while the button was pressed.
574 */
575 if (!SDL_SetHint(SDL_HINT_MOUSE_AUTO_CAPTURE, "0")) return SDL_GetError();
576 }
577#endif
578
579 this->startup_display = FindStartupDisplay(GetDriverParamInt(param, "display", -1));
580
581 if (!CreateMainSurface(_cur_resolution.width, _cur_resolution.height, false)) {
582 return SDL_GetError();
583 }
584
585 const char *dname = SDL_GetCurrentVideoDriver();
586 Debug(driver, 1, "SDL2: using driver '{}'", dname);
587
588 this->driver_info = this->GetName();
589 this->driver_info += " (";
590 this->driver_info += dname;
591 this->driver_info += ")";
592
594
595 SDL_StopTextInput();
596 this->edit_box_focused = false;
597
598#ifdef __EMSCRIPTEN__
599 this->is_game_threaded = false;
600#else
601 this->is_game_threaded = !GetDriverParamBool(param, "no_threads") && !GetDriverParamBool(param, "no_thread");
602#endif
603
604 return std::nullopt;
605}
606
608{
609 SDL_QuitSubSystem(SDL_INIT_VIDEO);
610 if (SDL_WasInit(SDL_INIT_EVERYTHING) == 0) {
611 SDL_Quit(); // If there's nothing left, quit SDL
612 }
613}
614
616{
617 uint32_t mod = SDL_GetModState();
618 const Uint8 *keys = SDL_GetKeyboardState(nullptr);
619
620 bool old_ctrl_pressed = _ctrl_pressed;
621
622 _ctrl_pressed = !!(mod & KMOD_CTRL);
623 _shift_pressed = !!(mod & KMOD_SHIFT);
624
625 /* Speedup when pressing tab, except when using ALT+TAB
626 * to switch to another application. */
627 this->fast_forward_key_pressed = keys[SDL_SCANCODE_TAB] && (mod & KMOD_ALT) == 0;
628
629 /* Determine which directional keys are down. */
630 _dirkeys =
631 (keys[SDL_SCANCODE_LEFT] ? 1 : 0) |
632 (keys[SDL_SCANCODE_UP] ? 2 : 0) |
633 (keys[SDL_SCANCODE_RIGHT] ? 4 : 0) |
634 (keys[SDL_SCANCODE_DOWN] ? 8 : 0);
635
636 if (old_ctrl_pressed != _ctrl_pressed) HandleCtrlChanged();
637}
638
639void VideoDriver_SDL_Base::LoopOnce()
640{
641 if (_exit_game) {
642#ifdef __EMSCRIPTEN__
643 /* Emscripten is event-driven, and as such the main loop is inside
644 * the browser. So if _exit_game goes true, the main loop ends (the
645 * cancel call), but we still have to call the cleanup that is
646 * normally done at the end of the main loop for non-Emscripten.
647 * After that, Emscripten just halts, and the HTML shows a nice
648 * "bye, see you next time" message. */
649 extern void PostMainLoop();
650 PostMainLoop();
651
652 emscripten_cancel_main_loop();
653 emscripten_exit_pointerlock();
654 /* In effect, the game ends here. As emscripten_set_main_loop() caused
655 * the stack to be unwound, the code after MainLoop() in
656 * openttd_main() is never executed. */
657 if (_game_mode == GM_BOOTSTRAP) {
658 EM_ASM(if (window["openttd_bootstrap_reload"]) openttd_bootstrap_reload());
659 } else {
660 EM_ASM(if (window["openttd_exit"]) openttd_exit());
661 }
662#endif
663 return;
664 }
665
666 this->Tick();
667
668/* Emscripten is running an event-based mainloop; there is already some
669 * downtime between each iteration, so no need to sleep. */
670#ifndef __EMSCRIPTEN__
671 this->SleepTillNextTick();
672#endif
673}
674
676{
677#ifdef __EMSCRIPTEN__
678 /* Run the main loop event-driven, based on RequestAnimationFrame. */
679 emscripten_set_main_loop_arg(&this->EmscriptenLoop, this, 0, 1);
680#else
681 this->StartGameThread();
682
683 while (!_exit_game) {
684 LoopOnce();
685 }
686
687 this->StopGameThread();
688#endif
689}
690
692{
693 return CreateMainSurface(w, h, true);
694}
695
697{
698 /* Remember current window size */
699 int w, h;
700 SDL_GetWindowSize(this->sdl_window, &w, &h);
701
702 if (fullscreen) {
703 /* Find fullscreen window size */
704 SDL_DisplayMode dm;
705 if (SDL_GetCurrentDisplayMode(SDL_GetWindowDisplayIndex(this->sdl_window), &dm) < 0) {
706 Debug(driver, 0, "SDL_GetCurrentDisplayMode() failed: {}", SDL_GetError());
707 } else {
708 SDL_SetWindowSize(this->sdl_window, dm.w, dm.h);
709 }
710 }
711
712 Debug(driver, 1, "SDL2: Setting {}", fullscreen ? "fullscreen" : "windowed");
713 int ret = SDL_SetWindowFullscreen(this->sdl_window, fullscreen ? SDL_WINDOW_FULLSCREEN : 0);
714 if (ret == 0) {
715 /* Switching resolution succeeded, set fullscreen value of window. */
716 _fullscreen = fullscreen;
717 if (!fullscreen) SDL_SetWindowSize(this->sdl_window, w, h);
718 } else {
719 Debug(driver, 0, "SDL_SetWindowFullscreen() failed: {}", SDL_GetError());
720 }
721
723 return ret == 0;
724}
725
727{
728 assert(BlitterFactory::GetCurrentBlitter()->GetScreenDepth() != 0);
729 int w, h;
730 SDL_GetWindowSize(this->sdl_window, &w, &h);
731 return CreateMainSurface(w, h, false);
732}
733
735{
736 SDL_DisplayMode mode;
737 if (SDL_GetCurrentDisplayMode(this->startup_display, &mode) != 0) return VideoDriver::GetScreenSize();
738
739 return { static_cast<uint>(mode.w), static_cast<uint>(mode.h) };
740}
741
743{
744 if (this->buffer_locked) return false;
745 this->buffer_locked = true;
746
747 _screen.dst_ptr = this->GetVideoPointer();
748 assert(_screen.dst_ptr != nullptr);
749
750 return true;
751}
752
754{
755 if (_screen.dst_ptr != nullptr) {
756 /* Hand video buffer back to the drawing backend. */
757 this->ReleaseVideoPointer();
758 _screen.dst_ptr = nullptr;
759 }
760
761 this->buffer_locked = false;
762}
763
765{
766 if (inhibited) {
767 SDL_DisableScreenSaver();
768 } else {
769 SDL_EnableScreenSaver();
770 }
771}
#define AS(ap_name, size_x, size_y, min_year, max_year, catchment, noise, maint_cost, ttdpatch_type, class_id, name, preview)
AirportSpec definition for airports with at least one depot.
static Blitter * GetCurrentBlitter()
Get the current active blitter (always set by calling SelectBlitter).
Definition factory.hpp:139
virtual void PostResize()
Post resize event.
Definition base.hpp:211
virtual std::string_view GetName() const =0
Get the name of this driver.
std::optional< std::string_view > Start(const StringList &param) override
Start this driver.
Definition sdl2_v.cpp:563
bool buffer_locked
Video buffer was locked by the main thread.
Definition sdl2_v.h:51
Dimension GetScreenSize() const override
Get the resolution of the main screen.
Definition sdl2_v.cpp:734
bool PollEvent() override
Process a single system event.
Definition sdl2_v.cpp:385
void EditBoxLostFocus() override
This is called to indicate that an edit box has lost focus, text input mode should be disabled.
Definition sdl2_v.cpp:226
virtual void ReleaseVideoPointer()=0
Hand video buffer back to the painting backend.
void ClaimMousePointer() override
Claim the exclusive rights for the mouse pointer.
Definition sdl2_v.cpp:204
virtual void * GetVideoPointer()=0
Get a pointer to the video buffer.
bool AfterBlitterChange() override
Callback invoked after the blitter was changed.
Definition sdl2_v.cpp:726
virtual bool AllocateBackingStore(int w, int h, bool force=false)=0
(Re-)create the backing store.
void InputLoop() override
Handle input logic, is CTRL pressed, should we fast-forward, etc.
Definition sdl2_v.cpp:615
Palette local_palette
Current palette to use for drawing.
Definition sdl2_v.h:50
void MainLoop() override
Perform the actual drawing.
Definition sdl2_v.cpp:675
std::string driver_info
Information string about selected driver.
Definition sdl2_v.h:53
void UnlockVideoBuffer() override
Unlock a previously locked video buffer.
Definition sdl2_v.cpp:753
void ClientSizeChanged(int w, int h, bool force)
Indicate to the driver the client-size might have changed.
Definition sdl2_v.cpp:129
void MakeDirty(int left, int top, int width, int height) override
Mark a particular area dirty.
Definition sdl2_v.cpp:31
virtual bool CreateMainWindow(uint w, uint h, uint flags=0)
Create the main window.
Definition sdl2_v.cpp:141
std::vector< int > GetListOfMonitorRefreshRates() override
Get a list of refresh rates of each available monitor.
Definition sdl2_v.cpp:234
void SetScreensaverInhibited(bool inhibited) override
Prevents the system from going to sleep.
Definition sdl2_v.cpp:764
bool edit_box_focused
This is true to indicate that keyboard input is in text input mode, and SDL_TEXTINPUT events are enab...
Definition sdl2_v.h:105
bool ChangeResolution(int w, int h) override
Change the resolution of the window.
Definition sdl2_v.cpp:691
void Stop() override
Stop this driver.
Definition sdl2_v.cpp:607
bool LockVideoBuffer() override
Make sure the video buffer is ready for drawing.
Definition sdl2_v.cpp:742
void EditBoxGainedFocus() override
This is called to indicate that an edit box has gained focus, text input mode should be enabled.
Definition sdl2_v.cpp:215
Rect dirty_rect
Rectangle encompassing the dirty area of the video buffer.
Definition sdl2_v.h:52
void CheckPaletteAnim() override
Process any pending palette animation.
Definition sdl2_v.cpp:37
struct SDL_Window * sdl_window
Main SDL window.
Definition sdl2_v.h:49
bool ToggleFullscreen(bool fullscreen) override
Change the full screen setting.
Definition sdl2_v.cpp:696
virtual Dimension GetScreenSize() const
Get the resolution of the main screen.
bool fast_forward_key_pressed
The fast-forward key is being pressed.
void Tick()
Give the video-driver a tick.
void SleepTillNextTick()
Sleep till the next tick is about to happen.
void StartGameThread()
Start the loop for game-tick.
static std::string GetCaption()
Get the caption to use for the game's title bar.
void StopGameThread()
Stop the loop for the game-tick.
void UpdateAutoResolution()
Apply resolution auto-detection and clamp to sensible defaults.
#define Debug(category, level, format_string,...)
Output a line of debugging information.
Definition debug.h:37
int GetDriverParamInt(const StringList &parm, std::string_view name, int def)
Get an integer parameter the list of parameters.
Definition driver.cpp:79
bool GetDriverParamBool(const StringList &parm, std::string_view name)
Get a boolean parameter the list of parameters.
Definition driver.cpp:67
std::vector< Dimension > _resolutions
List of resolutions.
Definition driver.cpp:28
Dimension _cur_resolution
The current resolution.
Definition driver.cpp:29
bool _rightclick_emulate
Whether right clicking is emulated.
Definition driver.cpp:30
Factory to 'query' all available blitters.
std::string FioFindFullPath(Subdirectory subdir, std::string_view filename)
Find a path to the filename in one of the search directories.
Definition fileio.cpp:144
Functions for standard in/out file operations.
@ BASESET_DIR
Subdirectory for all base data (base sets, intro game).
Definition fileio_type.h:96
Types for recording game performance data.
Rect BoundingRect(const Rect &r1, const Rect &r2)
Compute the bounding rectangle around two rectangles.
Geometry functions.
bool _shift_pressed
Is Shift pressed?
Definition gfx.cpp:40
bool _left_button_down
Is left mouse button pressed?
Definition gfx.cpp:42
bool _ctrl_pressed
Is Ctrl pressed?
Definition gfx.cpp:39
uint8_t _dirkeys
1 = left, 2 = up, 4 = right, 8 = down
Definition gfx.cpp:35
bool _left_button_clicked
Is left mouse button clicked?
Definition gfx.cpp:43
bool _right_button_clicked
Is right mouse button clicked?
Definition gfx.cpp:45
bool _right_button_down
Is right mouse button pressed?
Definition gfx.cpp:44
Functions related to the gfx engine.
void HandleCtrlChanged()
State of CONTROL key has changed.
Definition window.cpp:2722
void GameSizeChanged()
Size of the application screen changed.
Definition main_gui.cpp:596
void HandleMouseEvents()
Handle a mouse event from the video driver.
Definition window.cpp:2985
void HandleKeypress(uint keycode, char32_t key)
Handle keyboard input.
Definition window.cpp:2666
void HandleTextInput(std::string_view str, bool marked=false, std::optional< size_t > caret=std::nullopt, std::optional< size_t > insert_location=std::nullopt, std::optional< size_t > replacement_end=std::nullopt)
Handle text input.
Definition window.cpp:2758
@ WKC_BACKSLASH
\ Backslash
Definition gfx_type.h:101
@ WKC_MINUS
Definition gfx_type.h:106
@ WKC_COMMA
, Comma
Definition gfx_type.h:104
@ WKC_PERIOD
. Period
Definition gfx_type.h:105
@ WKC_EQUALS
= Equals
Definition gfx_type.h:99
@ WKC_SLASH
/ Forward slash
Definition gfx_type.h:97
@ WKC_SINGLEQUOTE
' Single quote
Definition gfx_type.h:103
@ WKC_R_BRACKET
] Right square bracket
Definition gfx_type.h:102
@ WKC_L_BRACKET
[ Left square bracket
Definition gfx_type.h:100
@ WKC_SEMICOLON
; Semicolon
Definition gfx_type.h:98
void MarkWholeScreenDirty()
This function mark the whole screen as dirty.
Definition gfx.cpp:1554
Integer math functions.
constexpr bool IsInsideBS(const T x, const size_t base, const size_t size)
Checks if a value is between a window started at some base point.
constexpr T Delta(const T a, const T b)
Returns the (absolute) difference between two (scalar) variables.
Some generic types.
bool CopyPalette(Palette &local_palette, bool force_copy)
Copy the current palette if the palette was updated.
Definition palette.cpp:230
Functions related to modal progress.
A number of safeguards to prevent using unsafe methods.
static uint ConvertSdlKeycodeIntoMy(SDL_Keycode kc)
Convert a SDL_Keycode into our own key codes.
Definition sdl2_v.cpp:366
Base of the SDL2 video driver.
ClientSettings _settings_client
The current settings for this game.
Definition settings.cpp:60
Definition of base types and functions in a cross-platform compatible way.
bool IsValidChar(char32_t key, CharSetFilter afilter)
Only allow certain keys.
Definition string.cpp:375
@ CS_ALPHANUMERAL
Both numeric and alphabetic and spaces and stuff.
Definition string_type.h:25
std::vector< std::string > StringList
Type for a list of strings.
Definition string_type.h:60
Dimensions (a width and height) of a rectangle in 2D.
Specification of a rectangle with absolute coordinates of all edges.
Base of all threads.
std::pair< size_t, char32_t > DecodeUtf8(std::string_view buf)
Decode a character from UTF-8.
Definition utf8.cpp:46
Handling of UTF-8 encoded data.
bool FocusedWindowIsConsole()
Check if a console is focused.
Definition window.cpp:475
void InvalidateWindowClassesData(WindowClass cls, int data, bool gui_scope)
Mark window data of all windows of a given class as invalid (in need of re-computing) Note that by de...
Definition window.cpp:3339
Window functions not directly related to making/drawing windows.
@ WC_GAME_OPTIONS
Game options window; Window numbers: