OpenTTD Source 20261112-master-gbcbec5e63f
VideoDriver Class Referenceabstract

The base of all video drivers. More...

#include <video_driver.hpp>

Inheritance diagram for VideoDriver:
Driver VideoDriver_Allegro VideoDriver_Cocoa VideoDriver_Dedicated VideoDriver_Null VideoDriver_SDL_Base VideoDriver_Win32Base VideoDriver_CocoaOpenGL VideoDriver_CocoaQuartz VideoDriver_SDL_Default VideoDriver_SDL_OpenGL VideoDriver_Win32D3D11 VideoDriver_Win32GDI

Data Structures

struct  VideoBufferLocker
 Helper struct to ensure the video buffer is locked and ready for drawing. More...

Public Member Functions

 VideoDriver (bool uses_hardware_acceleration=false, bool supports_animation_buffer=false)
 Create the video driver.
virtual void MakeDirty (int left, int top, int width, int height)=0
 Mark a particular area dirty.
virtual void MainLoop ()=0
 Perform the actual drawing.
virtual bool ChangeResolution (int w, int h)=0
 Change the resolution of the window.
virtual bool ToggleFullscreen (bool fullscreen)=0
 Change the full screen setting.
virtual void ToggleVsync (bool vsync)
 Change the vsync setting.
virtual bool AfterBlitterChange ()
 Callback invoked after the blitter was changed.
virtual void ClaimMousePointer ()
 Claim the exclusive rights for the mouse pointer.
virtual bool UseSystemCursor ()
 Get whether the mouse cursor is drawn by the video driver.
virtual void PopulateSystemSprites ()
 Populate all sprites in cache.
virtual void ClearSystemSprites ()
 Clear all cached sprites.
virtual bool HasGUI () const
 Whether the driver has a graphical user interface with the end user.
virtual bool HasEfficient8Bpp () const
 Has this video driver an efficient code path for palette animated 8-bpp sprites?
constexpr bool SupportsAnimationBuffer () const
 Does this video driver support a separate animation buffer in addition to the colour buffer?
constexpr uint8_t * GetAnimBuffer () const
 Get a pointer to the animation buffer of the video back-end.
constexpr int GetAnimBufferPitch () const
 Get the animation buffer pitch in uint8_t elements per row.
virtual void EditBoxLostFocus ()
 An edit box lost the input focus.
virtual void EditBoxGainedFocus ()
 An edit box gained the input focus.
virtual std::vector< int > GetListOfMonitorRefreshRates ()
 Get a list of refresh rates of each available monitor.
virtual std::string_view GetInfoString () const
 Get some information about the selected driver/backend to be shown to the user.
void QueueOnMainThread (std::function< void()> &&func)
 Queue a function to be called on the main thread with game state lock held and video buffer locked.
void GameLoopPause ()
 Pause the game-loop for a bit, releasing the game-state lock.
virtual void SetScreensaverInhibited (bool inhibited)
 Prevents the system from going to sleep.
Public Member Functions inherited from Driver
virtual std::optional< std::string_view > Start (const StringList &parm)=0
 Start this driver.
virtual void Stop ()=0
 Stop this driver.
virtual ~Driver ()=default
 Ensure the destructor of the sub classes are called as well.
virtual std::string_view GetName () const =0
 Get the name of this driver.

Static Public Member Functions

static VideoDriver * GetInstance ()
 Get the currently active instance of the video driver.
static std::string GetCaption ()
 Get the caption to use for the game's title bar.

Protected Member Functions

virtual Dimension GetScreenSize () const
 Get the resolution of the main screen.
void UpdateAutoResolution ()
 Apply resolution auto-detection and clamp to sensible defaults.
virtual void InputLoop ()
 Handle input logic, is CTRL pressed, should we fast-forward, etc.
virtual bool LockVideoBuffer ()
 Make sure the video buffer is ready for drawing.
virtual void UnlockVideoBuffer ()
 Unlock a previously locked video buffer.
virtual void Paint ()
 Paint the window.
virtual void CheckPaletteAnim ()
 Process any pending palette animation.
virtual bool PollEvent ()
 Process a single system event.
void StartGameThread ()
 Start the loop for game-tick.
void StopGameThread ()
 Stop the loop for the game-tick.
void Tick ()
 Give the video-driver a tick.
void SleepTillNextTick ()
 Sleep till the next tick is about to happen.
std::chrono::steady_clock::duration GetGameInterval ()
std::chrono::steady_clock::duration GetDrawInterval ()
void DrainCommandQueue ()
 Execute all queued commands.

Static Protected Member Functions

static void GameThreadThunk (VideoDriver *drv)

Protected Attributes

const uint ALLOWED_DRIFT = 5
 How many times videodriver can miss deadlines without it being overly compensated.
std::chrono::steady_clock::time_point next_game_tick
std::chrono::steady_clock::time_point next_draw_tick
std::thread game_thread
std::mutex game_state_mutex
std::mutex game_thread_wait_mutex
uint8_t * anim_buffer = nullptr
 The animation buffer if supported/used.
int anim_pitch = 0
 Pitch of the animation buffer if supported/used.
const bool uses_hardware_acceleration
 Whether hardware acceleration is used or not.
const bool supports_animation_buffer
 Whether this driver supports hardware accelerated animation.
bool fast_forward_key_pressed = false
 The fast-forward key is being pressed.
bool fast_forward_via_key = false
 The fast-forward was enabled by key press.
bool is_game_threaded = true
 Whether the game is allowed to use threads; cleared in the driver implementation constructors if required.

Private Member Functions

void GameLoop ()
void GameThread ()

Private Attributes

const uint DEFAULT_WINDOW_WIDTH = 640u
 Default window width.
const uint DEFAULT_WINDOW_HEIGHT = 480u
 Default window height.
std::mutex cmd_queue_mutex
std::vector< std::function< void()> > cmd_queue

Additional Inherited Members

Public Types inherited from Driver
enum class  Type : uint8_t {
  Begin = 0 , Music = 0 , Sound , Video ,
  End
}
 The type of driver. More...

Detailed Description

The base of all video drivers.

Definition at line 31 of file video_driver.hpp.

Constructor & Destructor Documentation

◆ VideoDriver()

VideoDriver::VideoDriver ( bool uses_hardware_acceleration = false,
bool supports_animation_buffer = false )
inline

Create the video driver.

Parameters
uses_hardware_accelerationWhether hardware acceleration is used by this driver.
supports_animation_bufferWhether this driver supports a hardware accelerated animation buffer.

Definition at line 41 of file video_driver.hpp.

References supports_animation_buffer, and uses_hardware_acceleration.

Referenced by GetInstance(), VideoDriver_Cocoa::VideoDriver_Cocoa(), VideoDriver_SDL_Base::VideoDriver_SDL_Base(), and VideoDriver_Win32Base::VideoDriver_Win32Base().

Member Function Documentation

◆ AfterBlitterChange()

virtual bool VideoDriver::AfterBlitterChange ( )
inlinevirtual

Callback invoked after the blitter was changed.

Returns
True if no error.

Reimplemented in VideoDriver_Allegro, VideoDriver_Cocoa, VideoDriver_SDL_Base, VideoDriver_Win32D3D11, and VideoDriver_Win32GDI.

Definition at line 83 of file video_driver.hpp.

◆ ChangeResolution()

virtual bool VideoDriver::ChangeResolution ( int w,
int h )
pure virtual

Change the resolution of the window.

Parameters
wThe new width.
hThe new height.
Returns
True if the change succeeded.

Implemented in VideoDriver_Allegro, VideoDriver_Cocoa, VideoDriver_Dedicated, VideoDriver_Null, VideoDriver_SDL_Base, VideoDriver_Win32Base, and VideoDriver_Win32D3D11.

◆ CheckPaletteAnim()

virtual void VideoDriver::CheckPaletteAnim ( )
inlineprotectedvirtual

Process any pending palette animation.

Reimplemented in VideoDriver_Allegro, VideoDriver_CocoaQuartz, VideoDriver_SDL_Base, and VideoDriver_Win32Base.

Definition at line 294 of file video_driver.hpp.

Referenced by Tick().

◆ ClaimMousePointer()

virtual void VideoDriver::ClaimMousePointer ( )
inlinevirtual

Claim the exclusive rights for the mouse pointer.

Reimplemented in VideoDriver_Allegro, VideoDriver_SDL_Base, and VideoDriver_Win32Base.

Definition at line 91 of file video_driver.hpp.

Referenced by openttd_main().

◆ ClearSystemSprites()

virtual void VideoDriver::ClearSystemSprites ( )
inlinevirtual

Clear all cached sprites.

Reimplemented in VideoDriver_Cocoa, VideoDriver_CocoaOpenGL, and VideoDriver_SDL_OpenGL.

Definition at line 110 of file video_driver.hpp.

Referenced by AdjustGUIZoom(), GfxClearSpriteCache(), and GfxLoadSprites().

◆ DrainCommandQueue()

void VideoDriver::DrainCommandQueue ( )
inlineprotected

Execute all queued commands.

Definition at line 352 of file video_driver.hpp.

References lock.

Referenced by VideoDriver_Dedicated::MainLoop(), and Tick().

◆ EditBoxGainedFocus()

virtual void VideoDriver::EditBoxGainedFocus ( )
inlinevirtual

An edit box gained the input focus.

Reimplemented in VideoDriver_SDL_Base.

Definition at line 169 of file video_driver.hpp.

Referenced by IConsoleWindow::OnFocus(), Window::OnFocus(), and Window::SetFocusedWidget().

◆ EditBoxLostFocus()

virtual void VideoDriver::EditBoxLostFocus ( )
inlinevirtual

An edit box lost the input focus.

Abort character compositing if necessary.

Reimplemented in VideoDriver_Cocoa, VideoDriver_SDL_Base, and VideoDriver_Win32Base.

Definition at line 164 of file video_driver.hpp.

Referenced by IConsoleWindow::Close(), IConsoleWindow::OnFocusLost(), OskWindow::OnFocusLost(), Window::OnFocusLost(), Window::SetFocusedWidget(), and Window::UnfocusFocusedWidget().

◆ GameLoop()

void VideoDriver::GameLoop ( )
private

Definition at line 30 of file video_driver.cpp.

◆ GameLoopPause()

void VideoDriver::GameLoopPause ( )

Pause the game-loop for a bit, releasing the game-state lock.

This allows, if the draw-tick requested this, the drawing to happen.

Definition at line 68 of file video_driver.cpp.

References lock.

Referenced by GRFFileScanner::AddFile().

◆ GameThread()

void VideoDriver::GameThread ( )
private

Definition at line 45 of file video_driver.cpp.

◆ GameThreadThunk()

void VideoDriver::GameThreadThunk ( VideoDriver * drv)
staticprotected

Definition at line 83 of file video_driver.cpp.

◆ GetAnimBuffer()

uint8_t * VideoDriver::GetAnimBuffer ( ) const
inlineconstexpr

Get a pointer to the animation buffer of the video back-end.

Returns
Pointer to the buffer or nullptr if no animation buffer is supported.

Definition at line 147 of file video_driver.hpp.

References anim_buffer.

Referenced by Blitter_40bppAnim::ScrollBuffer().

◆ GetAnimBufferPitch()

int VideoDriver::GetAnimBufferPitch ( ) const
inlineconstexpr

◆ GetCaption()

std::string VideoDriver::GetCaption ( )
static

Get the caption to use for the game's title bar.

Returns
The caption.

Definition at line 191 of file video_driver.cpp.

Referenced by VideoDriver_SDL_Base::CreateMainWindow(), OTTD_CocoaWindow::initWithContentRect:styleMask:backing:defer:driver:, and VideoDriver_Win32Base::MakeWindow().

◆ GetDrawInterval()

std::chrono::steady_clock::duration VideoDriver::GetDrawInterval ( )
inlineprotected

Definition at line 342 of file video_driver.hpp.

◆ GetGameInterval()

std::chrono::steady_clock::duration VideoDriver::GetGameInterval ( )
inlineprotected

Definition at line 324 of file video_driver.hpp.

◆ GetInfoString()

virtual std::string_view VideoDriver::GetInfoString ( ) const
inlinevirtual

Get some information about the selected driver/backend to be shown to the user.

Returns
The information.

Reimplemented in VideoDriver_CocoaOpenGL, VideoDriver_SDL_Base, and VideoDriver_Win32D3D11.

Definition at line 184 of file video_driver.hpp.

References Driver::GetName().

Referenced by GameOptionsWindow::DrawWidget(), GameOptionsWindow::OnResize(), and SurveyConfiguration().

◆ GetInstance()

VideoDriver * VideoDriver::GetInstance ( )
inlinestatic

Get the currently active instance of the video driver.

Returns
The instance.

Definition at line 215 of file video_driver.hpp.

References DriverFactoryBase::GetActiveDriver(), Driver::Video, and VideoDriver().

Referenced by AddCustomRefreshRates(), GRFFileScanner::AddFile(), AdjustGUIZoom(), CrashLog::AfterCrashLogCleanup(), IConsoleWindow::Close(), CmdPause(), CocoaDialog(), Blitter_40bppAnim::CopyFromBuffer(), Blitter_40bppAnim::CopyImageToBuffer(), Blitter_40bppAnim::CopyToBuffer(), Blitter_40bppAnim::Draw(), Blitter_40bppAnim::Draw(), Blitter_40bppAnim::DrawColourMappingRect(), Blitter_40bppAnim::DrawLine(), Blitter_40bppAnim::DrawRect(), GameOptionsWindow::DrawWidget(), FatalErrorI(), GfxClearSpriteCache(), GfxLoadSprites(), HandleBootstrap(), HandleCrash(), OTTD_CocoaView::internalHandleKeycode:unicode:pressed:modifiers:, FBlitter_40bppAnim::IsUsable(), OTTDMain::launchGameEngine:, MakeScreenshot(), NetworkDrawChatMessage(), NetworkUndrawChatMessage(), GameOptionsWindow::OnClick(), IConsoleWindow::OnFocus(), Window::OnFocus(), IConsoleWindow::OnFocusLost(), OskWindow::OnFocusLost(), Window::OnFocusLost(), GameOptionsWindow::OnResize(), openttd_main(), Blitter_32bppAnim::PaletteAnimate(), RedrawScreenRect(), ScreenToAnimationBuffer(), Blitter_40bppAnim::ScrollBuffer(), Window::SetFocusedWidget(), Blitter_40bppAnim::SetPixel(), MusicDriver_ExtMidi::Start(), SurveyConfiguration(), SwitchNewGRFBlitter(), Window::UnfocusFocusedWidget(), UserErrorI(), VideoDriver::VideoBufferLocker::VideoBufferLocker(), and VideoDriver::VideoBufferLocker::~VideoBufferLocker().

◆ GetListOfMonitorRefreshRates()

virtual std::vector< int > VideoDriver::GetListOfMonitorRefreshRates ( )
inlinevirtual

Get a list of refresh rates of each available monitor.

Returns
A vector of the refresh rates of all available monitors.

Reimplemented in VideoDriver_Allegro, VideoDriver_Cocoa, VideoDriver_SDL_Base, and VideoDriver_Win32Base.

Definition at line 175 of file video_driver.hpp.

Referenced by AddCustomRefreshRates().

◆ GetScreenSize()

virtual Dimension VideoDriver::GetScreenSize ( ) const
inlineprotectedvirtual

Get the resolution of the main screen.

Returns
The dimension of the screen in pixels.

Reimplemented in VideoDriver_Cocoa, VideoDriver_SDL_Base, and VideoDriver_Win32Base.

Definition at line 250 of file video_driver.hpp.

References DEFAULT_WINDOW_HEIGHT, and DEFAULT_WINDOW_WIDTH.

Referenced by VideoDriver_SDL_Base::GetScreenSize(), and UpdateAutoResolution().

◆ HasEfficient8Bpp()

virtual bool VideoDriver::HasEfficient8Bpp ( ) const
inlinevirtual

Has this video driver an efficient code path for palette animated 8-bpp sprites?

Returns
True if the driver has an efficient code path for 8-bpp.

Reimplemented in VideoDriver_CocoaOpenGL, VideoDriver_SDL_OpenGL, and VideoDriver_Win32D3D11.

Definition at line 129 of file video_driver.hpp.

◆ HasGUI()

virtual bool VideoDriver::HasGUI ( ) const
inlinevirtual

Whether the driver has a graphical user interface with the end user.

Or in other words, whether we should spawn a thread for world generation and NewGRF scanning so the graphical updates can keep coming. Otherwise progress has to be shown on the console, which uses by definition another thread/process for display purposes.

Returns
True for all drivers except null and dedicated.

Reimplemented in VideoDriver_Dedicated, and VideoDriver_Null.

Definition at line 120 of file video_driver.hpp.

Referenced by Tick().

◆ InputLoop()

virtual void VideoDriver::InputLoop ( )
inlineprotectedvirtual

Handle input logic, is CTRL pressed, should we fast-forward, etc.

Reimplemented in VideoDriver_Allegro, VideoDriver_Cocoa, VideoDriver_SDL_Base, and VideoDriver_Win32Base.

Definition at line 270 of file video_driver.hpp.

Referenced by VideoDriver_Null::MainLoop(), and Tick().

◆ LockVideoBuffer()

virtual bool VideoDriver::LockVideoBuffer ( )
inlineprotectedvirtual

Make sure the video buffer is ready for drawing.

Returns
True if the video buffer has to be unlocked.

Reimplemented in VideoDriver_Cocoa, VideoDriver_SDL_Base, and VideoDriver_Win32Base.

Definition at line 276 of file video_driver.hpp.

Referenced by Tick(), and VideoDriver::VideoBufferLocker::VideoBufferLocker().

◆ MainLoop()

virtual void VideoDriver::MainLoop ( )
pure virtual

◆ MakeDirty()

virtual void VideoDriver::MakeDirty ( int left,
int top,
int width,
int height )
pure virtual

Mark a particular area dirty.

Parameters
leftThe left most line of the dirty area.
topThe top most line of the dirty area.
widthThe width of the dirty area.
heightThe height of the dirty area.

Implemented in VideoDriver_Allegro, VideoDriver_Cocoa, VideoDriver_Dedicated, VideoDriver_Null, VideoDriver_SDL_Base, and VideoDriver_Win32Base.

Referenced by NetworkDrawChatMessage(), NetworkUndrawChatMessage(), Blitter_32bppAnim::PaletteAnimate(), and RedrawScreenRect().

◆ Paint()

virtual void VideoDriver::Paint ( )
inlineprotectedvirtual

◆ PollEvent()

virtual bool VideoDriver::PollEvent ( )
inlineprotectedvirtual

Process a single system event.

Returns
False if there are no more events to process.

Reimplemented in VideoDriver_Allegro, VideoDriver_Cocoa, VideoDriver_SDL_Base, and VideoDriver_Win32Base.

Definition at line 300 of file video_driver.hpp.

Referenced by Tick().

◆ PopulateSystemSprites()

virtual void VideoDriver::PopulateSystemSprites ( )
inlinevirtual

Populate all sprites in cache.

Reimplemented in VideoDriver_Cocoa, VideoDriver_CocoaOpenGL, and VideoDriver_SDL_OpenGL.

Definition at line 105 of file video_driver.hpp.

Referenced by Tick().

◆ QueueOnMainThread()

void VideoDriver::QueueOnMainThread ( std::function< void()> && func)
inline

Queue a function to be called on the main thread with game state lock held and video buffer locked.

Queued functions will be executed on the next draw tick.

Parameters
funcFunction to call.

Definition at line 195 of file video_driver.hpp.

References lock.

Referenced by MakeScreenshot(), and SwitchNewGRFBlitter().

◆ SetScreensaverInhibited()

virtual void VideoDriver::SetScreensaverInhibited ( bool inhibited)
inlinevirtual

Prevents the system from going to sleep.

Parameters
inhibitedIf true, sleep will be disabled. If false, sleep will be enabled.

Reimplemented in VideoDriver_SDL_Base.

Definition at line 209 of file video_driver.hpp.

Referenced by CmdPause().

◆ SleepTillNextTick()

void VideoDriver::SleepTillNextTick ( )
protected

Sleep till the next tick is about to happen.

Definition at line 173 of file video_driver.cpp.

References is_game_threaded.

Referenced by VideoDriver_SDL_Base::LoopOnce(), VideoDriver_Dedicated::MainLoop(), VideoDriver_Win32Base::MainLoop(), and VideoDriver_Cocoa::MainLoopReal().

◆ StartGameThread()

void VideoDriver::StartGameThread ( )
protected

Start the loop for game-tick.

Definition at line 88 of file video_driver.cpp.

References Debug, Driver, Error, is_game_threaded, and StartNewThread().

Referenced by VideoDriver_SDL_Base::MainLoop(), VideoDriver_Win32Base::MainLoop(), and VideoDriver_Cocoa::MainLoopReal().

◆ StopGameThread()

void VideoDriver::StopGameThread ( )
protected

Stop the loop for the game-tick.

This can still tick at most one time before truly shutting down.

Definition at line 97 of file video_driver.cpp.

References is_game_threaded.

Referenced by VideoDriver_SDL_Base::MainLoop(), VideoDriver_Win32Base::MainLoop(), and VideoDriver_Cocoa::MainLoopReal().

◆ SupportsAnimationBuffer()

bool VideoDriver::SupportsAnimationBuffer ( ) const
inlineconstexpr

Does this video driver support a separate animation buffer in addition to the colour buffer?

Returns
True if a separate animation buffer is supported.

Definition at line 138 of file video_driver.hpp.

References supports_animation_buffer.

Referenced by FBlitter_40bppAnim::IsUsable().

◆ Tick()

◆ ToggleFullscreen()

virtual bool VideoDriver::ToggleFullscreen ( bool fullscreen)
pure virtual

Change the full screen setting.

Parameters
fullscreenThe new setting.
Returns
True if the change succeeded.

Implemented in VideoDriver_Allegro, VideoDriver_Cocoa, VideoDriver_Dedicated, VideoDriver_Null, VideoDriver_SDL_Base, VideoDriver_Win32Base, and VideoDriver_Win32D3D11.

Referenced by OTTD_CocoaView::internalHandleKeycode:unicode:pressed:modifiers:.

◆ ToggleVsync()

virtual void VideoDriver::ToggleVsync ( bool vsync)
inlinevirtual

Change the vsync setting.

Parameters
vsyncThe new setting.

Reimplemented in VideoDriver_SDL_OpenGL.

Definition at line 77 of file video_driver.hpp.

Referenced by GameOptionsWindow::OnClick().

◆ UnlockVideoBuffer()

virtual void VideoDriver::UnlockVideoBuffer ( )
inlineprotectedvirtual

Unlock a previously locked video buffer.

Reimplemented in VideoDriver_Cocoa, VideoDriver_SDL_Base, and VideoDriver_Win32Base.

Definition at line 284 of file video_driver.hpp.

Referenced by Tick(), and VideoDriver::VideoBufferLocker::~VideoBufferLocker().

◆ UpdateAutoResolution()

void VideoDriver::UpdateAutoResolution ( )
inlineprotected

◆ UseSystemCursor()

virtual bool VideoDriver::UseSystemCursor ( )
inlinevirtual

Get whether the mouse cursor is drawn by the video driver.

Returns
True if cursor drawing is done by the video driver.

Reimplemented in VideoDriver_CocoaOpenGL, VideoDriver_SDL_OpenGL, and VideoDriver_Win32D3D11.

Definition at line 97 of file video_driver.hpp.

Field Documentation

◆ ALLOWED_DRIFT

const uint VideoDriver::ALLOWED_DRIFT = 5
protected

How many times videodriver can miss deadlines without it being overly compensated.

Definition at line 244 of file video_driver.hpp.

◆ anim_buffer

◆ anim_pitch

◆ cmd_queue

std::vector<std::function<void()> > VideoDriver::cmd_queue
private

Definition at line 389 of file video_driver.hpp.

◆ cmd_queue_mutex

std::mutex VideoDriver::cmd_queue_mutex
private

Definition at line 388 of file video_driver.hpp.

◆ DEFAULT_WINDOW_HEIGHT

const uint VideoDriver::DEFAULT_WINDOW_HEIGHT = 480u
private

Default window height.

Definition at line 33 of file video_driver.hpp.

Referenced by GetScreenSize(), and UpdateAutoResolution().

◆ DEFAULT_WINDOW_WIDTH

const uint VideoDriver::DEFAULT_WINDOW_WIDTH = 640u
private

Default window width.

Definition at line 32 of file video_driver.hpp.

Referenced by GetScreenSize(), and UpdateAutoResolution().

◆ fast_forward_key_pressed

bool VideoDriver::fast_forward_key_pressed = false
protected

The fast-forward key is being pressed.

Definition at line 381 of file video_driver.hpp.

Referenced by VideoDriver_Cocoa::InputLoop(), VideoDriver_SDL_Base::InputLoop(), VideoDriver_Win32Base::InputLoop(), and Tick().

◆ fast_forward_via_key

bool VideoDriver::fast_forward_via_key = false
protected

The fast-forward was enabled by key press.

Definition at line 382 of file video_driver.hpp.

Referenced by Tick().

◆ game_state_mutex

std::mutex VideoDriver::game_state_mutex
protected

Definition at line 373 of file video_driver.hpp.

◆ game_thread

std::thread VideoDriver::game_thread
protected

Definition at line 372 of file video_driver.hpp.

◆ game_thread_wait_mutex

std::mutex VideoDriver::game_thread_wait_mutex
protected

Definition at line 374 of file video_driver.hpp.

◆ is_game_threaded

bool VideoDriver::is_game_threaded = true
protected

Whether the game is allowed to use threads; cleared in the driver implementation constructors if required.

Definition at line 383 of file video_driver.hpp.

Referenced by VideoDriver_Dedicated::MainLoop(), SleepTillNextTick(), VideoDriver_CocoaOpenGL::Start(), VideoDriver_CocoaQuartz::Start(), VideoDriver_SDL_Base::Start(), VideoDriver_Win32D3D11::Start(), VideoDriver_Win32GDI::Start(), StartGameThread(), StopGameThread(), and Tick().

◆ next_draw_tick

std::chrono::steady_clock::time_point VideoDriver::next_draw_tick
protected

Definition at line 370 of file video_driver.hpp.

◆ next_game_tick

std::chrono::steady_clock::time_point VideoDriver::next_game_tick
protected

Definition at line 369 of file video_driver.hpp.

◆ supports_animation_buffer

const bool VideoDriver::supports_animation_buffer
protected

◆ uses_hardware_acceleration

const bool VideoDriver::uses_hardware_acceleration
protected

The documentation for this class was generated from the following files: