Flutter Linux Embedder
fl_opengl_manager.h
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 #ifndef FLUTTER_SHELL_PLATFORM_LINUX_FL_OPENGL_MANAGER_H_
6 #define FLUTTER_SHELL_PLATFORM_LINUX_FL_OPENGL_MANAGER_H_
7 
8 // Avoid pulling in X11 headers (via <epoxy/egl.h>), which define `None` and
9 // `Bool` as macros that collide with googletest in transitively-including test
10 // translation units. EGLDisplay/EGLContext are platform-independent handles.
11 #define EGL_NO_X11
12 #include <epoxy/egl.h>
13 #include <glib-object.h>
14 
15 G_BEGIN_DECLS
16 
17 G_DECLARE_FINAL_TYPE(FlOpenGLManager,
18  fl_opengl_manager,
19  FL,
20  OPENGL_MANAGER,
21  GObject)
22 
23 /**
24  * fl_opengl_manager_new:
25  *
26  * Creates an object that allows Flutter to render by OpenGL ES.
27  *
28  * Returns: a new #FlOpenGLManager.
29  */
30 FlOpenGLManager* fl_opengl_manager_new();
31 
32 /**
33  * fl_opengl_manager_make_current:
34  * @manager: an #FlOpenGLManager.
35  *
36  * Makes the rendering context current.
37  *
38  * Returns: %TRUE if the context made current.
39  */
40 gboolean fl_opengl_manager_make_current(FlOpenGLManager* manager);
41 
42 /**
43  * fl_opengl_manager_make_resource_current:
44  * @manager: an #FlOpenGLManager.
45  *
46  * Makes the resource rendering context current.
47  *
48  * Returns: %TRUE if the context made current.
49  */
50 gboolean fl_opengl_manager_make_resource_current(FlOpenGLManager* manager);
51 
52 /**
53  * fl_opengl_manager_make_platform_current:
54  * @manager: an #FlOpenGLManager.
55  *
56  * Makes the platform rendering context current.
57  *
58  * Returns: %TRUE if the context made current.
59  */
60 gboolean fl_opengl_manager_make_platform_current(FlOpenGLManager* manager);
61 
62 /**
63  * fl_opengl_manager_clear_current:
64  * @manager: an #FlOpenGLManager.
65  *
66  * Clears the current rendering context.
67  *
68  * Returns: %TRUE if the context cleared.
69  */
70 gboolean fl_opengl_manager_clear_current(FlOpenGLManager* manager);
71 
72 /**
73  * fl_opengl_manager_get_display:
74  * @manager: an #FlOpenGLManager.
75  *
76  * Gets the EGL display the engine renders to. This can be used to create
77  * additional EGL contexts that share resources with the engine.
78  *
79  * Returns: an %EGLDisplay.
80  */
81 EGLDisplay fl_opengl_manager_get_display(FlOpenGLManager* manager);
82 
83 /**
84  * fl_opengl_manager_get_context:
85  * @manager: an #FlOpenGLManager.
86  *
87  * Gets the EGL context the engine renders with. This can be used as a share
88  * context when creating additional EGL contexts so they can access textures
89  * rendered by the engine directly (without using EGLImage).
90  *
91  * Returns: an %EGLContext.
92  */
93 EGLContext fl_opengl_manager_get_context(FlOpenGLManager* manager);
94 
95 /**
96  * fl_opengl_manager_can_blit:
97  * @manager: an #FlOpenGLManager.
98  *
99  * Checks whether glBlitFramebuffer can be used on the currently current OpenGL
100  * context. glBlitFramebuffer is a GLES3 / OpenGL 3.0 function that may be
101  * missing or broken on some drivers, so callers should fall back to shader
102  * compositing when this returns %FALSE. Requires an OpenGL context to be
103  * current.
104  *
105  * Returns: %TRUE if glBlitFramebuffer is available.
106  */
107 gboolean fl_opengl_manager_can_blit(FlOpenGLManager* manager);
108 
109 /**
110  * fl_opengl_manager_can_fence:
111  * @manager: an #FlOpenGLManager.
112  *
113  * Checks whether fences can be used to synchronize rendering between OpenGL
114  * contexts. Fences are an extension that may be missing on some drivers, so
115  * callers should fall back to waiting for the rendering to complete, e.g. with
116  * glFinish(), when this returns %FALSE.
117  *
118  * Returns: %TRUE if fences are available.
119  */
120 gboolean fl_opengl_manager_can_fence(FlOpenGLManager* manager);
121 
122 /**
123  * fl_opengl_manager_can_wait_sync:
124  * @manager: an #FlOpenGLManager.
125  *
126  * Checks whether a fence can be waited for by the GPU, i.e. without blocking
127  * the thread doing the waiting. This is an extension that may be missing on
128  * some drivers, so callers should fall back to blocking when this returns
129  * %FALSE.
130  *
131  * Returns: %TRUE if fences can be waited for without blocking.
132  */
133 gboolean fl_opengl_manager_can_wait_sync(FlOpenGLManager* manager);
134 
135 G_END_DECLS
136 
137 #endif // FLUTTER_SHELL_PLATFORM_LINUX_FL_OPENGL_MANAGER_H_
FlOpenGLManager * fl_opengl_manager_new()
EGLDisplay fl_opengl_manager_get_display(FlOpenGLManager *manager)
gboolean fl_opengl_manager_can_fence(FlOpenGLManager *manager)
EGLContext fl_opengl_manager_get_context(FlOpenGLManager *manager)
gboolean fl_opengl_manager_make_current(FlOpenGLManager *manager)
gboolean fl_opengl_manager_clear_current(FlOpenGLManager *manager)
gboolean fl_opengl_manager_make_platform_current(FlOpenGLManager *manager)
gboolean fl_opengl_manager_make_resource_current(FlOpenGLManager *manager)
gboolean fl_opengl_manager_can_blit(FlOpenGLManager *manager)
G_BEGIN_DECLS G_DECLARE_FINAL_TYPE(FlOpenGLManager, fl_opengl_manager, FL, OPENGL_MANAGER, GObject) FlOpenGLManager *fl_opengl_manager_new()
gboolean fl_opengl_manager_can_wait_sync(FlOpenGLManager *manager)