OpenTTD
Public Member Functions | Private Attributes
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)
 Start this driver.
void Stop ()
 Stop this driver.
void MakeDirty (int left, int top, int width, int height)
 Mark a particular area dirty.
void MainLoop ()
 Perform the actual drawing.
bool ChangeResolution (int w, int h)
 Change the resolution of the window.
bool ToggleFullscreen (bool fullscreen)
 Change the full screen setting.
const char * GetName () const
 Get the name of this driver.
bool HasGUI () const
 Whether the driver has a graphical user interface with the end user.
- Public Member Functions inherited from VideoDriver
virtual bool AfterBlitterChange ()
 Callback invoked after the blitter was changed.
virtual bool ClaimMousePointer ()
virtual void EditBoxLostFocus ()
 An edit box lost 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 18 of file null_v.h.

Member Function Documentation

bool VideoDriver_Null::ChangeResolution ( int  w,
int  h 
)
virtual

Change the resolution of the window.

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

Implements VideoDriver.

Definition at line 55 of file null_v.cpp.

const char* VideoDriver_Null::GetName ( ) const
inlinevirtual

Get the name of this driver.

Returns
The name of the driver.

Implements Driver.

Definition at line 34 of file null_v.h.

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

Definition at line 35 of file null_v.h.

void VideoDriver_Null::MakeDirty ( int  left,
int  top,
int  width,
int  height 
)
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.

Implements VideoDriver.

Definition at line 43 of file null_v.cpp.

const char * VideoDriver_Null::Start ( const char *const *  parm)
virtual

Start this driver.

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

Implements Driver.

Definition at line 22 of file null_v.cpp.

References _cur_resolution, DEBUG, GetDriverParamInt(), BlitterFactory::SelectBlitter(), and ticks.

bool VideoDriver_Null::ToggleFullscreen ( bool  fullscreen)
virtual

Change the full screen setting.

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

Implements VideoDriver.

Definition at line 57 of file null_v.cpp.


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