OpenTTD Source 20241224-master-gee860a5c8e
VideoDriver_Allegro Class Reference

The allegro video driver. More...

#include <allegro_v.h>

Inheritance diagram for VideoDriver_Allegro:
VideoDriver Driver

Public Member Functions

std::optional< std::string_view > Start (const StringList &param) override
 Start this driver.
 
void Stop () override
 Stop this driver.
 
void MakeDirty (int left, int top, int width, int height) override
 Mark a particular area dirty.
 
void MainLoop () override
 Perform the actual drawing.
 
bool ChangeResolution (int w, int h) override
 Change the resolution of the window.
 
bool ToggleFullscreen (bool fullscreen) override
 Change the full screen setting.
 
bool AfterBlitterChange () override
 Callback invoked after the blitter was changed.
 
bool ClaimMousePointer () override
 
std::vector< int > GetListOfMonitorRefreshRates () override
 Get a list of refresh rates of each available monitor.
 
std::string_view GetName () const override
 Get the name of this driver.
 
- Public Member Functions inherited from VideoDriver
 VideoDriver (bool uses_hardware_acceleration=false)
 
virtual void ToggleVsync (bool vsync)
 Change the vsync setting.
 
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?
 
virtual bool HasAnimBuffer ()
 Does this video driver support a separate animation buffer in addition to the colour buffer?
 
virtual uint8_t * GetAnimBuffer ()
 Get a pointer to the animation buffer of the video back-end.
 
virtual void EditBoxLostFocus ()
 An edit box lost the input focus.
 
virtual void EditBoxGainedFocus ()
 An edit box gained the input focus.
 
virtual int GetSuggestedUIScale ()
 Get a suggested default GUI scale taking screen DPI into account.
 
virtual std::string_view GetInfoString () const
 
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.
 

Protected Member Functions

void InputLoop () override
 Handle input logic, is CTRL pressed, should we fast-forward, etc.
 
void Paint () override
 Paint the window.
 
void CheckPaletteAnim () override
 Process any pending palette animation.
 
bool PollEvent () override
 Process a single system event.
 
- Protected Member Functions inherited from VideoDriver
virtual Dimension GetScreenSize () const
 Get the resolution of the main screen.
 
virtual float GetDPIScale ()
 Get DPI scaling factor of the screen OTTD is displayed on.
 
void UpdateAutoResolution ()
 Apply resolution auto-detection and clamp to sensible defaults.
 
virtual bool LockVideoBuffer ()
 Make sure the video buffer is ready for drawing.
 
virtual void UnlockVideoBuffer ()
 Unlock a previously locked video buffer.
 
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.
 

Additional Inherited Members

- Public Types inherited from Driver
enum  Type {
  DT_BEGIN = 0 , DT_MUSIC = 0 , DT_SOUND , DT_VIDEO ,
  DT_END
}
 The type of driver. More...
 
- Static Public Member Functions inherited from VideoDriver
static VideoDriverGetInstance ()
 Get the currently active instance of the video driver.
 
static std::string GetCaption ()
 Get the caption to use for the game's title bar.
 
- Static Protected Member Functions inherited from VideoDriver
static void GameThreadThunk (VideoDriver *drv)
 
- Protected Attributes inherited from VideoDriver
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
 
bool fast_forward_key_pressed
 The fast-forward key is being pressed.
 
bool fast_forward_via_key
 The fast-forward was enabled by key press.
 
bool is_game_threaded
 
std::thread game_thread
 
std::mutex game_state_mutex
 
std::mutex game_thread_wait_mutex
 
bool uses_hardware_acceleration
 

Detailed Description

The allegro video driver.

Definition at line 16 of file allegro_v.h.

Member Function Documentation

◆ AfterBlitterChange()

bool VideoDriver_Allegro::AfterBlitterChange ( )
overridevirtual

Callback invoked after the blitter was changed.

Returns
True if no error.

Reimplemented from VideoDriver.

◆ ChangeResolution()

bool VideoDriver_Allegro::ChangeResolution ( int  w,
int  h 
)
overridevirtual

Change the resolution of the window.

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

Implements VideoDriver.

◆ CheckPaletteAnim()

void VideoDriver_Allegro::CheckPaletteAnim ( )
overrideprotectedvirtual

Process any pending palette animation.

Reimplemented from VideoDriver.

◆ ClaimMousePointer()

bool VideoDriver_Allegro::ClaimMousePointer ( )
overridevirtual

Reimplemented from VideoDriver.

◆ GetListOfMonitorRefreshRates()

std::vector< int > VideoDriver_Allegro::GetListOfMonitorRefreshRates ( )
overridevirtual

Get a list of refresh rates of each available monitor.

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

Reimplemented from VideoDriver.

◆ GetName()

std::string_view VideoDriver_Allegro::GetName ( ) const
inlineoverridevirtual

Get the name of this driver.

Returns
The name of the driver.

Implements Driver.

Definition at line 36 of file allegro_v.h.

◆ InputLoop()

void VideoDriver_Allegro::InputLoop ( )
overrideprotectedvirtual

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

Reimplemented from VideoDriver.

◆ MainLoop()

void VideoDriver_Allegro::MainLoop ( )
overridevirtual

Perform the actual drawing.

Implements VideoDriver.

◆ MakeDirty()

void VideoDriver_Allegro::MakeDirty ( int  left,
int  top,
int  width,
int  height 
)
overridevirtual

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.

Implements VideoDriver.

◆ Paint()

void VideoDriver_Allegro::Paint ( )
overrideprotectedvirtual

Paint the window.

Reimplemented from VideoDriver.

◆ PollEvent()

bool VideoDriver_Allegro::PollEvent ( )
overrideprotectedvirtual

Process a single system event.

Returns
False if there are no more events to process.

Reimplemented from VideoDriver.

◆ Start()

std::optional< std::string_view > VideoDriver_Allegro::Start ( const StringList parm)
overridevirtual

Start this driver.

Parameters
parmParameters passed to the driver.
Returns
std::nullopt if everything went okay, otherwise an error message.

Implements Driver.

◆ Stop()

void VideoDriver_Allegro::Stop ( )
overridevirtual

Stop this driver.

Implements Driver.

◆ ToggleFullscreen()

bool VideoDriver_Allegro::ToggleFullscreen ( bool  fullscreen)
overridevirtual

Change the full screen setting.

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

Implements VideoDriver.


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