OpenTTD
VideoDriver_Null Class Reference

The null video driver. More...

#include <null_v.h>

Inheritance diagram for VideoDriver_Null:
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...
 
const char * GetName () const override
 Get the name of this driver. More...
 
bool HasGUI () const override
 Whether the driver has a graphical user interface with the end user. More...
 
- Public Member Functions inherited from VideoDriver
virtual bool AfterBlitterChange ()
 Callback invoked after the blitter was changed. More...
 
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 ClaimMousePointer ()
 
virtual void EditBoxLostFocus ()
 An edit box lost the input focus. More...
 
virtual void EditBoxGainedFocus ()
 An edit box gained the input focus.
 

Private Attributes

uint ticks
 Amount of ticks to run.
 

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 null video driver.

Definition at line 16 of file null_v.h.

Member Function Documentation

◆ ChangeResolution()

bool VideoDriver_Null::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.

Definition at line 53 of file null_v.cpp.

◆ GetName()

const char* VideoDriver_Null::GetName ( ) const
inlineoverridevirtual

Get the name of this driver.

Returns
The name of the driver.

Implements Driver.

Definition at line 32 of file null_v.h.

◆ HasGUI()

bool VideoDriver_Null::HasGUI ( ) const
inlineoverridevirtual

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 from VideoDriver.

Definition at line 33 of file null_v.h.

◆ MakeDirty()

void VideoDriver_Null::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.

Definition at line 41 of file null_v.cpp.

◆ Start()

const char * VideoDriver_Null::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.

Definition at line 20 of file null_v.cpp.

References GetDriverParamInt(), and ticks.

◆ ToggleFullscreen()

bool VideoDriver_Null::ToggleFullscreen ( bool  fullscreen)
overridevirtual

Change the full screen setting.

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

Implements VideoDriver.

Definition at line 55 of file null_v.cpp.


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