1 #ifndef __DALI_INTEGRATION_CORE_H__
2 #define __DALI_INTEGRATION_CORE_H__
5 * Copyright (c) 2014 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 <dali/public-api/common/dali-common.h>
23 #include <dali/public-api/common/view-mode.h>
39 class GlSyncAbstraction;
40 class PlatformAbstraction;
41 class RenderController;
47 * The reasons why further updates are required.
49 namespace KeepUpdating DALI_IMPORT_API
51 extern const unsigned int NOT_REQUESTED; ///< Zero means that no further updates are required
54 extern const unsigned int STAGE_KEEP_RENDERING; ///< 0x01 - Stage::KeepRendering() is being used
55 extern const unsigned int INCOMING_MESSAGES; ///< 0x02 - Event-thread is sending messages to update-thread
56 extern const unsigned int ANIMATIONS_RUNNING; ///< 0x04 - Animations are ongoing
57 extern const unsigned int DYNAMICS_CHANGED; ///< 0x08 - A dynamics simulation is running
58 extern const unsigned int LOADING_RESOURCES; ///< 0x10 - Resources are being loaded
59 extern const unsigned int NOTIFICATIONS_PENDING; ///< 0x20 - Notifications are pending for the event-thread
60 extern const unsigned int MONITORING_PERFORMANCE; ///< 0x40 - The --enable-performance-monitor option is being used
61 extern const unsigned int RENDER_TASK_SYNC; ///< 0x80 - A render task is waiting for render sync
65 * The status of the Core::Update operation.
67 class DALI_IMPORT_API UpdateStatus
75 : keepUpdating(false),
76 needsNotification(false),
77 secondsFromLastFrame( 0.0f )
84 * Query whether the Core has further frames to update & render e.g. when animations are ongoing.
85 * @return A bitmask of KeepUpdating values
87 unsigned int KeepUpdating() { return keepUpdating; }
90 * Query whether the Core requires an Notification event.
91 * This should be sent through the same mechanism (e.g. event loop) as input events.
92 * @return True if an Notification event should be sent.
94 bool NeedsNotification() { return needsNotification; }
97 * This method is provided so that FPS can be easily calculated with a release version
99 * @return the seconds from last frame as float
101 float SecondsFromLastFrame() { return secondsFromLastFrame; }
105 unsigned int keepUpdating; ///< A bitmask of KeepUpdating values
106 bool needsNotification;
107 float secondsFromLastFrame;
111 * The status of the Core::Render operation.
113 class DALI_IMPORT_API RenderStatus
121 : needsUpdate(false),
127 * Set whether update needs to run following a render.
128 * This might be because render has sent messages to update, or it has
129 * some textures to upload over several frames.
131 void SetNeedsUpdate(bool updateRequired) { needsUpdate = updateRequired; }
134 * Query the update status following rendering of a frame.
135 * @return true if update should run.
137 bool NeedsUpdate() { return needsUpdate; }
140 * Set whether there were new render instructions.
142 void SetHasRendered(bool rendered) { hasRendered = rendered; }
145 * Query whether there were new render instructions.
146 * @return true if there were render instructions
148 bool HasRendered() { return hasRendered; }
157 * Integration::Core is used for integration with the native windowing system.
158 * The following integration tasks must be completed:
160 * 1) Handle GL context creation, and notify the Core when this occurs.
162 * 2) Provide suspend/resume behaviour (see below for more details).
164 * 3) Run an event loop, for passing events to the Core e.g. multi-touch input events.
165 * Notification events should be sent after a frame is updated (see UpdateStatus).
167 * 4) Run a rendering loop, instructing the Core to render each frame.
168 * A separate rendering thread is recommended; see multi-threading options below.
170 * 5) Provide an implementation of the PlatformAbstraction interface, used to access platform specific services.
172 * 6) Provide an implementation of the GlAbstraction interface, used to access OpenGL services.
174 * 7) Provide an implementation of the GestureManager interface, used to register gestures provided by the platform.
176 * Suspend/Resume behaviour:
178 * The Core has no knowledge of the application lifecycle, but can be suspended.
179 * In the suspended state, input events will not be processed, and animations will not progress any further.
180 * The Core can still render in the suspended state; the same frame will be produced each time.
182 * Multi-threading notes:
184 * The Dali API methods are not reentrant. If you access the API from multiple threads simultaneously, then the results
185 * are undefined. This means that your application might segfault, or behave unpredictably.
187 * Rendering strategies:
189 * 1) Single-threaded. Call every Core method from the same thread. Event handling and rendering will occur in the same thread.
190 * This is not recommended, since processing input (slowly) can affect the smooth flow of animations.
192 * 2) Multi-threaded. The Core update & render operations can be processed in separate threads.
193 * See the method descriptions in Core to see which thread they should be called from.
194 * This is the recommended option, so that input processing will not affect the smoothness of animations.
195 * Note that the rendering thread must be halted, before destroying the GL context.
197 class DALI_IMPORT_API Core
203 * This object is used for integration with the native windowing system.
204 * @param[in] renderController The interface to an object which controls rendering.
205 * @param[in] platformAbstraction The interface providing platform specific services.
206 * @param[in] glAbstraction The interface providing OpenGL services.
207 * @param[in] glSyncAbstraction The interface providing OpenGL sync objects.
208 * @param[in] gestureManager The interface providing gesture manager services.
209 * @return A newly allocated Core.
211 static Core* New(RenderController& renderController,
212 PlatformAbstraction& platformAbstraction,
213 GlAbstraction& glAbstraction,
214 GlSyncAbstraction& glSyncAbstraction,
215 GestureManager& gestureManager);
218 * Non-virtual destructor. Core is not intended as a base class.
222 // GL Context Lifecycle
225 * Notify the Core that the GL context has been created.
226 * The context must be created before the Core can render.
227 * Multi-threading note: this method should be called from the rendering thread only
228 * @post The Core is aware of the GL context.
230 void ContextCreated();
233 * Notify the Core that that GL context is about to be destroyed.
234 * The Core will free any previously allocated GL resources.
235 * Multi-threading note: this method should be called from the rendering thread only
236 * @post The Core is unaware of any GL context.
238 void ContextToBeDestroyed();
241 * Notify the Core that the GL surface has been resized.
242 * This should be done at least once i.e. after the first call to ContextCreated().
243 * The Core will use the surface size for camera calculations, and to set the GL viewport.
244 * Multi-threading note: this method should be called from the main thread
245 * @param[in] width The new surface width.
246 * @param[in] height The new surface height.
248 void SurfaceResized(unsigned int width, unsigned int height);
253 * Notify the Core about the display's DPI values.
254 * This should be done after the display is initialized and a Core instance is created.
255 * The Core will use the DPI values for font rendering.
256 * Multi-threading note: this method should be called from the main thread
257 * @param[in] dpiHorizontal Horizontal DPI value.
258 * @param[in] dpiVertical Vertical DPI value.
260 void SetDpi(unsigned int dpiHorizontal, unsigned int dpiVertical);
263 * Sets the expected interval between frames used to predict future intervals and the time when the
264 * next render will take place.
266 * This is the minimum interval that Core should expect. Core will adapt the predicted interval
267 * accordingly if the expected interval is constantly not met (but will not drop it below this
270 * The value provided should be in microseconds.
272 * @param[in] interval The minimum interval between frames (in microseconds).
274 * Multi-threading note: this method should be called from the render thread
276 void SetMinimumFrameTimeInterval(unsigned int interval);
281 * Put Core into the suspended state.
282 * Any ongoing event processing will be cancelled, for example multi-touch sequences.
283 * The core expects the system has suspended us. Animation time will continue during the suspended
285 * Multi-threading note: this method should be called from the main thread
286 * @post The Core is in the suspended state.
291 * Resume the Core from the suspended state.
292 * At the first update, the elapsed time passed to the animations will be equal to the time spent
294 * Multi-threading note: this method should be called from the main thread
295 * @post The Core is not in the suspended state.
300 * Queue an event with Core.
301 * Pre-processing of events may be benificial e.g. a series of motion events could be throttled, so that only the last event is queued.
302 * Multi-threading note: this method should be called from the main thread.
303 * @param[in] event The new event.
305 void QueueEvent(const Event& event);
308 * Process the events queued with QueueEvent().
309 * Multi-threading note: this method should be called from the main thread.
310 * @pre ProcessEvents should not be called during ProcessEvents.
312 void ProcessEvents();
315 * Update external raw touch data in core.
316 * The core will use the touch data to generate Dali Touch/Gesture events for applications to use
317 * in the update thread.
318 * @param[in] touch The raw touch data.
319 * @note This can be called from either the event thread OR a dedicated touch thread.
321 void UpdateTouchData(const TouchData& touch);
324 * The Core::Update() method prepares a frame for rendering. This method determines how many frames
325 * may be prepared, ahead of the rendering.
326 * For example if the maximum update count is 2, then Core::Update() for frame N+1 may be processed
327 * whilst frame N is being rendered. However the Core::Update() for frame N+2 may not be called, until
328 * the Core::Render() method for frame N has returned.
329 * @return The maximum update count (>= 1).
331 unsigned int GetMaximumUpdateCount() const;
334 * Update the scene for the next frame. This method must be called before each frame is rendered.
335 * Multi-threading notes: this method should be called from a dedicated update-thread.
336 * The update for frame N+1 may be processed whilst frame N is being rendered.
337 * However the update-thread must wait until frame N has been rendered, before processing frame N+2.
338 * After this method returns, messages may be queued internally for the main thread.
339 * In order to process these messages, a notification is sent via the main thread's event loop.
340 * @param[out] status showing whether further updates are required. This also shows
341 * whether a Notification event should be sent, regardless of whether the multi-threading is used.
343 void Update( UpdateStatus& status );
346 * Render the next frame. This method should be preceded by a call up Update.
347 * Multi-threading note: this method should be called from a dedicated rendering thread.
348 * @pre The GL context must have been created, and made current.
349 * @param[out] status showing whether update is required to run.
351 void Render( RenderStatus& status );
354 * Tells core that it is about to sleep.
355 * Application is running as normal, but no updates are taking place i.e. no ongoing animations.
356 * This should be called when we choose to stop updating and rendering when there are no screen
358 * Multi-threading note: this method should be called from the update-thread.
363 * Wakes up core from a sleep state.
364 * At the first update the elapsed time passed to the animations is zero.
365 * Multi-threading note: this method should be called from the update-thread.
370 * Notification of a vertical blank sync
371 * @param[in] frameNumber The frame number of this vsync. This number will not update
373 * @param[in] seconds The timestamp seconds
374 * @param[in] microseconds The timestamp microseconds
376 void VSync( unsigned int frameNumber, unsigned int seconds, unsigned int microseconds );
378 // System-level overlay
381 * Use the SystemOverlay to draw content for system-level indicators, dialogs etc.
382 * @return The SystemOverlay.
384 SystemOverlay& GetSystemOverlay();
387 * Set the stereoscopic 3D view mode
388 * @param[in] viewMode The new view mode
390 void SetViewMode( ViewMode viewMode );
393 * Get the current view mode
394 * @return The current view mode
397 ViewMode GetViewMode() const;
400 * Set the stereo base (eye seperation) for stereoscopic 3D
401 * @param[in] stereoBase The stereo base (eye seperation) for stereoscopic 3D (mm)
403 void SetStereoBase( float stereoBase );
406 * Get the stereo base (eye seperation) for stereoscopic 3D
407 * @return The stereo base (eye seperation) for stereoscopic 3D (mm)
409 float GetStereoBase() const;
414 * Private constructor; see also Core::New()
419 * Undefined copy-constructor.
420 * This avoids accidental calls to a default copy-constructor.
421 * @param[in] core A reference to the object to copy.
423 Core(const Core& core);
426 * Undefined assignment operator.
427 * This avoids accidental calls to a default assignment operator.
428 * @param[in] rhs A reference to the object to copy.
430 Core& operator=(const Core& rhs);
434 Internal::Core* mImpl;
438 } // namespace Integration
442 #endif // __DALI_INTEGRATION_CORE_H__