OpenTTD Source: VideoDriver_Win32Base Class Reference

OpenTTD Source 1.11.0-RC1

Public Member Functions | Protected Member Functions | Protected Attributes | Friends
VideoDriver_Win32Base Class Referenceabstract

Base class for Windows video drivers. More...

`#include <win32_v.h>`

Inheritance diagram for VideoDriver_Win32Base:

## Public Member Functions
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 | ClaimMousePointer () override
void | EditBoxLostFocus () override
| An edit box lost the input focus. More...
std::vector< int > | GetListOfMonitorRefreshRates () override
| Get a list of refresh rates of each available monitor. More...
Public Member Functions inherited from VideoDriver
virtual bool | AfterBlitterChange ()
| Callback invoked after the blitter was changed. More...
virtual bool | UseSystemCursor ()
| Get whether the mouse cursor is drawn by the video driver. More...
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. More...
virtual bool | HasEfficient8Bpp () const
| Has this video driver an efficient code path for palette animated 8-bpp sprites? More...
virtual bool | HasAnimBuffer ()
| Does this video driver support a separate animation buffer in addition to the colour buffer? More...
virtual uint8 * | GetAnimBuffer ()
| Get a pointer to the animation buffer of the video back-end. More...
virtual void | EditBoxGainedFocus ()
| An edit box gained the input focus.
virtual ZoomLevel | GetSuggestedUIZoom ()
| Get a suggested default GUI zoom taking screen DPI into account.
void | ChangeBlitter (const char *new_blitter)
| Queue a request to change the blitter. More...
void | GameLoopPause ()
| Pause the game-loop for a bit, releasing the game-state lock. More...
Public Member Functions inherited from Driver
virtual const char * | Start (const StringList &parm)=0
| Start this driver. More...
virtual const char * | GetName () const =0
| Get the name of this driver. More...

## Protected Member Functions
Dimension | GetScreenSize () const override
| Get the resolution of the main screen.
float | GetDPIScale () override
| Get DPI scaling factor of the screen OTTD is displayed on. More...
void | InputLoop () override
| Handle input logic, is CTRL pressed, should we fast-forward, etc.
bool | LockVideoBuffer () override
| Make sure the video buffer is ready for drawing. More...
void | UnlockVideoBuffer () override
| Unlock a previously locked video buffer.
void | CheckPaletteAnim () override
| Process any pending palette animation.
bool | PollEvent () override
| Process a single system event. More...
void | Initialize ()
bool | MakeWindow (bool full_screen, bool resize=true)
| Instantiate a new window. More...
void | ClientSizeChanged (int w, int h, bool force=false)
virtual uint8 | GetFullscreenBpp ()
| Get screen depth to use for fullscreen mode. More...
virtual bool | AllocateBackingStore (int w, int h, bool force=false)=0
| (Re-)create the backing store.
virtual void * | GetVideoPointer ()=0
| Get a pointer to the video buffer.
virtual void | ReleaseVideoPointer ()
| Hand video buffer back to the painting backend.
virtual void | PaletteChanged (HWND hWnd)=0
| Palette of the window has changed.
Protected Member Functions inherited from VideoDriver
void | UpdateAutoResolution ()
| Apply resolution auto-detection and clamp to sensible defaults.
virtual void | Paint ()
| Paint the window.
void | StartGameThread ()
| Start the loop for game-tick.
void | StopGameThread ()
| Stop the loop for the game-tick. More...
void | Tick ()
| Give the video-driver a tick. More...
void | SleepTillNextTick ()
| Sleep till the next tick is about to happen.
std::chrono::steady_clock::duration | GetGameInterval ()
std::chrono::steady_clock::duration | GetDrawInterval ()

## Protected Attributes
HWND | main_wnd
| Handle to system window.
bool | fullscreen
| Whether to use (true) fullscreen mode.
bool | has_focus = false
| Does our window have system focus?
Rect | dirty_rect
| Region of the screen that needs redrawing.
int | width = 0
| Width in pixels of our display surface.
int | height = 0
| Height in pixels of our display surface.
int | width_org = 0
| Original monitor resolution width, before we changed it.
int | height_org = 0
| Original monitor resolution height, before we changed it.
bool | buffer_locked
| Video buffer was locked by the main thread.
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

## Friends
LRESULT CALLBACK | WndProcGdi (HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam)

## 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 VideoDriver * | GetInstance ()
| Get the currently active instance of the video driver.
Static Protected Member Functions inherited from VideoDriver
static void | GameThreadThunk (VideoDriver *drv)

## Detailed Description

Base class for Windows video drivers.

Definition at line 18 of file win32_v.h.

## Member Function Documentation

## ◆ ChangeResolution()

bool VideoDriver_Win32Base::ChangeResolution | ( | int | w,
|  | int | h
| ) |  |
| overridevirtual

Change the resolution of the window.

Parameters

  w | The new width.
  h | The new height.

Returns
  True if the change succeeded.

Implements VideoDriver.

Definition at line 894 of file win32_v.cpp.

## ◆ EditBoxLostFocus()

void VideoDriver_Win32Base::EditBoxLostFocus | ( |  | ) |
| overridevirtual

An edit box lost the input focus.

Abort character compositing if necessary.

Reimplemented from VideoDriver.

Definition at line 912 of file win32_v.cpp.

References CancelIMEComposition(), main_wnd, SetCandidatePos(), and SetCompositionPos().

## ◆ GetDPIScale()

float VideoDriver_Win32Base::GetDPIScale | ( |  | ) |
| overrideprotectedvirtual

Get DPI scaling factor of the screen OTTD is displayed on.

Returns
  1.0 for default platform DPI, > 1.0 for higher DPI values, and < 1.0 for smaller DPI values.

Reimplemented from VideoDriver.

Definition at line 945 of file win32_v.cpp.

## ◆ GetFullscreenBpp()

uint8 VideoDriver_Win32Base::GetFullscreenBpp | ( |  | ) |
| protectedvirtual

Get screen depth to use for fullscreen mode.

Colour depth to use for fullscreen display modes.

Definition at line 122 of file win32_v.cpp.

## ◆ GetListOfMonitorRefreshRates()

std::vector< int > VideoDriver_Win32Base::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.

Definition at line 919 of file win32_v.cpp.

## ◆ LockVideoBuffer()

bool VideoDriver_Win32Base::LockVideoBuffer | ( |  | ) |
| overrideprotectedvirtual

Make sure the video buffer is ready for drawing.

Returns
  True if the video buffer has to be unlocked.

Reimplemented from VideoDriver.

Definition at line 985 of file win32_v.cpp.

References buffer_locked.

## ◆ MakeDirty()

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

Mark a particular area dirty.

Parameters

  left | The left most line of the dirty area.
  top | The top most line of the dirty area.
  width | The width of the dirty area.
  height | The height of the dirty area.

Implements VideoDriver.

Definition at line 809 of file win32_v.cpp.

References BoundingRect(), dirty_rect, height, and width.

Referenced by CheckPaletteAnim(), and VideoDriver_Win32GDI::PaletteChanged().

## ◆ MakeWindow()

bool VideoDriver_Win32Base::MakeWindow | ( | bool | full_screen,
|  | bool | resize = `true`
| ) |  |
| protected

Instantiate a new window.

Parameters

  full_screen | Whether to make a full screen window or not.
  resize | Whether to change window size.

Returns
  True if the window could be created.

Definition at line 134 of file win32_v.cpp.

Referenced by VideoDriver_Win32GDI::Start(), and ToggleFullscreen().

## ◆ PollEvent()

bool VideoDriver_Win32Base::PollEvent | ( |  | ) |
| overrideprotectedvirtual

Process a single system event.

Returns
  False if there are no more events to process.

Reimplemented from VideoDriver.

Definition at line 852 of file win32_v.cpp.

References EditBoxInGlobalFocus().

## ◆ ToggleFullscreen()

bool VideoDriver_Win32Base::ToggleFullscreen | ( | bool | fullscreen | ) |
| overridevirtual

Change the full screen setting.

Parameters

  fullscreen | The new setting.

Returns
  True if the change succeeded.

Implements VideoDriver.

Definition at line 904 of file win32_v.cpp.

References InvalidateWindowClassesData(), MakeWindow(), and WC_GAME_OPTIONS.

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

- src/video/win32_v.h
- src/video/win32_v.cpp