OpenTTD Source: src/video/sdl2_v.cpp Source File

OpenTTD Source 15.3

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