|
OpenTTD Source 20261112-master-gbcbec5e63f
|
Public Member Functions | |
| std::optional< std::string_view > | Start (const StringList ¶m) 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. | |
Definition at line 17 of file cocoa_ogl.h.
|
inline |
Definition at line 25 of file cocoa_ogl.h.
|
overridevirtual |
Resize the window.
| force | If true window resizing will be forced. |
Implements VideoDriver_Cocoa.
Definition at line 275 of file cocoa_ogl.mm.
References VideoDriver_Cocoa::buffer_locked, VideoDriver_Cocoa::dirty_rect, VideoDriver_Cocoa::GameSizeChanged(), OpenGLBackend::Get(), GetVideoPointer(), gl_context, ReleaseVideoPointer(), OpenGLBackend::Resize(), VideoDriver_Cocoa::setup, and VideoDriver_Cocoa::window.
Referenced by Start().
|
private |
Definition at line 253 of file cocoa_ogl.mm.
|
overrideprotectedvirtual |
Allocate the view to show the game on.
Implements VideoDriver_Cocoa.
Definition at line 270 of file cocoa_ogl.mm.
|
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.
|
inlineoverridevirtual |
Get some information about the selected driver/backend to be shown to the user.
Reimplemented from VideoDriver.
Definition at line 40 of file cocoa_ogl.h.
|
inlineoverridevirtual |
Get the name of this driver.
Implements Driver.
Definition at line 38 of file cocoa_ogl.h.
Referenced by Start().
|
overrideprotectedvirtual |
Get a pointer to the video buffer.
Implements VideoDriver_Cocoa.
Definition at line 291 of file cocoa_ogl.mm.
References VideoDriver::anim_buffer, VideoDriver::anim_pitch, OpenGLBackend::Get(), OpenGLBackend::GetAnimBuffer(), BlitterFactory::GetCurrentBlitter(), OpenGLBackend::GetVideoBuffer(), and gl_context.
Referenced by AllocateBackingStore().
|
inlineoverridevirtual |
Has this video driver an efficient code path for palette animated 8-bpp sprites?
Reimplemented from VideoDriver.
Definition at line 30 of file cocoa_ogl.h.
|
overrideprotectedvirtual |
Paint the window.
Reimplemented from VideoDriver.
Definition at line 313 of file cocoa_ogl.mm.
References _local_palette, Blitter::Blitter, CopyPalette(), OpenGLBackend::Get(), BlitterFactory::GetCurrentBlitter(), gl_context, Blitter::PaletteAnimate(), OpenGLBackend::UpdatePalette(), Blitter::UsePaletteAnimation(), and Video.
|
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().
|
overrideprotectedvirtual |
Hand video buffer back to the drawing backend.
Reimplemented from VideoDriver_Cocoa.
Definition at line 301 of file cocoa_ogl.mm.
References VideoDriver::anim_buffer, VideoDriver::anim_pitch, VideoDriver_Cocoa::dirty_rect, OpenGLBackend::Get(), gl_context, OpenGLBackend::ReleaseAnimBuffer(), and OpenGLBackend::ReleaseVideoBuffer().
Referenced by AllocateBackingStore().
|
overridevirtual |
Start this driver.
| parm | Parameters passed to the driver. |
Implements Driver.
Definition at line 186 of file cocoa_ogl.mm.
References _cur_resolution, AllocateBackingStore(), driver_info, VideoDriver_Cocoa::GameSizeChanged(), OpenGLBackend::Get(), BlitterFactory::GetCurrentBlitter(), GetDriverParamBool(), GetName(), Blitter::GetScreenDepth(), VideoDriver_Cocoa::Initialize(), VideoDriver::is_game_threaded, VideoDriver_Cocoa::MakeWindow(), MarkWholeScreenDirty(), Stop(), VideoDriver_Cocoa::ToggleFullscreen(), and VideoDriver_Cocoa::UpdateVideoModes().
|
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().
|
inlineoverridevirtual |
Get whether the mouse cursor is drawn by the video driver.
Reimplemented from VideoDriver.
Definition at line 32 of file cocoa_ogl.h.
|
private |
Information string about selected driver.
Definition at line 20 of file cocoa_ogl.h.
Referenced by Start().
|
private |
The OpenGL context.
Definition at line 18 of file cocoa_ogl.h.
Referenced by AllocateBackingStore(), ClearSystemSprites(), GetVideoPointer(), Paint(), ReleaseVideoPointer(), and Stop().