Flutter Linux Embedder
fl_opengl_manager.cc
Go to the documentation of this file.
1 // Copyright 2013 The Flutter Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4 
5 #include <epoxy/egl.h>
6 #include <epoxy/gl.h>
7 #include <gdk/gdkwayland.h>
8 #ifdef GDK_WINDOWING_X11
9 #include <gdk/gdkx.h>
10 #endif
11 
12 #include <cstring>
13 
15 
17  GObject parent_instance;
18 
19  // Display being rendered to.
20  EGLDisplay display;
21 
22  // Context used by the Flutter engine for rendering.
23  EGLContext render_context;
24 
25  // Context used by the Flutter engine to share resources.
26  EGLContext resource_context;
27 
28  // Context used by platform thread.
29  EGLContext platform_context;
30 };
31 
32 G_DEFINE_TYPE(FlOpenGLManager, fl_opengl_manager, G_TYPE_OBJECT)
33 
34 static void fl_opengl_manager_dispose(GObject* object) {
35  FlOpenGLManager* self = FL_OPENGL_MANAGER(object);
36 
37  eglDestroyContext(self->display, self->render_context);
38  eglDestroyContext(self->display, self->resource_context);
39  eglDestroyContext(self->display, self->platform_context);
40  eglTerminate(self->display);
41 
42  G_OBJECT_CLASS(fl_opengl_manager_parent_class)->dispose(object);
43 }
44 
45 static void fl_opengl_manager_class_init(FlOpenGLManagerClass* klass) {
46  G_OBJECT_CLASS(klass)->dispose = fl_opengl_manager_dispose;
47 }
48 
49 static void fl_opengl_manager_init(FlOpenGLManager* self) {
50  GdkDisplay* display = gdk_display_get_default();
51  if (GDK_IS_WAYLAND_DISPLAY(display)) {
52  self->display = eglGetPlatformDisplayEXT(
53  EGL_PLATFORM_WAYLAND_EXT, gdk_wayland_display_get_wl_display(display),
54  NULL);
55 #ifdef GDK_WINDOWING_X11
56  } else if (GDK_IS_X11_DISPLAY(display)) {
57  self->display = eglGetPlatformDisplayEXT(
58  EGL_PLATFORM_X11_EXT, gdk_x11_display_get_xdisplay(display), NULL);
59 #endif
60  } else {
61  g_critical("Unsupported GDK backend, unable to get EGL display");
62  }
63 
64  eglInitialize(self->display, nullptr, nullptr);
65 
66  const EGLint config_attributes[] = {EGL_RED_SIZE, 8, EGL_GREEN_SIZE, 8,
67  EGL_BLUE_SIZE, 8, EGL_ALPHA_SIZE, 8,
68  EGL_DEPTH_SIZE, 8, EGL_STENCIL_SIZE, 8,
69  EGL_NONE};
70  EGLConfig config = nullptr;
71  EGLint num_config = 0;
72  eglChooseConfig(self->display, config_attributes, &config, 1, &num_config);
73 
74  const EGLint context_attributes[] = {EGL_CONTEXT_CLIENT_VERSION, 2, EGL_NONE};
75 
76  self->render_context = eglCreateContext(self->display, config, EGL_NO_CONTEXT,
77  context_attributes);
78  if (self->render_context == EGL_NO_CONTEXT) {
79  g_warning("Failed to create EGL context for rendering");
80  }
81 
82  self->resource_context = eglCreateContext(
83  self->display, config, self->render_context, context_attributes);
84  if (self->resource_context == EGL_NO_CONTEXT) {
85  g_warning("Failed to create EGL context for resource sharing");
86  }
87 
88  self->platform_context = eglCreateContext(
89  self->display, config, self->render_context, context_attributes);
90  if (self->platform_context == EGL_NO_CONTEXT) {
91  g_warning("Failed to create EGL context for platform thread");
92  }
93 }
94 
95 FlOpenGLManager* fl_opengl_manager_new() {
96  FlOpenGLManager* self =
97  FL_OPENGL_MANAGER(g_object_new(fl_opengl_manager_get_type(), nullptr));
98  return self;
99 }
100 
101 gboolean fl_opengl_manager_make_current(FlOpenGLManager* self) {
102  return eglMakeCurrent(self->display, EGL_NO_SURFACE, EGL_NO_SURFACE,
103  self->render_context) == EGL_TRUE;
104 }
105 
106 gboolean fl_opengl_manager_make_resource_current(FlOpenGLManager* self) {
107  return eglMakeCurrent(self->display, EGL_NO_SURFACE, EGL_NO_SURFACE,
108  self->resource_context) == EGL_TRUE;
109 }
110 
111 gboolean fl_opengl_manager_make_platform_current(FlOpenGLManager* self) {
112  return eglMakeCurrent(self->display, EGL_NO_SURFACE, EGL_NO_SURFACE,
113  self->platform_context) == EGL_TRUE;
114 }
115 
116 gboolean fl_opengl_manager_clear_current(FlOpenGLManager* self) {
117  return eglMakeCurrent(self->display, EGL_NO_SURFACE, EGL_NO_SURFACE,
118  EGL_NO_CONTEXT) == EGL_TRUE;
119 }
120 
121 EGLDisplay fl_opengl_manager_get_display(FlOpenGLManager* self) {
122  return self->display;
123 }
124 
125 EGLContext fl_opengl_manager_get_context(FlOpenGLManager* self) {
126  return self->render_context;
127 }
128 
129 // Checks if the current OpenGL driver is known to have a broken or unsupported
130 // glBlitFramebuffer implementation.
131 static gboolean driver_supports_blit() {
132  const gchar* vendor = reinterpret_cast<const gchar*>(glGetString(GL_VENDOR));
133  if (vendor == nullptr) {
134  return TRUE;
135  }
136 
137  // Note: List of unsupported vendors due to issue
138  // https://github.com/flutter/flutter/issues/152099
139  const char* unsupported_vendors_exact[] = {"Vivante Corporation", "ARM"};
140  const char* unsupported_vendors_fuzzy[] = {"NVIDIA"};
141 
142  for (const char* unsupported : unsupported_vendors_fuzzy) {
143  if (strstr(vendor, unsupported) != nullptr) {
144  return FALSE;
145  }
146  }
147  for (const char* unsupported : unsupported_vendors_exact) {
148  if (strcmp(vendor, unsupported) == 0) {
149  return FALSE;
150  }
151  }
152  return TRUE;
153 }
154 
155 gboolean fl_opengl_manager_can_blit(FlOpenGLManager* self) {
156  g_return_val_if_fail(FL_IS_OPENGL_MANAGER(self), FALSE);
157 
158  // glBlitFramebuffer is a GLES3 / OpenGL 3.0 function and may not be present
159  // on older drivers, so treat it as optional. Evaluated for whichever OpenGL
160  // context is current.
161  return driver_supports_blit() &&
162  (epoxy_gl_version() >= 30 ||
163  epoxy_has_gl_extension("GL_EXT_framebuffer_blit"));
164 }
165 
166 // Checks whether @extension is supported by the EGL display the contexts are
167 // created on.
168 static gboolean has_extension(FlOpenGLManager* self, const gchar* extension) {
169  g_return_val_if_fail(FL_IS_OPENGL_MANAGER(self), FALSE);
170 
171  if (self->display == EGL_NO_DISPLAY) {
172  return FALSE;
173  }
174 
175  return epoxy_has_egl_extension(self->display, extension);
176 }
177 
178 gboolean fl_opengl_manager_can_fence(FlOpenGLManager* self) {
179  return has_extension(self, "EGL_KHR_fence_sync");
180 }
181 
182 gboolean fl_opengl_manager_can_wait_sync(FlOpenGLManager* self) {
183  return has_extension(self, "EGL_KHR_wait_sync");
184 }
G_DEFINE_TYPE(FlBasicMessageChannelResponseHandle, fl_basic_message_channel_response_handle, G_TYPE_OBJECT) static void fl_basic_message_channel_response_handle_dispose(GObject *object)
gboolean fl_opengl_manager_make_platform_current(FlOpenGLManager *self)
static void fl_opengl_manager_dispose(GObject *object)
static void fl_opengl_manager_class_init(FlOpenGLManagerClass *klass)
FlOpenGLManager * fl_opengl_manager_new()
static gboolean driver_supports_blit()
gboolean fl_opengl_manager_make_resource_current(FlOpenGLManager *self)
gboolean fl_opengl_manager_clear_current(FlOpenGLManager *self)
gboolean fl_opengl_manager_can_wait_sync(FlOpenGLManager *self)
EGLDisplay fl_opengl_manager_get_display(FlOpenGLManager *self)
gboolean fl_opengl_manager_can_blit(FlOpenGLManager *self)
gboolean fl_opengl_manager_make_current(FlOpenGLManager *self)
gboolean fl_opengl_manager_can_fence(FlOpenGLManager *self)
static void fl_opengl_manager_init(FlOpenGLManager *self)
static gboolean has_extension(FlOpenGLManager *self, const gchar *extension)
EGLContext fl_opengl_manager_get_context(FlOpenGLManager *self)
EGLContext resource_context
EGLContext platform_context
EGLContext render_context