2014-10-09 08:45:44 +00:00
|
|
|
/* GDK - The GIMP Drawing Kit
|
|
|
|
*
|
|
|
|
* gdkglcontextprivate.h: GL context abstraction
|
2020-07-24 16:54:23 +00:00
|
|
|
*
|
2014-10-09 08:45:44 +00:00
|
|
|
* Copyright © 2014 Emmanuele Bassi
|
|
|
|
*
|
|
|
|
* This library is free software; you can redistribute it and/or
|
|
|
|
* modify it under the terms of the GNU Library General Public
|
|
|
|
* License as published by the Free Software Foundation; either
|
|
|
|
* version 2 of the License, or (at your option) any later version.
|
|
|
|
*
|
|
|
|
* This library 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. See the GNU
|
|
|
|
* Library General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU Library General Public
|
|
|
|
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
*/
|
|
|
|
|
2023-03-31 19:11:10 +00:00
|
|
|
#pragma once
|
2014-10-09 08:45:44 +00:00
|
|
|
|
|
|
|
#include "gdkglcontext.h"
|
2016-11-28 16:36:37 +00:00
|
|
|
#include "gdkdrawcontextprivate.h"
|
2023-04-25 17:17:07 +00:00
|
|
|
#include "gdkglversionprivate.h"
|
2023-10-15 23:27:22 +00:00
|
|
|
#include "gdkdmabufprivate.h"
|
2014-10-09 08:45:44 +00:00
|
|
|
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
|
2024-03-16 10:31:17 +00:00
|
|
|
typedef enum {
|
|
|
|
GDK_GL_FEATURE_DEBUG = 1 << 0,
|
2024-09-26 15:39:31 +00:00
|
|
|
GDK_GL_FEATURE_BASE_INSTANCE = 1 << 1,
|
|
|
|
GDK_GL_FEATURE_BUFFER_STORAGE = 1 << 2,
|
2024-03-16 10:31:17 +00:00
|
|
|
} GdkGLFeatures;
|
|
|
|
|
2021-09-23 23:47:03 +00:00
|
|
|
typedef enum {
|
|
|
|
GDK_GL_NONE = 0,
|
|
|
|
GDK_GL_EGL,
|
|
|
|
GDK_GL_GLX,
|
|
|
|
GDK_GL_WGL,
|
|
|
|
GDK_GL_CGL
|
|
|
|
} GdkGLBackend;
|
|
|
|
|
2023-12-07 04:45:59 +00:00
|
|
|
typedef enum {
|
|
|
|
/* The format is supported for glTexImage2D() */
|
|
|
|
GDK_GL_FORMAT_USABLE = 1 << 0,
|
|
|
|
/* The format can be rendered to.
|
|
|
|
* GL/GLES spec term: "color-renderable" */
|
|
|
|
GDK_GL_FORMAT_RENDERABLE = 1 << 1,
|
|
|
|
/* GL_LINEAR/GL_MIPMAP_LINEAR can be used for textures in this format.
|
|
|
|
* GLES spec term: "texture-filterable" */
|
|
|
|
GDK_GL_FORMAT_FILTERABLE = 1 << 2
|
|
|
|
} GdkGLMemoryFlags;
|
|
|
|
|
2023-05-24 19:40:20 +00:00
|
|
|
/* The maximum amount of buffers we track update regions for.
|
|
|
|
* Note that this is equal to the max buffer age value we
|
|
|
|
* can provide a damage region for */
|
2023-05-24 19:41:47 +00:00
|
|
|
#define GDK_GL_MAX_TRACKED_BUFFERS 4
|
2023-05-24 19:40:20 +00:00
|
|
|
|
2014-10-09 08:45:44 +00:00
|
|
|
#define GDK_GL_CONTEXT_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GDK_TYPE_GL_CONTEXT, GdkGLContextClass))
|
|
|
|
#define GDK_IS_GL_CONTEXT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GDK_TYPE_GL_CONTEXT))
|
|
|
|
#define GDK_GL_CONTEXT_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GDK_TYPE_GL_CONTEXT, GdkGLContextClass))
|
|
|
|
|
|
|
|
typedef struct _GdkGLContextClass GdkGLContextClass;
|
|
|
|
|
|
|
|
struct _GdkGLContext
|
|
|
|
{
|
2016-11-28 16:36:37 +00:00
|
|
|
GdkDrawContext parent_instance;
|
2018-04-08 22:58:31 +00:00
|
|
|
|
|
|
|
/* We store the old drawn areas to support buffer-age optimizations */
|
2023-05-24 19:40:20 +00:00
|
|
|
cairo_region_t *old_updated_area[GDK_GL_MAX_TRACKED_BUFFERS];
|
2014-10-09 08:45:44 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
struct _GdkGLContextClass
|
|
|
|
{
|
2016-11-28 16:36:37 +00:00
|
|
|
GdkDrawContextClass parent_class;
|
2014-10-09 08:45:44 +00:00
|
|
|
|
2021-09-23 23:47:03 +00:00
|
|
|
GdkGLBackend backend_type;
|
|
|
|
|
2021-10-07 20:10:39 +00:00
|
|
|
GdkGLAPI (* realize) (GdkGLContext *context,
|
2021-06-30 02:52:35 +00:00
|
|
|
GError **error);
|
GL: Split GL context creation in two phases
One of the major requests by OpenGL users has been the ability to
specify settings when creating a GL context, like the version to use
or whether the debug support should be enabled.
We have a couple of requirements in terms of API:
• avoid, if at all possible, the "C arrays of integers with
attribute, value pairs", which are hard to write and hard
to bind in non-C languages.
• allow failing in a recoverable way.
• do not make the GL context creation API a mess of arguments.
Looking at prior art, it seems that a common pattern is to split the
construction phase in two:
• a first phase that creates a GL context wrapper object and
does preliminary checks on the environment.
• a second phase that creates the backend-specific GL object.
We adopted a similar pattern:
• gdk_window_create_gl_context() creates a GdkGLContext
• gdk_gl_context_realize() creates the underlying resources
Calling gdk_gl_context_make_current() also realizes the context, so
simple GL users do not need to care. Advanced users will want to
call gdk_window_create_gl_context(), set up the optional requirements,
and then call gdk_gl_context_realize(). If either of these two steps
fails, it's possible to recover by changing the requirements, or simply
creating a new GdkGLContext instance.
https://bugzilla.gnome.org/show_bug.cgi?id=741946
2015-01-27 21:23:23 +00:00
|
|
|
|
2021-07-07 02:40:34 +00:00
|
|
|
gboolean (* make_current) (GdkGLContext *context,
|
|
|
|
gboolean surfaceless);
|
|
|
|
gboolean (* clear_current) (GdkGLContext *context);
|
2023-02-02 01:49:56 +00:00
|
|
|
gboolean (* is_current) (GdkGLContext *context);
|
2021-06-30 02:52:35 +00:00
|
|
|
cairo_region_t * (* get_damage) (GdkGLContext *context);
|
|
|
|
|
|
|
|
gboolean (* is_shared) (GdkGLContext *self,
|
|
|
|
GdkGLContext *other);
|
2022-02-11 05:51:15 +00:00
|
|
|
|
|
|
|
guint (* get_default_framebuffer) (GdkGLContext *self);
|
2014-10-09 08:45:44 +00:00
|
|
|
};
|
|
|
|
|
2014-11-22 17:29:27 +00:00
|
|
|
typedef struct {
|
|
|
|
guint program;
|
|
|
|
guint position_location;
|
|
|
|
guint uv_location;
|
|
|
|
guint map_location;
|
2016-04-25 12:38:22 +00:00
|
|
|
guint flip_location;
|
2014-11-22 17:29:27 +00:00
|
|
|
} GdkGLContextProgram;
|
|
|
|
|
2014-11-05 14:19:00 +00:00
|
|
|
typedef struct {
|
|
|
|
guint tmp_framebuffer;
|
2014-11-06 08:13:36 +00:00
|
|
|
guint tmp_vertex_buffer;
|
2014-11-22 17:29:27 +00:00
|
|
|
|
|
|
|
GdkGLContextProgram texture_2d_quad_program;
|
|
|
|
GdkGLContextProgram texture_rect_quad_program;
|
|
|
|
|
|
|
|
GdkGLContextProgram *current_program;
|
2015-10-06 18:55:07 +00:00
|
|
|
|
|
|
|
guint is_legacy : 1;
|
2016-04-18 09:10:30 +00:00
|
|
|
guint use_es : 1;
|
2014-11-05 14:19:00 +00:00
|
|
|
} GdkGLContextPaintData;
|
|
|
|
|
2021-09-23 23:47:03 +00:00
|
|
|
gboolean gdk_gl_backend_can_be_used (GdkGLBackend backend_type,
|
|
|
|
GError **error);
|
|
|
|
void gdk_gl_backend_use (GdkGLBackend backend_type);
|
|
|
|
|
2024-08-28 23:20:25 +00:00
|
|
|
GdkGLContext * gdk_gl_context_clear_current_if_surface (GdkSurface *surface) G_GNUC_WARN_UNUSED_RESULT;
|
2021-12-22 18:49:13 +00:00
|
|
|
|
2024-08-09 02:32:47 +00:00
|
|
|
GdkGLContext * gdk_gl_context_new (GdkDisplay *display,
|
|
|
|
GdkSurface *surface,
|
|
|
|
gboolean surface_attached);
|
2021-07-09 00:50:32 +00:00
|
|
|
|
2023-04-25 18:08:33 +00:00
|
|
|
gboolean gdk_gl_context_is_api_allowed (GdkGLContext *self,
|
|
|
|
GdkGLAPI api,
|
|
|
|
GError **error);
|
|
|
|
void gdk_gl_context_set_version (GdkGLContext *context,
|
|
|
|
const GdkGLVersion *version);
|
|
|
|
void gdk_gl_context_set_is_legacy (GdkGLContext *context,
|
|
|
|
gboolean is_legacy);
|
2024-09-25 00:36:22 +00:00
|
|
|
gboolean gdk_gl_context_check_gl_version (GdkGLContext *self,
|
2023-04-25 17:32:12 +00:00
|
|
|
const GdkGLVersion *gl_version,
|
|
|
|
const GdkGLVersion *gles_version);
|
|
|
|
|
|
|
|
static inline gboolean
|
2024-09-25 00:36:22 +00:00
|
|
|
gdk_gl_context_check_version (GdkGLContext *self,
|
2023-04-25 17:32:12 +00:00
|
|
|
const char *gl_version,
|
|
|
|
const char *gles_version)
|
|
|
|
{
|
2024-09-25 00:36:22 +00:00
|
|
|
return gdk_gl_context_check_gl_version (self,
|
2023-04-25 17:32:12 +00:00
|
|
|
gl_version ? &GDK_GL_VERSION_STRING (gl_version) : NULL,
|
|
|
|
gles_version ? &GDK_GL_VERSION_STRING (gles_version) : NULL);
|
|
|
|
}
|
2015-10-06 17:54:58 +00:00
|
|
|
|
2023-04-25 19:45:31 +00:00
|
|
|
void gdk_gl_context_get_matching_version (GdkGLContext *context,
|
|
|
|
GdkGLAPI api,
|
2023-04-25 17:17:07 +00:00
|
|
|
gboolean legacy,
|
|
|
|
GdkGLVersion *out_version);
|
2021-10-12 13:04:43 +00:00
|
|
|
|
2019-04-24 11:25:46 +00:00
|
|
|
void gdk_gl_context_push_debug_group (GdkGLContext *context,
|
|
|
|
const char *message);
|
|
|
|
void gdk_gl_context_push_debug_group_printf (GdkGLContext *context,
|
2020-07-24 18:40:36 +00:00
|
|
|
const char *format,
|
2019-04-24 11:25:46 +00:00
|
|
|
...) G_GNUC_PRINTF (2, 3);
|
|
|
|
void gdk_gl_context_pop_debug_group (GdkGLContext *context);
|
|
|
|
void gdk_gl_context_label_object (GdkGLContext *context,
|
|
|
|
guint identifier,
|
|
|
|
guint name,
|
|
|
|
const char *label);
|
|
|
|
void gdk_gl_context_label_object_printf (GdkGLContext *context,
|
|
|
|
guint identifier,
|
|
|
|
guint name,
|
|
|
|
const char *format,
|
|
|
|
...) G_GNUC_PRINTF (4, 5);
|
2020-07-24 16:54:23 +00:00
|
|
|
|
2023-08-29 10:59:26 +00:00
|
|
|
const char * gdk_gl_context_get_glsl_version_string (GdkGLContext *self);
|
|
|
|
|
2023-12-07 04:45:59 +00:00
|
|
|
GdkGLMemoryFlags gdk_gl_context_get_format_flags (GdkGLContext *self,
|
|
|
|
GdkMemoryFormat format) G_GNUC_PURE;
|
2024-03-16 10:31:17 +00:00
|
|
|
gboolean gdk_gl_context_has_feature (GdkGLContext *self,
|
|
|
|
GdkGLFeatures feature) G_GNUC_PURE;
|
2018-07-31 10:18:59 +00:00
|
|
|
|
|
|
|
gboolean gdk_gl_context_use_es_bgra (GdkGLContext *context);
|
|
|
|
|
2023-10-20 00:56:59 +00:00
|
|
|
gboolean gdk_gl_context_has_vertex_arrays (GdkGLContext *self) G_GNUC_PURE;
|
|
|
|
|
2023-04-02 14:24:37 +00:00
|
|
|
double gdk_gl_context_get_scale (GdkGLContext *self);
|
|
|
|
|
2024-09-25 01:08:19 +00:00
|
|
|
void gdk_gl_context_download (GdkGLContext *self,
|
|
|
|
GLuint tex_id,
|
|
|
|
GdkMemoryFormat tex_format,
|
|
|
|
GdkColorState *tex_color_state,
|
|
|
|
guchar *dest_data,
|
|
|
|
gsize dest_stride,
|
|
|
|
GdkMemoryFormat dest_format,
|
|
|
|
GdkColorState *dest_color_state,
|
|
|
|
gsize width,
|
|
|
|
gsize height);
|
|
|
|
|
2023-10-15 23:27:22 +00:00
|
|
|
guint gdk_gl_context_import_dmabuf (GdkGLContext *self,
|
|
|
|
int width,
|
|
|
|
int height,
|
|
|
|
const GdkDmabuf *dmabuf,
|
2023-11-02 01:51:41 +00:00
|
|
|
gboolean *external);
|
2023-10-15 23:27:22 +00:00
|
|
|
|
|
|
|
gboolean gdk_gl_context_export_dmabuf (GdkGLContext *self,
|
|
|
|
unsigned int texture_id,
|
|
|
|
GdkDmabuf *dmabuf);
|
2014-10-09 08:45:44 +00:00
|
|
|
|
2023-10-15 23:27:22 +00:00
|
|
|
G_END_DECLS
|