Flutter Linux Embedder
fl_gl_fence.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 "fl_gl_fence.h"
6 
7 #include <epoxy/egl.h>
8 #include <epoxy/gl.h>
9 
10 // How long to wait for a fence before giving up on it. Reaching this means the
11 // driver has taken an unreasonable amount of time to render a frame; carry on
12 // and use the frame rather than blocking the thread indefinitely.
13 static constexpr EGLTimeKHR kFenceTimeoutNanoseconds = 1000000000; // 1s
14 
15 struct _FlGLFence {
16  GObject parent_instance;
17 
18  // Display [sync] was created on, stored so the fence can be destroyed without
19  // a context being current.
20  EGLDisplay display;
21 
22  EGLSyncKHR sync;
23 
24  // TRUE if OpenGL can wait for the fence, i.e. without blocking this thread.
25  gboolean can_wait_sync;
26 };
27 
28 G_DEFINE_TYPE(FlGLFence, fl_gl_fence, G_TYPE_OBJECT)
29 
30 static void fl_gl_fence_dispose(GObject* object) {
31  FlGLFence* self = FL_GL_FENCE(object);
32 
33  if (self->sync != EGL_NO_SYNC_KHR) {
34  eglDestroySyncKHR(self->display, self->sync);
35  self->sync = EGL_NO_SYNC_KHR;
36  }
37 
38  G_OBJECT_CLASS(fl_gl_fence_parent_class)->dispose(object);
39 }
40 
41 static void fl_gl_fence_class_init(FlGLFenceClass* klass) {
42  G_OBJECT_CLASS(klass)->dispose = fl_gl_fence_dispose;
43 }
44 
45 static void fl_gl_fence_init(FlGLFence* self) {
46  self->display = EGL_NO_DISPLAY;
47  self->sync = EGL_NO_SYNC_KHR;
48 }
49 
50 FlGLFence* fl_gl_fence_new(FlOpenGLManager* opengl_manager) {
51  g_return_val_if_fail(FL_IS_OPENGL_MANAGER(opengl_manager), nullptr);
52 
53  FlGLFence* self = FL_GL_FENCE(g_object_new(fl_gl_fence_get_type(), nullptr));
54 
55  EGLDisplay display = fl_opengl_manager_get_display(opengl_manager);
56  EGLSyncKHR sync = eglCreateSyncKHR(display, EGL_SYNC_FENCE_KHR, nullptr);
57  // Creating a fence only adds it to the command stream; the commands have to
58  // be flushed for it to be reached, otherwise waiting on it can never return.
59  glFlush();
60  if (sync == EGL_NO_SYNC_KHR) {
61  g_warning("Failed to create fence");
62  return self;
63  }
64 
65  self->display = display;
66  self->sync = sync;
67  self->can_wait_sync = fl_opengl_manager_can_wait_sync(opengl_manager);
68 
69  return self;
70 }
71 
72 // Blocks the calling thread until the fence is reached.
73 static void client_wait(FlGLFence* self) {
74  // The commands were flushed when the fence was created, so they don't need to
75  // be flushed again here. Flushing wouldn't work anyway, as that only applies
76  // to a fence created in the context current on this thread.
77  EGLint result = eglClientWaitSyncKHR(self->display, self->sync, 0,
79  if (result == EGL_TIMEOUT_EXPIRED_KHR) {
80  g_warning("Timed out waiting for OpenGL rendering to complete");
81  }
82 }
83 
84 void fl_gl_fence_wait(FlGLFence* self) {
85  g_return_if_fail(FL_IS_GL_FENCE(self));
86 
87  // Nothing to wait for if the fence couldn't be created.
88  if (self->sync == EGL_NO_SYNC_KHR) {
89  return;
90  }
91 
92  if (!self->can_wait_sync) {
93  client_wait(self);
94  return;
95  }
96 
97  eglWaitSyncKHR(self->display, self->sync, 0);
98 }
G_DEFINE_TYPE(FlBasicMessageChannelResponseHandle, fl_basic_message_channel_response_handle, G_TYPE_OBJECT) static void fl_basic_message_channel_response_handle_dispose(GObject *object)
static constexpr EGLTimeKHR kFenceTimeoutNanoseconds
Definition: fl_gl_fence.cc:13
FlGLFence * fl_gl_fence_new(FlOpenGLManager *opengl_manager)
Definition: fl_gl_fence.cc:50
static void fl_gl_fence_init(FlGLFence *self)
Definition: fl_gl_fence.cc:45
void fl_gl_fence_wait(FlGLFence *self)
Definition: fl_gl_fence.cc:84
static void fl_gl_fence_dispose(GObject *object)
Definition: fl_gl_fence.cc:30
static void client_wait(FlGLFence *self)
Definition: fl_gl_fence.cc:73
static void fl_gl_fence_class_init(FlGLFenceClass *klass)
Definition: fl_gl_fence.cc:41
gboolean fl_opengl_manager_can_wait_sync(FlOpenGLManager *self)
EGLDisplay fl_opengl_manager_get_display(FlOpenGLManager *self)
EGLDisplay display
Definition: fl_gl_fence.cc:20
gboolean can_wait_sync
Definition: fl_gl_fence.cc:25
GObject parent_instance
Definition: fl_gl_fence.cc:16
EGLSyncKHR sync
Definition: fl_gl_fence.cc:22