1 #ifndef DALI_TOOLKIT_GL_VIEW_H
2 #define DALI_TOOLKIT_GL_VIEW_H
4 * Copyright (c) 2022 Samsung Electronics Co., Ltd.
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
21 #include <dali/public-api/rendering/texture.h>
24 #include <dali-toolkit/public-api/controls/control.h>
30 namespace Internal DALI_INTERNAL
36 * @brief GlView is a class for rendering with GL
38 * GlView allows drawing with OpenGL.
39 * GlView creates a GL context, a GL surface and a render thread.
40 * The render thread invokes user's callbacks.
44 class DALI_TOOLKIT_API GlView : public Dali::Toolkit::Control
48 * @brief Implementation backend mode
52 enum class BackendMode
55 * DIRECT_RENDERING mode executes GL code within DALi graphics
56 * pipeline. When Renderer is about to be drawn, the callback
57 * will be executed and the custom code "injected" into the pipeline.
58 * This allows rendering directly to the surface rather than offscreen.
65 * DIRECT_RENDERING_THREADED mode executes GL code on separate thread
66 * and then blits the result within DALi graphics commands stream.
67 * The mode is logically compatible with the EGL_IMAGE_OFFSCREEN_RENDERING.
71 DIRECT_RENDERING_THREADED,
74 * EGL_IMAGE_OFFSCREEN_RENDERING mode executes GL code in own thread
75 * and renders to the offscreen NativeImage (EGL) buffer. This backend
76 * will render in parallel but has higher memory footprint and may suffer
77 * performance issues due to using EGL image.
81 EGL_IMAGE_OFFSCREEN_RENDERING,
84 * The default mode is set to EGL_IMAGE_OFFSCREEN_RENDERING for backwards
89 DEFAULT = EGL_IMAGE_OFFSCREEN_RENDERING
93 * @brief Enumeration for rendering mode
95 * This Enumeration is used to choose the rendering mode.
97 * One of them is continuous mode. It is rendered continuously.
98 * The other is on demand mode. It is rendered by application.
102 enum class RenderingMode
104 CONTINUOUS, ///< continuous mode
105 ON_DEMAND ///< on demand by application
109 * @brief Enumeration for Graphics API version
111 * This Enumeration is used to set a GLES version for EGL configuration.
115 enum class GraphicsApiVersion
117 GLES_VERSION_2_0 = 0, ///< GLES version 2.0
118 GLES_VERSION_3_0, ///< GLES version 3.0
122 * @brief Enumeration for color buffer format
124 * This Enumeration is used to set a color buffer format of GlView
128 enum class ColorFormat
130 RGB888, ///< 8 red bits, 8 green bits, 8 blue bits
131 RGBA8888 ///< 8 red bits, 8 green bits, 8 blue bits, alpha 8 bits
135 * @brief Creates a GlView control.
137 * @note This function always creates the GlView with NativeImage backend.
139 * @param[in] colorFormat the format of the color buffer.
140 * @return A handle to a GlView control
144 static GlView New(ColorFormat colorFormat);
147 * @brief Creates a GlView control.
149 * The new GlView will be created with specified backend.
150 * The colorFormat is ignored for DIRECT_RENDERING backend.
152 * @param[in] colorFormat the format of the color buffer.
153 * @param[in] backendMode the backend used by the GlView
154 * @return A handle to a GlView control
158 static GlView New(BackendMode backendMode, ColorFormat colorFormat);
161 * @brief Creates an uninitialized GlView.
170 * This is non-virtual since derived Handle types must not contain data or virtual methods.
177 * @brief Copy constructor.
179 * @param[in] GlView GlView to copy. The copied GlView will point at the same implementation
183 GlView(const GlView& GlView);
186 * @brief Move constructor
188 * @param[in] rhs A reference to the moved handle
192 GlView(GlView&& rhs) noexcept;
195 * @brief Assignment operator.
197 * @param[in] GlView The GlView to assign from
198 * @return A reference to this
202 GlView& operator=(const GlView& GlView);
205 * @brief Move assignment
207 * @param[in] rhs A reference to the moved handle
208 * @return A reference to this
212 GlView& operator=(GlView&& rhs) noexcept;
215 * @brief Downcasts a handle to GlView handle.
217 * If handle points to a GlView, the downcast produces valid handle.
218 * If not, the returned handle is left uninitialized.
220 * @param[in] handle Handle to an object
221 * @return Handle to a GlView or an uninitialized handle
225 static GlView DownCast(BaseHandle handle);
228 * @brief Registers GL callback functions for GlView.
230 * @param[in] initCallback the callback function to create GL resources.
231 * @param[in] renderFrameCallback the callback function to render for the frame.
232 * @param[in] terminateCallback the callback function to clean-up GL resources.
234 * A initCallback of the following type have to be used:
236 * void intializeGL();
238 * This callback will be called before renderFrame callback is called once.
240 * A renderFrameCallback of the following type have to be used:
242 * int renderFrameGL();
244 * If the return value of this callback is not 0, the eglSwapBuffers() will be called.
246 * A terminateCallback of the following type have to be used:
248 * void terminateGL();
250 * This callback is called when GlView is deleted.
252 * @note Ownership of the callbacks is passed onto this class.
253 * <b>You can't call Dali APIs in your callbacks because it is invoked in GlView's own render thread.</b>
254 * And this must be called before adding GlView to the scene.
258 void RegisterGlCallbacks(CallbackBase* initCallback, CallbackBase* renderFrameCallback, CallbackBase* terminateCallback);
261 * @brief Sets the ResizeCallback of the GlView.
262 * When GlView is resized, ResizeCallback would be invoked.
263 * You can get the resized width and height of the GlView.
265 * @param[in] resizeCallback The ResizeCallback function
267 * A resizeCallback of the following type have to be used:
269 * void resizeCallback(int width, int height);
272 * @note Ownership of the callback is passed onto this class.
273 * <b>You can't call Dali APIs in your callback because it is invoked in GlView's own render thread.</b>
274 * And this must be called before adding GlView to the scene.
278 void SetResizeCallback(CallbackBase* resizeCallback);
281 * @brief Sets the rendering mode.
283 * @param[in] mode the rendering mode for GlView
285 * @note The default Rendering mode is CONTINUOUS.
286 * If ON_DEMAND mode is set, it is rendered by RenderOnce()
290 void SetRenderingMode(RenderingMode mode);
293 * @brief Gets the rendering mode.
297 [[nodiscard]] RenderingMode GetRenderingMode() const;
300 * @brief Gets the backend mode.
304 [[nodiscard]] BackendMode GetBackendMode() const;
307 * @brief Sets egl configuration for GlView
309 * @param[in] depth the flag of depth buffer. If the value is true, 24bit depth buffer is enabled.
310 * @param[in] stencil the flag of stencil. If the value is true, 8bit stencil buffer is enabled.
311 * @param[in] msaa the expected sampling number per pixel.
312 * @param[in] version the graphics API version
313 * @return True if the config exists, false otherwise.
317 bool SetGraphicsConfig(bool depth, bool stencil, int msaa, GraphicsApiVersion version);
320 * @brief Renders once more even if GL render functions are not added to idler.
321 * @note Will not work if the window is hidden or GL render functions are added to idler
328 * @brief Binds DALi textures to the callback
330 * The textures that are bound to the callback will be passed upon
331 * callback execution providing native handles (like GL name) so they
332 * can be used alongside with custom GL code.
334 * Binding texture does not affect lifecycle and it's up to the client-side
335 * to make sure the resource is alive when used inside the callback.
337 * @param[in] textures List of DALi textures to be bound to the callback
339 * @note It only supported only in the GlView::BackendMode::DIRECT_RENDERING.
343 void BindTextureResources(std::vector<Dali::Texture> textures);
345 public: // Not intended for application developers
348 * @brief Creates a handle using the Toolkit::Internal implementation.
349 * @param[in] implementation The GlView implementation
353 DALI_INTERNAL GlView(Internal::GlViewImpl& implementation);
356 * @brief Allows the creation of this GlView from an Internal::CustomActor pointer.
357 * @param[in] internal A pointer to the internal CustomActor
361 DALI_INTERNAL GlView(Dali::Internal::CustomActor* internal);
365 } // namespace Toolkit
369 #endif // DALI_TOOLKIT_GL_VIEW_H