Inheritance diagram for VideoDriver_CocoaQuartz:

Public Member Functions
std::optional< std::string_view >	Start (const StringList &param) override
	Start this driver.

void	Stop () override
	Stop this driver.

std::string_view	GetName () const override
	Return driver name.

void	AllocateBackingStore (bool force=false) override

Public Member Functions inherited from VideoDriver_Cocoa
	VideoDriver_Cocoa (bool uses_hardware_acceleration=false)

void	MainLoop () override
	Perform the actual drawing.

void	MakeDirty (int left, int top, int width, int height) override
	Mark a particular area dirty.

bool	AfterBlitterChange () override
	Callback invoked after the blitter was changed.

bool	ChangeResolution (int w, int h) override
	Change the resolution of the window.

bool	ToggleFullscreen (bool fullscreen) override
	Change the full screen setting.

void	ClearSystemSprites () override
	Clear all cached sprites.

void	PopulateSystemSprites () override
	Populate all sprites in cache.

void	EditBoxLostFocus () override
	An edit box lost the input focus.

std::vector< int >	GetListOfMonitorRefreshRates () override
	Get a list of refresh rates of each available monitor.

void	MainLoopReal ()

Public Member Functions inherited from VideoDriver
	VideoDriver (bool uses_hardware_acceleration=false)

virtual void	ToggleVsync (bool vsync)
	Change the vsync setting.

virtual bool	ClaimMousePointer ()

virtual bool	UseSystemCursor ()
	Get whether the mouse cursor is drawn by the video driver.

virtual bool	HasGUI () const
	Whether the driver has a graphical user interface with the end user.

virtual bool	HasEfficient8Bpp () const
	Has this video driver an efficient code path for palette animated 8-bpp sprites?

virtual bool	HasAnimBuffer ()
	Does this video driver support a separate animation buffer in addition to the colour buffer?

virtual uint8_t *	GetAnimBuffer ()
	Get a pointer to the animation buffer of the video back-end.

virtual void	EditBoxGainedFocus ()
	An edit box gained the input focus.

virtual int	GetSuggestedUIScale ()
	Get a suggested default GUI scale taking screen DPI into account.

virtual std::string_view	GetInfoString () const

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.

Data Fields
CGContextRef	cgcontext
	Context reference for Quartz subdriver.

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	color_space
	Window color space.

OTTD_CocoaWindowDelegate *	delegate
	Window delegate object.

Protected Member Functions
void	Paint () override
	Paint the window.

void	CheckPaletteAnim () override
	Process any pending palette animation.

NSView *	AllocateDrawView () override

void *	GetVideoPointer () override
	Get a pointer to the video buffer.

Protected Member Functions inherited from VideoDriver_Cocoa
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.

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.

void	UnlockVideoBuffer () override
	Unlock a previously locked video buffer.

bool	PollEvent () override
	Process a single system event.

void	GameSizeChanged ()

std::optional< std::string_view >	Initialize ()

void	UpdateVideoModes ()

bool	MakeWindow (int width, int height)

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.

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
void	BlitIndexedToView32 (int left, int top, int right, int bottom)

void	UpdatePalette (uint first_color, uint num_colors)

Private Attributes
int	buffer_depth
	Colour depth of used frame buffer.

void *	pixel_buffer
	used for direct pixel access

void *	window_buffer
	Colour translation from palette to screen.

int	window_width
	Current window width in pixel.

int	window_height
	Current window height in pixel.

int	window_pitch

uint32_t	palette [256]
	Colour Palette.

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 std::string	GetCaption ()
	Get the caption to use for the game's title bar.

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

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

bool	uses_hardware_acceleration

Detailed Description

Definition at line 92 of file cocoa_v.h.

Member Function Documentation

◆ AllocateBackingStore()

void VideoDriver_CocoaQuartz::AllocateBackingStore ( bool force = false )

overridevirtual

Implements VideoDriver_Cocoa.

◆ AllocateDrawView()

NSView * VideoDriver_CocoaQuartz::AllocateDrawView ( )

overrideprotectedvirtual

Implements VideoDriver_Cocoa.

◆ CheckPaletteAnim()

void VideoDriver_CocoaQuartz::CheckPaletteAnim ( )

overrideprotectedvirtual

Process any pending palette animation.

Reimplemented from VideoDriver.

◆ GetName()

std::string_view VideoDriver_CocoaQuartz::GetName ( ) const

inlineoverridevirtual

Return driver name.

Implements Driver.

Definition at line 116 of file cocoa_v.h.

◆ GetVideoPointer()

void * VideoDriver_CocoaQuartz::GetVideoPointer ( )

inlineoverrideprotectedvirtual

Get a pointer to the video buffer.

Implements VideoDriver_Cocoa.

Definition at line 126 of file cocoa_v.h.

References pixel_buffer, and window_buffer.

◆ Paint()

void VideoDriver_CocoaQuartz::Paint ( )

overrideprotectedvirtual

Paint the window.

Reimplemented from VideoDriver.

◆ Start()

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

overridevirtual

Start this driver.

Parameters

parm	Parameters passed to the driver.

Returns: std::nullopt if everything went okay, otherwise an error message.

Implements Driver.

◆ Stop()

void VideoDriver_CocoaQuartz::Stop ( )

overridevirtual

Stop this driver.

Reimplemented from VideoDriver_Cocoa.

Field Documentation

◆ buffer_depth

int VideoDriver_CocoaQuartz::buffer_depth

private

Colour depth of used frame buffer.

Definition at line 94 of file cocoa_v.h.

◆ cgcontext

CGContextRef VideoDriver_CocoaQuartz::cgcontext

Context reference for Quartz subdriver.

Definition at line 108 of file cocoa_v.h.

◆ palette

uint32_t VideoDriver_CocoaQuartz::palette[256]

private

Colour Palette.

Definition at line 102 of file cocoa_v.h.

◆ pixel_buffer

void* VideoDriver_CocoaQuartz::pixel_buffer

private

used for direct pixel access

Definition at line 95 of file cocoa_v.h.

Referenced by GetVideoPointer().

◆ window_buffer

void* VideoDriver_CocoaQuartz::window_buffer

private

Colour translation from palette to screen.

Definition at line 96 of file cocoa_v.h.

Referenced by GetVideoPointer().

◆ window_height

int VideoDriver_CocoaQuartz::window_height

private

Current window height in pixel.

Definition at line 99 of file cocoa_v.h.

◆ window_pitch

int VideoDriver_CocoaQuartz::window_pitch

private

Definition at line 100 of file cocoa_v.h.

◆ window_width

int VideoDriver_CocoaQuartz::window_width

private

Current window width in pixel.

Definition at line 98 of file cocoa_v.h.

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

src/video/cocoa/cocoa_v.h

Public Member Functions

Data Fields

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ AllocateBackingStore()

◆ AllocateDrawView()

◆ CheckPaletteAnim()

◆ GetName()

◆ GetVideoPointer()

◆ Paint()

◆ Start()

◆ Stop()

Field Documentation

◆ buffer_depth

◆ cgcontext

◆ palette

◆ pixel_buffer

◆ window_buffer

◆ window_height

◆ window_pitch

◆ window_width