1 #ifndef DALI_INTEGRATION_CORE_H
2 #define DALI_INTEGRATION_CORE_H
5 * Copyright (c) 2020 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
22 #include <cstdint> // uint32_t
25 #include <dali/public-api/common/dali-common.h>
26 #include <dali/integration-api/context-notifier.h>
27 #include <dali/integration-api/core-enumerations.h>
44 class GlSyncAbstraction;
45 class GlContextHelperAbstraction;
46 class PlatformAbstraction;
48 class RenderController;
55 * The reasons why further updates are required.
57 namespace KeepUpdating
61 NOT_REQUESTED = 0, ///< Zero means that no further updates are required
62 STAGE_KEEP_RENDERING = 1<<1, ///< - Stage::KeepRendering() is being used
63 ANIMATIONS_RUNNING = 1<<2, ///< - Animations are ongoing
64 MONITORING_PERFORMANCE = 1<<3, ///< - The --enable-performance-monitor option is being used
65 RENDER_TASK_SYNC = 1<<4 ///< - A render task is waiting for render sync
70 * The status of the Core::Update operation.
80 : keepUpdating(false),
81 needsNotification(false),
82 surfaceRectChanged(false),
83 secondsFromLastFrame( 0.0f )
90 * Query whether the Core has further frames to update & render e.g. when animations are ongoing.
91 * @return A bitmask of KeepUpdating values
93 uint32_t KeepUpdating() { return keepUpdating; }
96 * Query whether the Core requires an Notification event.
97 * This should be sent through the same mechanism (e.g. event loop) as input events.
98 * @return True if an Notification event should be sent.
100 bool NeedsNotification() { return needsNotification; }
103 * Query wheter the default surface rect is changed or not.
104 * @return true if the default surface rect is changed.
106 bool SurfaceRectChanged() { return surfaceRectChanged; }
109 * This method is provided so that FPS can be easily calculated with a release version
111 * @return the seconds from last frame as float
113 float SecondsFromLastFrame() { return secondsFromLastFrame; }
117 uint32_t keepUpdating; ///< A bitmask of KeepUpdating values
118 bool needsNotification;
119 bool surfaceRectChanged;
120 float secondsFromLastFrame;
124 * The status of the Core::Render operation.
134 : needsUpdate( false ),
135 needsPostRender( false )
140 * Set whether update needs to run following a render.
141 * @param[in] updateRequired Set to true if an update is required to be run
143 void SetNeedsUpdate( bool updateRequired )
145 needsUpdate = updateRequired;
149 * Query the update status following rendering of a frame.
150 * @return True if update is required to be run
152 bool NeedsUpdate() const
158 * Sets if a post-render should be run.
159 * If nothing is rendered this frame, we can skip post-render.
160 * @param[in] postRenderRequired Set to True if post-render is required to be run
162 void SetNeedsPostRender( bool postRenderRequired )
164 needsPostRender = postRenderRequired;
168 * Queries if a post-render should be run.
169 * @return True if post-render is required to be run
171 bool NeedsPostRender() const
173 return needsPostRender;
178 bool needsUpdate :1; ///< True if update is required to be run
179 bool needsPostRender :1; ///< True if post-render is required to be run.
184 * Integration::Core is used for integration with the native windowing system.
185 * The following integration tasks must be completed:
187 * 1) Handle GL context creation, and notify the Core when this occurs.
189 * 2) Provide suspend/resume behaviour (see below for more details).
191 * 3) Run an event loop, for passing events to the Core e.g. multi-touch input events.
192 * Notification events should be sent after a frame is updated (see UpdateStatus).
194 * 4) Run a rendering loop, instructing the Core to render each frame.
195 * A separate rendering thread is recommended; see multi-threading options below.
197 * 5) Provide an implementation of the PlatformAbstraction interface, used to access platform specific services.
199 * 6) Provide an implementation of the GlAbstraction interface, used to access OpenGL services.
201 * Multi-threading notes:
203 * The Dali API methods are not reentrant. If you access the API from multiple threads simultaneously, then the results
204 * are undefined. This means that your application might segfault, or behave unpredictably.
206 * Rendering strategies:
208 * 1) Single-threaded. Call every Core method from the same thread. Event handling and rendering will occur in the same thread.
209 * This is not recommended, since processing input (slowly) can affect the smooth flow of animations.
211 * 2) Multi-threaded. The Core update & render operations can be processed in separate threads.
212 * See the method descriptions in Core to see which thread they should be called from.
213 * This is the recommended option, so that input processing will not affect the smoothness of animations.
214 * Note that the rendering thread must be halted, before destroying the GL context.
216 class DALI_CORE_API Core
222 * This object is used for integration with the native windowing system.
223 * @param[in] renderController The interface to an object which controls rendering.
224 * @param[in] platformAbstraction The interface providing platform specific services.
225 * @param[in] glAbstraction The interface providing OpenGL services.
226 * @param[in] glSyncAbstraction The interface providing OpenGL sync objects.
227 * @param[in] glContextHelperAbstraction The interface providing OpenGL context helper objects.
228 * @param[in] renderToFboEnabled Whether rendering into the Frame Buffer Object is enabled.
229 * @param[in] depthBufferAvailable Whether the depth buffer is available
230 * @param[in] stencilBufferAvailable Whether the stencil buffer is available
231 * @return A newly allocated Core.
233 static Core* New( RenderController& renderController,
234 PlatformAbstraction& platformAbstraction,
235 GlAbstraction& glAbstraction,
236 GlSyncAbstraction& glSyncAbstraction,
237 GlContextHelperAbstraction& glContextHelperAbstraction,
238 RenderToFrameBuffer renderToFboEnabled,
239 DepthBufferAvailable depthBufferAvailable,
240 StencilBufferAvailable stencilBufferAvailable );
243 * Non-virtual destructor. Core is not intended as a base class.
248 * Initialize the core
252 // GL Context Lifecycle
255 * Get the object that will notify the application/toolkit when context is lost/regained
257 ContextNotifierInterface* GetContextNotifier();
260 * Notify the Core that the GL context has been created.
261 * The context must be created before the Core can render.
262 * Multi-threading note: this method should be called from the rendering thread only
263 * @post The Core is aware of the GL context.
265 void ContextCreated();
268 * Notify the Core that that GL context is about to be destroyed.
269 * The Core will free any previously allocated GL resources.
270 * Multi-threading note: this method should be called from the rendering thread only
271 * @post The Core is unaware of any GL context.
273 void ContextDestroyed();
276 * Notify the Core that the GL context has been re-created, e.g. after ReplaceSurface
279 * In the case of ReplaceSurface, both ContextToBeDestroyed() and ContextCreated() will have
280 * been called on the render thread before this is called on the event thread.
282 * Multi-threading note: this method should be called from the main thread
284 void RecoverFromContextLoss();
289 * Notify Core that the scene has been created.
294 * Queue an event with Core.
295 * Pre-processing of events may be beneficial e.g. a series of motion events could be throttled, so that only the last event is queued.
296 * Multi-threading note: this method should be called from the main thread.
297 * @param[in] event The new event.
299 void QueueEvent(const Event& event);
302 * Process the events queued with QueueEvent().
303 * Multi-threading note: this method should be called from the main thread.
304 * @pre ProcessEvents should not be called during ProcessEvents.
306 void ProcessEvents();
309 * The Core::Update() method prepares a frame for rendering. This method determines how many frames
310 * may be prepared, ahead of the rendering.
311 * For example if the maximum update count is 2, then Core::Update() for frame N+1 may be processed
312 * whilst frame N is being rendered. However the Core::Update() for frame N+2 may not be called, until
313 * the Core::Render() method for frame N has returned.
314 * @return The maximum update count (>= 1).
316 uint32_t GetMaximumUpdateCount() const;
319 * Update the scene for the next frame. This method must be called before each frame is rendered.
320 * Multi-threading notes: this method should be called from a dedicated update-thread.
321 * The update for frame N+1 may be processed whilst frame N is being rendered.
322 * However the update-thread must wait until frame N has been rendered, before processing frame N+2.
323 * After this method returns, messages may be queued internally for the main thread.
324 * In order to process these messages, a notification is sent via the main thread's event loop.
325 * @param[in] elapsedSeconds Number of seconds since the last call
326 * @param[in] lastVSyncTimeMilliseconds The last vsync time in milliseconds
327 * @param[in] nextVSyncTimeMilliseconds The time of the next predicted VSync in milliseconds
328 * @param[out] status showing whether further updates are required. This also shows
329 * whether a Notification event should be sent, regardless of whether the multi-threading is used.
330 * @param[in] renderToFboEnabled Whether rendering into the Frame Buffer Object is enabled.
331 * @param[in] isRenderingToFbo Whether this frame is being rendered into the Frame Buffer Object.
333 void Update( float elapsedSeconds,
334 uint32_t lastVSyncTimeMilliseconds,
335 uint32_t nextVSyncTimeMilliseconds,
336 UpdateStatus& status,
337 bool renderToFboEnabled,
338 bool isRenderingToFbo );
341 * This is called before rendering any scene in the next frame. This method should be preceded
342 * by a call up Update.
343 * Multi-threading note: this method should be called from a dedicated rendering thread.
344 * @pre The GL context must have been created, and made current.
345 * @param[out] status showing whether update is required to run.
346 * @param[in] forceClear force the Clear on the framebuffer even if nothing is rendered.
347 * @param[in] uploadOnly uploadOnly Upload the resource only without rendering.
349 void PreRender( RenderStatus& status, bool forceClear, bool uploadOnly );
352 * Render a scene in the next frame. This method should be preceded by a call up PreRender.
353 * This method should be called twice. The first pass to render off-screen frame buffers if any,
354 * and the second pass to render the surface.
355 * Multi-threading note: this method should be called from a dedicated rendering thread.
356 * @pre The GL context must have been created, and made current.
357 * @param[in] scene The scene to be rendered.
358 * @param[in] renderToFbo True to render off-screen frame buffers only if any, and False to render the surface only.
360 void RenderScene( Integration::Scene& scene, bool renderToFbo );
364 * This is called after rendering all the scenes in the next frame. This method should be
365 * followed by a call up RenderScene.
366 * Multi-threading note: this method should be called from a dedicated rendering thread.
367 * @pre The GL context must have been created, and made current.
368 * @param[in] uploadOnly uploadOnly Upload the resource only without rendering.
370 void PostRender( bool uploadOnly );
373 * @brief Register a processor
375 * Note, Core does not take ownership of this processor.
376 * @param[in] processor The process to register
378 void RegisterProcessor( Processor& processor );
381 * @brief Unregister a processor
382 * @param[in] processor The process to unregister
384 void UnregisterProcessor( Processor& processor );
389 * Private constructor; see also Core::New()
394 * Undefined copy-constructor.
395 * This avoids accidental calls to a default copy-constructor.
396 * @param[in] core A reference to the object to copy.
398 Core(const Core& core);
401 * Undefined assignment operator.
402 * This avoids accidental calls to a default assignment operator.
403 * @param[in] rhs A reference to the object to copy.
405 Core& operator=(const Core& rhs);
409 Internal::Core* mImpl;
413 } // namespace Integration
417 #endif // DALI_INTEGRATION_CORE_H