src/video/sdl2_v.h

   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 <http://www.gnu.org/licenses/>.
   6  */
   7
   8 /** @file sdl2_v.h Base of the SDL2 video driver. */
   9
  10 #ifndef VIDEO_SDL_H
  11 #define VIDEO_SDL_H
  12
  13 #include <condition_variable>
  14
  15 #include "video_driver.hpp"
  16
  17 /** The SDL video driver. */
  18 class VideoDriver_SDL_Base : public VideoDriver {
  19 public:
  20         VideoDriver_SDL_Base(bool uses_hardware_acceleration = false) : VideoDriver(uses_hardware_acceleration), sdl_window(nullptr), buffer_locked(false) {}
  21
  22         std::optional<std::string_view> Start(const StringList &param) override;
  23
  24         void Stop() override;
  25
  26         void MakeDirty(int left, int top, int width, int height) override;
  27
  28         void MainLoop() override;
  29
  30         bool ChangeResolution(int w, int h) override;
  31
  32         bool ToggleFullscreen(bool fullscreen) override;
  33
  34         bool AfterBlitterChange() override;
  35
  36         bool ClaimMousePointer() override;
  37
  38         void EditBoxGainedFocus() override;
  39
  40         void EditBoxLostFocus() override;
  41
  42         std::vector<int> GetListOfMonitorRefreshRates() override;
  43
  44         std::string_view GetInfoString() const override { return this->driver_info; }
  45
  46 protected:
  47         struct SDL_Window *sdl_window; ///< Main SDL window.
  48         Palette local_palette; ///< Current palette to use for drawing.
  49         bool buffer_locked; ///< Video buffer was locked by the main thread.
  50         Rect dirty_rect; ///< Rectangle encompassing the dirty area of the video buffer.
  51         std::string driver_info; ///< Information string about selected driver.
  52
  53         Dimension GetScreenSize() const override;
  54         void InputLoop() override;
  55         bool LockVideoBuffer() override;
  56         void UnlockVideoBuffer() override;
  57         void CheckPaletteAnim() override;
  58         bool PollEvent() override;
  59
  60         /** Indicate to the driver the client-side might have changed. */
  61         void ClientSizeChanged(int w, int h, bool force);
  62
  63         /** (Re-)create the backing store. */
  64         virtual bool AllocateBackingStore(int w, int h, bool force = false) = 0;
  65         /** Get a pointer to the video buffer. */
  66         virtual void *GetVideoPointer() = 0;
  67         /** Hand video buffer back to the painting backend. */
  68         virtual void ReleaseVideoPointer() = 0;
  69         /** Create the main window. */
  70         virtual bool CreateMainWindow(uint w, uint h, uint flags = 0);
  71
  72 private:
  73         void LoopOnce();
  74         void MainLoopCleanup();
  75         bool CreateMainSurface(uint w, uint h, bool resize);
  76         std::optional<std::string_view> Initialize();
  77
  78 #ifdef __EMSCRIPTEN__
  79         /* Convert a constant pointer back to a non-constant pointer to a member function. */
  80         static void EmscriptenLoop(void *self) { ((VideoDriver_SDL_Base *)self)->LoopOnce(); }
  81 #endif
  82
  83         /**
  84          * This is true to indicate that keyboard input is in text input mode, and SDL_TEXTINPUT events are enabled.
  85          */
  86         bool edit_box_focused;
  87
  88         int startup_display;
  89 };
  90
  91 #endif /* VIDEO_SDL_H */