OpenTTD Source 20261112-master-gbcbec5e63f
VideoDriver_CocoaOpenGL Class Reference
Inheritance diagram for VideoDriver_CocoaOpenGL:
VideoDriver_Cocoa VideoDriver Driver

Public Member Functions

std::optional< std::string_view > Start (const StringList &param) override
 Start this driver.
void Stop () override
 Stop Cocoa video driver.
bool HasEfficient8Bpp () const override
 Has this video driver an efficient code path for palette animated 8-bpp sprites?
bool UseSystemCursor () override
 Get whether the mouse cursor is drawn by the video driver.
void ClearSystemSprites () override
 Clear all cached sprites.
void PopulateSystemSprites () override
 Populate all sprites in cache.
std::string_view GetName () const override
 Get the name of this driver.
std::string_view GetInfoString () const override
 Get some information about the selected driver/backend to be shown to the user.
void AllocateBackingStore (bool force=false) override
 Resize the window.
Public Member Functions inherited from VideoDriver_Cocoa
 VideoDriver_Cocoa (bool uses_hardware_acceleration=false, bool supports_animation_buffer=false)
 Create the video driver.
void MainLoop () override
 Start the main programme loop when using a cocoa video driver.
void MakeDirty (int left, int top, int width, int height) override
 Set dirty a rectangle managed by a cocoa video subdriver.
bool AfterBlitterChange () override
 Callback invoked after the blitter was changed.
bool ChangeResolution (int w, int h) override
 Change the resolution when using a cocoa video driver.
bool ToggleFullscreen (bool fullscreen) override
 Toggle between windowed and full screen mode for cocoa display driver.
void EditBoxLostFocus () override
 An edit box lost the input focus.
std::vector< int > GetListOfMonitorRefreshRates () override
 Get refresh rates of all connected monitors.
void MainLoopReal ()
 Main game loop.
Public Member Functions inherited from VideoDriver
 VideoDriver (bool uses_hardware_acceleration=false, bool supports_animation_buffer=false)
 Create the video driver.
virtual void ToggleVsync (bool vsync)
 Change the vsync setting.
virtual void ClaimMousePointer ()
 Claim the exclusive rights for the mouse pointer.
virtual bool HasGUI () const
 Whether the driver has a graphical user interface with the end user.
constexpr bool SupportsAnimationBuffer () const
 Does this video driver support a separate animation buffer in addition to the colour buffer?
constexpr uint8_t * GetAnimBuffer () const
 Get a pointer to the animation buffer of the video back-end.
constexpr int GetAnimBufferPitch () const
 Get the animation buffer pitch in uint8_t elements per row.
virtual void EditBoxGainedFocus ()
 An edit box gained the input focus.
void QueueOnMainThread (std::function< void()> &&func)
 Queue a function to be called on the main thread with game state lock held and video buffer locked.
void GameLoopPause ()
 Pause the game-loop for a bit, releasing the game-state lock.
virtual void SetScreensaverInhibited (bool inhibited)
 Prevents the system from going to sleep.
Public Member Functions inherited from Driver
virtual ~Driver ()=default
 Ensure the destructor of the sub classes are called as well.

Protected Member Functions

void Paint () override
 Paint the window.
void * GetVideoPointer () override
 Get a pointer to the video buffer.
void ReleaseVideoPointer () override
 Hand video buffer back to the drawing backend.
NSView * AllocateDrawView () override
 Allocate the view to show the game on.
Protected Member Functions inherited from VideoDriver_Cocoa
Dimension GetScreenSize () const override
 Get the resolution of the main screen.
void InputLoop () override
 Handle input logic, is CTRL pressed, should we fast-forward, etc.
bool LockVideoBuffer () override
 Lock video buffer for drawing if it isn't already mapped.
void UnlockVideoBuffer () override
 Unlock video buffer.
bool PollEvent () override
 Poll and handle a single event from the OS.
void GameSizeChanged ()
 Handle a change of the display area.
std::optional< std::string_view > Initialize ()
 Common driver initialization.
void UpdateVideoModes ()
 Update the video mode.
bool MakeWindow (int width, int height)
 Build window and view with a given size.
Protected Member Functions inherited from VideoDriver
void UpdateAutoResolution ()
 Apply resolution auto-detection and clamp to sensible defaults.
virtual void CheckPaletteAnim ()
 Process any pending palette animation.
void StartGameThread ()
 Start the loop for game-tick.
void StopGameThread ()
 Stop the loop for the game-tick.
void Tick ()
 Give the video-driver a tick.
void SleepTillNextTick ()
 Sleep till the next tick is about to happen.
std::chrono::steady_clock::duration GetGameInterval ()
std::chrono::steady_clock::duration GetDrawInterval ()
void DrainCommandQueue ()
 Execute all queued commands.

Private Member Functions

std::optional< std::string_view > AllocateContext (bool allow_software)

Private Attributes

CGLContextObj gl_context = nullptr
 The OpenGL context.
std::string driver_info
 Information string about selected driver.

Additional Inherited Members

Public Types inherited from Driver
enum class  Type : uint8_t {
  Begin = 0 , Music = 0 , Sound , Video ,
  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 std::string GetCaption ()
 Get the caption to use for the game's title bar.
Data Fields inherited from VideoDriver_Cocoa
bool setup
 Window is currently being created.
OTTD_CocoaWindow * window
 Pointer to window object.
OTTD_CocoaView * cocoaview
 Pointer to view object.
CGColorSpaceRef colour_space
 Window colour space.
OTTD_CocoaWindowDelegate * delegate
 Window delegate object.
Static Protected Member Functions inherited from VideoDriver
static void GameThreadThunk (VideoDriver *drv)
Protected Attributes inherited from VideoDriver_Cocoa
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
std::thread game_thread
std::mutex game_state_mutex
std::mutex game_thread_wait_mutex
uint8_t * anim_buffer = nullptr
 The animation buffer if supported/used.
int anim_pitch = 0
 Pitch of the animation buffer if supported/used.
const bool uses_hardware_acceleration
 Whether hardware acceleration is used or not.
const bool supports_animation_buffer
 Whether this driver supports hardware accelerated animation.
bool fast_forward_key_pressed = false
 The fast-forward key is being pressed.
bool fast_forward_via_key = false
 The fast-forward was enabled by key press.
bool is_game_threaded = true
 Whether the game is allowed to use threads; cleared in the driver implementation constructors if required.

Detailed Description

Definition at line 17 of file cocoa_ogl.h.

Constructor & Destructor Documentation

◆ VideoDriver_CocoaOpenGL()

VideoDriver_CocoaOpenGL::VideoDriver_CocoaOpenGL ( )
inline

Definition at line 25 of file cocoa_ogl.h.

Member Function Documentation

◆ AllocateBackingStore()

void VideoDriver_CocoaOpenGL::AllocateBackingStore ( bool force = false)
overridevirtual

◆ AllocateContext()

std::optional< std::string_view > VideoDriver_CocoaOpenGL::AllocateContext ( bool allow_software)
private

Definition at line 253 of file cocoa_ogl.mm.

◆ AllocateDrawView()

NSView * VideoDriver_CocoaOpenGL::AllocateDrawView ( )
overrideprotectedvirtual

Allocate the view to show the game on.

Returns
The allocated view.

Implements VideoDriver_Cocoa.

Definition at line 270 of file cocoa_ogl.mm.

◆ ClearSystemSprites()

void VideoDriver_CocoaOpenGL::ClearSystemSprites ( )
overridevirtual

Clear all cached sprites.

Reimplemented from VideoDriver_Cocoa.

Definition at line 245 of file cocoa_ogl.mm.

References OpenGLBackend::ClearCursorCache(), VideoDriver_Cocoa::ClearSystemSprites(), OpenGLBackend::Get(), and gl_context.

◆ GetInfoString()

std::string_view VideoDriver_CocoaOpenGL::GetInfoString ( ) const
inlineoverridevirtual

Get some information about the selected driver/backend to be shown to the user.

Returns
The information.

Reimplemented from VideoDriver.

Definition at line 40 of file cocoa_ogl.h.

◆ GetName()

std::string_view VideoDriver_CocoaOpenGL::GetName ( ) const
inlineoverridevirtual

Get the name of this driver.

Returns
The name of the driver.

Implements Driver.

Definition at line 38 of file cocoa_ogl.h.

Referenced by Start().

◆ GetVideoPointer()

void * VideoDriver_CocoaOpenGL::GetVideoPointer ( )
overrideprotectedvirtual

◆ HasEfficient8Bpp()

bool VideoDriver_CocoaOpenGL::HasEfficient8Bpp ( ) const
inlineoverridevirtual

Has this video driver an efficient code path for palette animated 8-bpp sprites?

Returns
True if the driver has an efficient code path for 8-bpp.

Reimplemented from VideoDriver.

Definition at line 30 of file cocoa_ogl.h.

◆ Paint()

void VideoDriver_CocoaOpenGL::Paint ( )
overrideprotectedvirtual

◆ PopulateSystemSprites()

void VideoDriver_CocoaOpenGL::PopulateSystemSprites ( )
overridevirtual

Populate all sprites in cache.

Reimplemented from VideoDriver_Cocoa.

Definition at line 238 of file cocoa_ogl.mm.

References OpenGLBackend::Get(), and VideoDriver_Cocoa::PopulateSystemSprites().

◆ ReleaseVideoPointer()

void VideoDriver_CocoaOpenGL::ReleaseVideoPointer ( )
overrideprotectedvirtual

◆ Start()

std::optional< std::string_view > VideoDriver_CocoaOpenGL::Start ( const StringList & parm)
overridevirtual

◆ Stop()

void VideoDriver_CocoaOpenGL::Stop ( )
overridevirtual

Stop Cocoa video driver.

Reimplemented from VideoDriver_Cocoa.

Definition at line 229 of file cocoa_ogl.mm.

References OpenGLBackend::Destroy(), gl_context, and VideoDriver_Cocoa::Stop().

Referenced by Start().

◆ UseSystemCursor()

bool VideoDriver_CocoaOpenGL::UseSystemCursor ( )
inlineoverridevirtual

Get whether the mouse cursor is drawn by the video driver.

Returns
True if cursor drawing is done by the video driver.

Reimplemented from VideoDriver.

Definition at line 32 of file cocoa_ogl.h.

Field Documentation

◆ driver_info

std::string VideoDriver_CocoaOpenGL::driver_info
private

Information string about selected driver.

Definition at line 20 of file cocoa_ogl.h.

Referenced by Start().

◆ gl_context

CGLContextObj VideoDriver_CocoaOpenGL::gl_context = nullptr
private

The OpenGL context.

Definition at line 18 of file cocoa_ogl.h.

Referenced by AllocateBackingStore(), ClearSystemSprites(), GetVideoPointer(), Paint(), ReleaseVideoPointer(), and Stop().


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