OpenTTD Source  20241108-master-g80f628063a
opengl.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 <http://www.gnu.org/licenses/>.
6  */
7 
10 #ifndef VIDEO_OPENGL_H
11 #define VIDEO_OPENGL_H
12 
13 #include "../core/alloc_type.hpp"
14 #include "../core/geometry_type.hpp"
15 #include "../gfx_type.h"
16 #include "../spriteloader/spriteloader.hpp"
17 #include "../misc/lrucache.hpp"
18 
19 typedef void (*OGLProc)();
20 typedef OGLProc (*GetOGLProcAddressProc)(const char *proc);
21 
22 bool IsOpenGLVersionAtLeast(uint8_t major, uint8_t minor);
23 const char *FindStringInExtensionList(const char *string, const char *substring);
24 
25 class OpenGLSprite;
26 
29 private:
31 
35 
36  void *vid_buffer;
37  GLuint vid_pbo;
38  GLuint vid_texture;
39  GLuint vid_program;
40  GLuint pal_program;
41  GLuint vao_quad;
42  GLuint vbo_quad;
43  GLuint pal_texture;
44 
45  void *anim_buffer;
46  GLuint anim_pbo;
47  GLuint anim_texture;
48 
49  GLuint remap_program;
53  GLint remap_rgb_loc;
54 
55  GLuint sprite_program;
61 
64  bool clear_cursor_cache = false;
65 
68  std::vector<CursorSprite> cursor_sprites;
69 
70  OpenGLBackend();
72 
73  std::optional<std::string_view> Init(const Dimension &screen_res);
74  bool InitShaders();
75 
77 
78  void RenderOglSprite(OpenGLSprite *gl_sprite, PaletteID pal, int x, int y, ZoomLevel zoom);
79 
80 public:
82  static inline OpenGLBackend *Get()
83  {
85  }
86  static std::optional<std::string_view> Create(GetOGLProcAddressProc get_proc, const Dimension &screen_res);
87  static void Destroy();
88 
89  void PrepareContext();
90 
91  std::string GetDriverName();
92 
93  void UpdatePalette(const Colour *pal, uint first, uint length);
94  bool Resize(int w, int h, bool force = false);
95  void Paint();
96 
97  void DrawMouseCursor();
98  void PopulateCursorCache();
99  void ClearCursorCache();
100 
101  void *GetVideoBuffer();
102  uint8_t *GetAnimBuffer();
103  void ReleaseVideoBuffer(const Rect &update_rect);
104  void ReleaseAnimBuffer(const Rect &update_rect);
105 
106  /* SpriteEncoder */
107 
108  bool Is32BppSupported() override { return true; }
109  uint GetSpriteAlignment() override { return 1u << (ZOOM_LVL_END - 1); }
110  Sprite *Encode(const SpriteLoader::SpriteCollection &sprite, SpriteAllocator &allocator) override;
111 };
112 
113 
116 private:
118  enum Texture {
121  NUM_TEX
122  };
123 
124  Dimension dim;
125  GLuint tex[NUM_TEX];
126 
127  static GLuint dummy_tex[NUM_TEX];
128 
129  static GLuint pal_identity;
130  static GLuint pal_tex;
131  static GLuint pal_pbo;
132 
133  static bool Create();
134  static void Destroy();
135 
136  bool BindTextures();
137 
138 public:
139  OpenGLSprite(uint width, uint height, uint levels, SpriteColourComponent components);
140  ~OpenGLSprite();
141 
142  void Update(uint width, uint height, uint level, const SpriteLoader::CommonPixel *data);
143  Dimension GetSize(ZoomLevel level) const;
144 
145  friend class OpenGLBackend;
146 };
147 
148 #endif /* VIDEO_OPENGL_H */
Platform-independent back-end class for OpenGL video drivers.
Definition: opengl.h:28
GLint sprite_rgb_loc
Uniform location for RGB mode flag.
Definition: opengl.h:59
void * anim_buffer
Pointer to the mapped animation buffer.
Definition: opengl.h:45
GLuint remap_program
Shader program for blending and rendering a RGBA + remap texture.
Definition: opengl.h:49
bool cursor_in_window
Cursor inside this window.
Definition: opengl.h:67
uint GetSpriteAlignment() override
Get the value which the height and width on a sprite have to be aligned by.
Definition: opengl.h:109
void Paint()
Render video buffer to the screen.
Definition: opengl.cpp:1039
GLuint pal_program
Shader program for rendering a paletted video buffer.
Definition: opengl.h:40
void RenderOglSprite(OpenGLSprite *gl_sprite, PaletteID pal, int x, int y, ZoomLevel zoom)
Render a sprite to the back buffer.
Definition: opengl.cpp:1289
std::vector< CursorSprite > cursor_sprites
Sprites comprising cursor.
Definition: opengl.h:68
GLint remap_screen_loc
Uniform location for screen size.
Definition: opengl.h:51
static OpenGLBackend * instance
Singleton instance pointer.
Definition: opengl.h:30
uint8_t * GetAnimBuffer()
Get a pointer to the memory for the separate animation buffer.
Definition: opengl.cpp:1170
void * GetVideoBuffer()
Get a pointer to the memory for the video driver to draw to.
Definition: opengl.cpp:1148
bool persistent_mapping_supported
Persistent pixel buffer mapping supported.
Definition: opengl.h:32
GLuint vid_texture
Texture handle for the video buffer texture.
Definition: opengl.h:38
GLuint vao_quad
Vertex array object storing the rendering state for the fullscreen quad.
Definition: opengl.h:41
GLint sprite_zoom_loc
Uniform location for sprite zoom.
Definition: opengl.h:58
GLint remap_zoom_loc
Uniform location for sprite zoom.
Definition: opengl.h:52
bool Resize(int w, int h, bool force=false)
Change the size of the drawing window and allocate matching resources.
Definition: opengl.cpp:913
OpenGLBackend()
Construct OpenGL back-end class.
Definition: opengl.cpp:489
static std::optional< std::string_view > Create(GetOGLProcAddressProc get_proc, const Dimension &screen_res)
Create and initialize the singleton back-end class.
Definition: opengl.cpp:467
void * vid_buffer
Pointer to the mapped video buffer.
Definition: opengl.h:36
Sprite * Encode(const SpriteLoader::SpriteCollection &sprite, SpriteAllocator &allocator) override
Convert a sprite from the loader to our own format.
Definition: opengl.cpp:1261
void UpdatePalette(const Colour *pal, uint first, uint length)
Update the stored palette.
Definition: opengl.cpp:1025
GLuint anim_texture
Texture handle for the animation buffer texture.
Definition: opengl.h:47
void InternalClearCursorCache()
Clear all cached cursor sprites.
Definition: opengl.cpp:1122
GLuint sprite_program
Shader program for blending and rendering a sprite to the video buffer.
Definition: opengl.h:55
void ReleaseAnimBuffer(const Rect &update_rect)
Update animation buffer texture after the animation buffer was filled.
Definition: opengl.cpp:1231
GLuint vid_pbo
Pixel buffer object storing the memory used for the video driver to draw to.
Definition: opengl.h:37
GLsync sync_anim_mapping
Sync object for the persistently mapped animation buffer.
Definition: opengl.h:34
~OpenGLBackend()
Free allocated resources.
Definition: opengl.cpp:496
GLuint vbo_quad
Vertex buffer with a fullscreen quad.
Definition: opengl.h:42
bool clear_cursor_cache
A clear of the cursor cache is pending.
Definition: opengl.h:64
GLint remap_rgb_loc
Uniform location for RGB mode flag.
Definition: opengl.h:53
void ClearCursorCache()
Queue a request for cursor cache clear.
Definition: opengl.cpp:1135
GLuint vid_program
Shader program for rendering a RGBA video buffer.
Definition: opengl.h:39
GLuint pal_texture
Palette lookup texture.
Definition: opengl.h:43
bool Is32BppSupported() override
Can the sprite encoder make use of RGBA sprites?
Definition: opengl.h:108
GLint remap_sprite_loc
Uniform location for sprite parameters.
Definition: opengl.h:50
bool InitShaders()
Create all needed shader programs.
Definition: opengl.cpp:804
void DrawMouseCursor()
Draw mouse cursor on screen.
Definition: opengl.cpp:1071
Point cursor_pos
Cursor position.
Definition: opengl.h:66
GLint sprite_crash_loc
Uniform location for crash remap mode flag.
Definition: opengl.h:60
void ReleaseVideoBuffer(const Rect &update_rect)
Update video buffer texture after the video buffer was filled.
Definition: opengl.cpp:1193
GLint sprite_sprite_loc
Uniform location for sprite parameters.
Definition: opengl.h:56
PaletteID last_sprite_pal
Last uploaded remap palette.
Definition: opengl.h:63
GLuint anim_pbo
Pixel buffer object storing the memory used for the animation buffer.
Definition: opengl.h:46
LRUCache< SpriteID, Sprite > cursor_cache
Cache of encoded cursor sprites.
Definition: opengl.h:62
GLsync sync_vid_mapping
Sync object for the persistently mapped video buffer.
Definition: opengl.h:33
std::optional< std::string_view > Init(const Dimension &screen_res)
Check for the needed OpenGL functionality and allocate all resources.
Definition: opengl.cpp:525
static void Destroy()
Free resources and destroy singleton back-end class.
Definition: opengl.cpp:480
static OpenGLBackend * Get()
Get singleton instance of this class.
Definition: opengl.h:82
GLint sprite_screen_loc
Uniform location for screen size.
Definition: opengl.h:57
Class that encapsulates a RGBA texture together with a paletted remap texture.
Definition: opengl.h:115
OpenGLSprite(uint width, uint height, uint levels, SpriteColourComponent components)
Create an OpenGL sprite with a palette remap part.
Definition: opengl.cpp:1415
static GLuint dummy_tex[NUM_TEX]
1x1 dummy textures to substitute for unused sprite components.
Definition: opengl.h:127
bool BindTextures()
Bind textures for rendering this sprite.
Definition: opengl.cpp:1526
Dimension GetSize(ZoomLevel level) const
Query the sprite size at a certain zoom level.
Definition: opengl.cpp:1516
static bool Create()
Create all common resources for sprite rendering.
Definition: opengl.cpp:1339
static GLuint pal_pbo
Pixel buffer object for remap upload.
Definition: opengl.h:131
GLuint tex[NUM_TEX]
The texture objects.
Definition: opengl.h:125
static GLuint pal_identity
Identity texture mapping.
Definition: opengl.h:129
static GLuint pal_tex
Texture for palette remap.
Definition: opengl.h:130
void Update(uint width, uint height, uint level, const SpriteLoader::CommonPixel *data)
Update a single mip-map level with new pixel data.
Definition: opengl.cpp:1468
Texture
Enum of all used OpenGL texture objects.
Definition: opengl.h:118
@ TEX_RGBA
RGBA texture part.
Definition: opengl.h:119
@ TEX_REMAP
Remap texture part.
Definition: opengl.h:120
static void Destroy()
Free all common resources for sprite rendering.
Definition: opengl.cpp:1400
Interface for something that can allocate memory for a sprite.
Interface for something that can encode a sprite.
std::array< Sprite, ZOOM_LVL_END > SpriteCollection
Type defining a collection of sprites, one for each zoom level.
Base class that provides memory initialization on dynamically created objects.
Definition: alloc_type.hpp:86
uint32_t PaletteID
The number of the palette.
Definition: gfx_type.h:19
bool IsOpenGLVersionAtLeast(uint8_t major, uint8_t minor)
Check if the current OpenGL version is equal or higher than a given one.
Definition: opengl.cpp:207
const char * FindStringInExtensionList(const char *string, const char *substring)
Find a substring in a string made of space delimited elements.
Definition: opengl.cpp:144
SpriteColourComponent
The different colour components a sprite can have.
Dimensions (a width and height) of a rectangle in 2D.
Coordinates of a point in 2D.
Specification of a rectangle with absolute coordinates of all edges.
Definition of a common pixel in OpenTTD's realm.
Data structure describing a sprite.
Definition: spritecache.h:17
Structure to access the alpha, red, green, and blue channels from a 32 bit number.
Definition: gfx_type.h:165
ZoomLevel
All zoom levels we know.
Definition: zoom_type.h:16
@ ZOOM_LVL_END
End for iteration.
Definition: zoom_type.h:25