OpenTTD Source: src/video/cocoa/cocoa_ogl.h Source File

OpenTTD Source 15.0-RC2

cocoa_ogl.h
Go to the documentation of this file.
1/*
2 * This file is part of OpenTTD.
3 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
6 */
7
10#ifndef VIDEO_COCOA_OGL_H
11#define VIDEO_COCOA_OGL_H
12
13#include "cocoa_v.h"
14
15@class OTTD_OpenGLView;
16
17 class VideoDriver_CocoaOpenGL : public VideoDriver_Cocoa {
18 CGLContextObj gl_context;
19
20 uint8_t *anim_buffer;
21 std::string driver_info;
22
23 std::optional<std::string_view> AllocateContext(bool allow_software);
24
25public:
26 VideoDriver_CocoaOpenGL() : VideoDriver_Cocoa(true), gl_context(nullptr), anim_buffer(nullptr), driver_info(this->GetName()) {}
27
28 std::optional<std::string_view> Start(const StringList &param) override;
29 void Stop() override;
30
31 bool HasEfficient8Bpp() const override { return true; }
32
33 bool UseSystemCursor() override { return true; }
34
35 void ClearSystemSprites() override;
36
37 void PopulateSystemSprites() override;
38
39 bool HasAnimBuffer() override { return true; }
40 uint8_t *GetAnimBuffer() override { return this->anim_buffer; }
41
43 std::string_view GetName() const override { return "cocoa-opengl"; }
44
45 std::string_view GetInfoString() const override { return this->driver_info; }
46
47 void AllocateBackingStore(bool force = false) override;
48
49protected:
50 void Paint() override;
51
52 void *GetVideoPointer() override;
53 void ReleaseVideoPointer() override;
54
55 NSView *AllocateDrawView() override;
56};
57
58 class FVideoDriver_CocoaOpenGL : public DriverFactoryBase {
59public:
60 FVideoDriver_CocoaOpenGL() : DriverFactoryBase(Driver::DT_VIDEO, 9, "cocoa-opengl", "Cocoa OpenGL Video Driver") {}
61 std::unique_ptr<Driver> CreateInstance() const override { return std::make_unique<VideoDriver_CocoaOpenGL>(); }
62
63protected:
64 bool UsesHardwareAcceleration() const override { return true; }
65};
66
67#endif /* VIDEO_COCOA_OGL_H */
DriverFactoryBase
Base for all driver factories.
Definition driver.h:57
Driver::DT_VIDEO
@ DT_VIDEO
A video driver.
Definition driver.h:42
FVideoDriver_CocoaOpenGL
Definition cocoa_ogl.h:58
FVideoDriver_CocoaOpenGL::CreateInstance
std::unique_ptr< Driver > CreateInstance() const override
Create an instance of this driver-class.
Definition cocoa_ogl.h:61
FVideoDriver_CocoaOpenGL::UsesHardwareAcceleration
bool UsesHardwareAcceleration() const override
Does the driver use hardware acceleration (video-drivers only).
Definition cocoa_ogl.h:64
VideoDriver_CocoaOpenGL
Definition cocoa_ogl.h:17
VideoDriver_CocoaOpenGL::anim_buffer
uint8_t * anim_buffer
Animation buffer from OpenGL back-end.
Definition cocoa_ogl.h:20
VideoDriver_CocoaOpenGL::GetVideoPointer
void * GetVideoPointer() override
Get a pointer to the video buffer.
VideoDriver_CocoaOpenGL::driver_info
std::string driver_info
Information string about selected driver.
Definition cocoa_ogl.h:21
VideoDriver_CocoaOpenGL::GetAnimBuffer
uint8_t * GetAnimBuffer() override
Get a pointer to the animation buffer of the video back-end.
Definition cocoa_ogl.h:40
VideoDriver_CocoaOpenGL::PopulateSystemSprites
void PopulateSystemSprites() override
Populate all sprites in cache.
VideoDriver_CocoaOpenGL::ReleaseVideoPointer
void ReleaseVideoPointer() override
Hand video buffer back to the drawing backend.
VideoDriver_CocoaOpenGL::Start
std::optional< std::string_view > Start(const StringList &param) override
Start this driver.
VideoDriver_CocoaOpenGL::GetName
std::string_view GetName() const override
Return driver name.
Definition cocoa_ogl.h:43
VideoDriver_CocoaOpenGL::Paint
void Paint() override
Paint the window.
VideoDriver_CocoaOpenGL::HasEfficient8Bpp
bool HasEfficient8Bpp() const override
Has this video driver an efficient code path for palette animated 8-bpp sprites?
Definition cocoa_ogl.h:31
VideoDriver_CocoaOpenGL::HasAnimBuffer
bool HasAnimBuffer() override
Does this video driver support a separate animation buffer in addition to the colour buffer?
Definition cocoa_ogl.h:39
VideoDriver_CocoaOpenGL::ClearSystemSprites
void ClearSystemSprites() override
Clear all cached sprites.
VideoDriver_CocoaOpenGL::Stop
void Stop() override
Stop this driver.
VideoDriver_CocoaOpenGL::UseSystemCursor
bool UseSystemCursor() override
Get whether the mouse cursor is drawn by the video driver.
Definition cocoa_ogl.h:33
VideoDriver_Cocoa
Definition cocoa_v.h:23
cocoa_v.h
The Cocoa video driver.
StringList
std::vector< std::string > StringList
Type for a list of strings.
Definition string_type.h:60