OpenTTD
VideoDriver_Win32 Class Reference

The video driver for windows. More...

#include <win32_v.h>

Inheritance diagram for VideoDriver_Win32:
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...
 
void AcquireBlitterLock () override
 Acquire any lock(s) required to be held when changing blitters. More...
 
void ReleaseBlitterLock () override
 Release any lock(s) required to be held when changing blitters. More...
 
bool ClaimMousePointer () override
 
void EditBoxLostFocus () override
 An edit box lost the input focus. More...
 
const char * GetName () const override
 Get the name of this driver. More...
 
bool MakeWindow (bool full_screen)
 Instantiate a new window. More...
 
- Public Member Functions inherited from VideoDriver
virtual bool HasGUI () const
 Whether the driver has a graphical user interface with the end user. 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 video driver for windows.

Definition at line 16 of file win32_v.h.

Member Function Documentation

◆ AcquireBlitterLock()

void VideoDriver_Win32::AcquireBlitterLock ( )
overridevirtual

Acquire any lock(s) required to be held when changing blitters.

These lock(s) may not be acquired recursively.

Reimplemented from VideoDriver.

Definition at line 1326 of file win32_v.cpp.

References _draw_mutex.

◆ AfterBlitterChange()

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

Definition at line 1321 of file win32_v.cpp.

◆ ChangeResolution()

bool VideoDriver_Win32::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 1300 of file win32_v.cpp.

References _draw_mutex, and lock.

◆ EditBoxLostFocus()

void VideoDriver_Win32::EditBoxLostFocus ( )
overridevirtual

An edit box lost the input focus.

Abort character compositing if necessary.

Reimplemented from VideoDriver.

Definition at line 1336 of file win32_v.cpp.

References _draw_mutex, CancelIMEComposition(), and lock.

◆ GetName()

const char* VideoDriver_Win32::GetName ( ) const
inlineoverridevirtual

Get the name of this driver.

Returns
The name of the driver.

Implements Driver.

Definition at line 40 of file win32_v.h.

References MakeWindow().

◆ MakeDirty()

void VideoDriver_Win32::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 1150 of file win32_v.cpp.

◆ MakeWindow()

bool VideoDriver_Win32::MakeWindow ( bool  full_screen)

Instantiate a new window.

Parameters
full_screenWhether to make a full screen window or not.
Returns
True if the window could be created.

Definition at line 263 of file win32_v.cpp.

Referenced by GetName(), and ToggleFullscreen().

◆ ReleaseBlitterLock()

void VideoDriver_Win32::ReleaseBlitterLock ( )
overridevirtual

Release any lock(s) required to be held when changing blitters.

These lock(s) may not be acquired recursively.

Reimplemented from VideoDriver.

Definition at line 1331 of file win32_v.cpp.

References _draw_mutex.

◆ Start()

const char * VideoDriver_Win32::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 1114 of file win32_v.cpp.

◆ ToggleFullscreen()

bool VideoDriver_Win32::ToggleFullscreen ( bool  fullscreen)
overridevirtual

Change the full screen setting.

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

Implements VideoDriver.

Definition at line 1313 of file win32_v.cpp.

References _draw_mutex, lock, and MakeWindow().


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