OpenTTD Source  1.11.0-beta2
VideoDriver_Cocoa Class Referenceabstract
Inheritance diagram for VideoDriver_Cocoa:
VideoDriver Driver VideoDriver_CocoaOpenGL VideoDriver_CocoaQuartz

Public Member Functions

void Stop () override
 Stop this driver.
 
void MainLoop () override
 Perform the actual drawing.
 
void MakeDirty (int left, int top, int width, int height) override
 Mark a particular area dirty. More...
 
bool AfterBlitterChange () override
 Callback invoked after the blitter was changed. More...
 
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...
 
void EditBoxLostFocus () override
 An edit box lost the input focus. More...
 
void MainLoopReal ()
 
virtual void AllocateBackingStore (bool force=false)=0
 
- 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 ClaimMousePointer ()
 
virtual bool UseSystemCursor ()
 Get whether the mouse cursor is drawn by the video driver. More...
 
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.
 
- 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...
 

Data Fields

bool setup
 Window is currently being created.
 
OTTD_CocoaWindowwindow
 Pointer to window object.
 
OTTD_CocoaViewcocoaview
 Pointer to view object.
 
CGColorSpaceRef color_space
 Window color space.
 
OTTD_CocoaWindowDelegatedelegate
 Window delegate object.
 

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.
 
bool PollEvent () override
 Process a single system event. More...
 
void GameSizeChanged ()
 
const char * Initialize ()
 
void UpdateVideoModes ()
 
bool MakeWindow (int width, int height)
 
virtual NSView * AllocateDrawView ()=0
 
virtual void * GetVideoPointer ()=0
 Get a pointer to the video buffer.
 
virtual void ReleaseVideoPointer ()
 Hand video buffer back to the drawing backend.
 
- Protected Member Functions inherited from VideoDriver
void UpdateAutoResolution ()
 Apply resolution auto-detection and clamp to sensible defaults.
 
virtual void Paint ()
 Paint the window.
 
virtual void PaintThread ()
 Thread function for threaded drawing.
 
virtual void CheckPaletteAnim ()
 Process any pending palette animation.
 
bool Tick ()
 Run the game for a single tick, processing boththe game-tick and draw-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

Rect dirty_rect
 Region of the screen that needs redrawing.
 
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.
 

Private Member Functions

bool IsFullscreen ()
 

Private Attributes

Dimension orig_res
 Saved window size for non-fullscreen mode.
 

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

Definition at line 23 of file cocoa_v.h.

Member Function Documentation

◆ AfterBlitterChange()

bool VideoDriver_Cocoa::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_Cocoa::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.

◆ EditBoxLostFocus()

void VideoDriver_Cocoa::EditBoxLostFocus ( )
overridevirtual

An edit box lost the input focus.

Abort character compositing if necessary.

Reimplemented from VideoDriver.

◆ GetDPIScale()

float VideoDriver_Cocoa::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.

◆ LockVideoBuffer()

bool VideoDriver_Cocoa::LockVideoBuffer ( )
overrideprotectedvirtual

Make sure the video buffer is ready for drawing.

Returns
True if the video buffer has to be unlocked.

Reimplemented from VideoDriver.

◆ MakeDirty()

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

◆ PollEvent()

bool VideoDriver_Cocoa::PollEvent ( )
overrideprotectedvirtual

Process a single system event.

Returns
False if there are no more events to process.

Reimplemented from VideoDriver.

◆ ToggleFullscreen()

bool VideoDriver_Cocoa::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: