OpenTTD
VideoDriver_Allegro Class Reference

The allegro video driver. More...

#include <allegro_v.h>

Inheritance diagram for VideoDriver_Allegro:
VideoDriver Driver

Public Member Functions

const char * Start (const char *const *param) override
 Start this driver. More...
 
void Stop () override
 Stop this driver.
 
void MakeDirty (int left, int top, int width, int height) override
 Mark a particular area dirty. More...
 
void MainLoop () override
 Perform the actual drawing.
 
bool ChangeResolution (int w, int h) override
 Change the resolution of the window. More...
 
bool ToggleFullscreen (bool fullscreen) override
 Change the full screen setting. More...
 
bool AfterBlitterChange () override
 Callback invoked after the blitter was changed. More...
 
bool ClaimMousePointer () override
 
const char * GetName () const override
 Get the name of this driver. More...
 
- Public Member Functions inherited from VideoDriver
virtual void AcquireBlitterLock ()
 Acquire any lock(s) required to be held when changing blitters. More...
 
virtual void ReleaseBlitterLock ()
 Release any lock(s) required to be held when changing blitters. More...
 
virtual bool HasGUI () const
 Whether the driver has a graphical user interface with the end user. More...
 
virtual void EditBoxLostFocus ()
 An edit box lost the input focus. More...
 
virtual void EditBoxGainedFocus ()
 An edit box gained the input focus.
 

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.
 

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.

This may only be called between AcquireBlitterLock and ReleaseBlitterLock.

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.

◆ GetName()

const char* VideoDriver_Allegro::GetName ( ) const
inlineoverridevirtual

Get the name of this driver.

Returns
The name of the driver.

Implements Driver.

Definition at line 34 of file allegro_v.h.

◆ 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.

◆ Start()

const char* VideoDriver_Allegro::Start ( const char *const *  parm)
overridevirtual

Start this driver.

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

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: