dali/integration-api/core.h

   1 #ifndef __DALI_INTEGRATION_CORE_H__
   2 #define __DALI_INTEGRATION_CORE_H__
   3
   4 /*
   5  * Copyright (c) 2014 Samsung Electronics Co., Ltd.
   6  *
   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
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/public-api/common/dali-common.h>
  23 #include <dali/public-api/common/view-mode.h>
  24 #include <dali/integration-api/context-notifier.h>
  25 #include <dali/integration-api/resource-policies.h>
  26
  27 namespace Dali
  28 {
  29
  30 namespace Internal
  31 {
  32 class Core;
  33 }
  34
  35 namespace Integration
  36 {
  37
  38 class Core;
  39 class GestureManager;
  40 class GlAbstraction;
  41 class GlSyncAbstraction;
  42 class PlatformAbstraction;
  43 class RenderController;
  44 class SystemOverlay;
  45 struct Event;
  46 struct TouchData;
  47
  48
  49 /**
  50  * The reasons why further updates are required.
  51  */
  52 namespace KeepUpdating
  53 {
  54 enum Reasons
  55 {
  56   NOT_REQUESTED           = 0,    ///< Zero means that no further updates are required
  57   STAGE_KEEP_RENDERING    = 1<<1, ///<  - Stage::KeepRendering() is being used
  58   ANIMATIONS_RUNNING      = 1<<2, ///< - Animations are ongoing
  59   LOADING_RESOURCES       = 1<<3, ///< - Resources are being loaded
  60   MONITORING_PERFORMANCE  = 1<<4, ///< - The --enable-performance-monitor option is being used
  61   RENDER_TASK_SYNC        = 1<<5  ///< - A render task is waiting for render sync
  62 };
  63 }
  64
  65 /**
  66  * The status of the Core::Update operation.
  67  */
  68 class UpdateStatus
  69 {
  70 public:
  71
  72   /**
  73    * Constructor
  74    */
  75   UpdateStatus()
  76   : keepUpdating(false),
  77     needsNotification(false),
  78     secondsFromLastFrame( 0.0f )
  79   {
  80   }
  81
  82 public:
  83
  84   /**
  85    * Query whether the Core has further frames to update & render e.g. when animations are ongoing.
  86    * @return A bitmask of KeepUpdating values
  87    */
  88   unsigned int KeepUpdating() { return keepUpdating; }
  89
  90   /**
  91    * Query whether the Core requires an Notification event.
  92    * This should be sent through the same mechanism (e.g. event loop) as input events.
  93    * @return True if an Notification event should be sent.
  94    */
  95   bool NeedsNotification() { return needsNotification; }
  96
  97   /**
  98    * This method is provided so that FPS can be easily calculated with a release version
  99    * of Core.
 100    * @return the seconds from last frame as float
 101    */
 102   float SecondsFromLastFrame() { return secondsFromLastFrame; }
 103
 104 public:
 105
 106   unsigned int keepUpdating; ///< A bitmask of KeepUpdating values
 107   bool needsNotification;
 108   float secondsFromLastFrame;
 109 };
 110
 111 /**
 112  * The status of the Core::Render operation.
 113  */
 114 class RenderStatus
 115 {
 116 public:
 117
 118   /**
 119    * Constructor
 120    */
 121   RenderStatus()
 122   : needsUpdate(false),
 123     hasRendered(false)
 124   {
 125   }
 126
 127   /**
 128    * Set whether update needs to run following a render.
 129    * This might be because render has sent messages to update, or it has
 130    * some textures to upload over several frames.
 131    */
 132   void SetNeedsUpdate(bool updateRequired) { needsUpdate = updateRequired; }
 133
 134   /**
 135    * Query the update status following rendering of a frame.
 136    * @return true if update should run.
 137    */
 138   bool NeedsUpdate() { return needsUpdate; }
 139
 140   /**
 141    * Set whether there were new render instructions.
 142    */
 143   void SetHasRendered(bool rendered) { hasRendered = rendered; }
 144
 145   /**
 146    * Query whether there were new render instructions.
 147    * @return true if there were render instructions
 148    */
 149   bool HasRendered() { return hasRendered; }
 150
 151 private:
 152
 153   bool needsUpdate;
 154   bool hasRendered;
 155 };
 156
 157 /**
 158  * Integration::Core is used for integration with the native windowing system.
 159  * The following integration tasks must be completed:
 160  *
 161  * 1) Handle GL context creation, and notify the Core when this occurs.
 162  *
 163  * 2) Provide suspend/resume behaviour (see below for more details).
 164  *
 165  * 3) Run an event loop, for passing events to the Core e.g. multi-touch input events.
 166  * Notification events should be sent after a frame is updated (see UpdateStatus).
 167  *
 168  * 4) Run a rendering loop, instructing the Core to render each frame.
 169  * A separate rendering thread is recommended; see multi-threading options below.
 170  *
 171  * 5) Provide an implementation of the PlatformAbstraction interface, used to access platform specific services.
 172  *
 173  * 6) Provide an implementation of the GlAbstraction interface, used to access OpenGL services.
 174  *
 175  * 7) Provide an implementation of the GestureManager interface, used to register gestures provided by the platform.
 176  *
 177  * Suspend/Resume behaviour:
 178  *
 179  * The Core has no knowledge of the application lifecycle, but can be suspended.
 180  * In the suspended state, input events will not be processed, and animations will not progress any further.
 181  * The Core can still render in the suspended state; the same frame will be produced each time.
 182  *
 183  * Multi-threading notes:
 184  *
 185  * The Dali API methods are not reentrant.  If you access the API from multiple threads simultaneously, then the results
 186  * are undefined. This means that your application might segfault, or behave unpredictably.
 187  *
 188  * Rendering strategies:
 189  *
 190  * 1) Single-threaded. Call every Core method from the same thread. Event handling and rendering will occur in the same thread.
 191  * This is not recommended, since processing input (slowly) can affect the smooth flow of animations.
 192  *
 193  * 2) Multi-threaded. The Core update & render operations can be processed in separate threads.
 194  * See the method descriptions in Core to see which thread they should be called from.
 195  * This is the recommended option, so that input processing will not affect the smoothness of animations.
 196  * Note that the rendering thread must be halted, before destroying the GL context.
 197  */
 198 class DALI_IMPORT_API Core
 199 {
 200 public:
 201
 202   /**
 203    * Create a new Core.
 204    * This object is used for integration with the native windowing system.
 205    * @param[in] renderController The interface to an object which controls rendering.
 206    * @param[in] platformAbstraction The interface providing platform specific services.
 207    * @param[in] glAbstraction The interface providing OpenGL services.
 208    * @param[in] glSyncAbstraction The interface providing OpenGL sync objects.
 209    * @param[in] gestureManager The interface providing gesture manager services.
 210    * @param[in] policy The data retention policy. This depends on application setting
 211    * and platform support. Dali should honour this policy when deciding to discard
 212    * intermediate resource data.
 213    * @return A newly allocated Core.
 214    */
 215   static Core* New(RenderController& renderController,
 216                    PlatformAbstraction& platformAbstraction,
 217                    GlAbstraction& glAbstraction,
 218                    GlSyncAbstraction& glSyncAbstraction,
 219                    GestureManager& gestureManager,
 220                    ResourcePolicy::DataRetention policy);
 221
 222   /**
 223    * Non-virtual destructor. Core is not intended as a base class.
 224    */
 225   ~Core();
 226
 227   // GL Context Lifecycle
 228
 229   /**
 230    * Get the object that will notify the application/toolkit when context is lost/regained
 231    */
 232   ContextNotifierInterface* GetContextNotifier();
 233
 234   /**
 235    * Notify the Core that the GL context has been created.
 236    * The context must be created before the Core can render.
 237    * Multi-threading note: this method should be called from the rendering thread only
 238    * @post The Core is aware of the GL context.
 239    */
 240   void ContextCreated();
 241
 242   /**
 243    * Notify the Core that that GL context is about to be destroyed.
 244    * The Core will free any previously allocated GL resources.
 245    * Multi-threading note: this method should be called from the rendering thread only
 246    * @post The Core is unaware of any GL context.
 247    */
 248   void ContextDestroyed();
 249
 250   /**
 251    * Notify the Core that the GL context has been re-created, e.g. after ReplaceSurface
 252    * or Context loss.
 253    *
 254    * In the case of ReplaceSurface, both ContextToBeDestroyed() and ContextCreated() will have
 255    * been called on the render thread before this is called on the event thread.
 256    *
 257    * Multi-threading note: this method should be called from the main thread
 258    */
 259   void RecoverFromContextLoss();
 260
 261   /**
 262    * Notify the Core that the GL surface has been resized.
 263    * This should be done at least once i.e. after the first call to ContextCreated().
 264    * The Core will use the surface size for camera calculations, and to set the GL viewport.
 265    * Multi-threading note: this method should be called from the main thread
 266    * @param[in] width The new surface width.
 267    * @param[in] height The new surface height.
 268    */
 269   void SurfaceResized(unsigned int width, unsigned int height);
 270
 271   // Core setters
 272
 273   /**
 274    * Notify the Core about the display's DPI values.
 275    * This should be done after the display is initialized and a Core instance is created.
 276    * The Core will use the DPI values for font rendering.
 277    * Multi-threading note: this method should be called from the main thread
 278    * @param[in] dpiHorizontal Horizontal DPI value.
 279    * @param[in] dpiVertical   Vertical DPI value.
 280    */
 281   void SetDpi(unsigned int dpiHorizontal, unsigned int dpiVertical);
 282
 283   // Core Lifecycle
 284
 285   /**
 286    * Put Core into the suspended state.
 287    * Any ongoing event processing will be cancelled, for example multi-touch sequences.
 288    * The core expects the system has suspended us. Animation time will continue during the suspended
 289    * state.
 290    * Multi-threading note: this method should be called from the main thread
 291    * @post The Core is in the suspended state.
 292    */
 293   void Suspend();
 294
 295   /**
 296    * Resume the Core from the suspended state.
 297    * At the first update, the elapsed time passed to the animations will be equal to the time spent
 298    * suspended.
 299    * Multi-threading note: this method should be called from the main thread
 300    * @post The Core is not in the suspended state.
 301    */
 302   void Resume();
 303
 304   /**
 305    * Notify Core that the scene has been created.
 306    */
 307   void SceneCreated();
 308
 309   /**
 310    * Queue an event with Core.
 311    * 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.
 312    * Multi-threading note: this method should be called from the main thread.
 313    * @param[in] event The new event.
 314    */
 315   void QueueEvent(const Event& event);
 316
 317   /**
 318    * Process the events queued with QueueEvent().
 319    * Multi-threading note: this method should be called from the main thread.
 320    * @pre ProcessEvents should not be called during ProcessEvents.
 321    */
 322   void ProcessEvents();
 323
 324   /**
 325    * Update external raw touch data in core.
 326    * The core will use the touch data to generate Dali Touch/Gesture events for applications to use
 327    * in the update thread.
 328    * @param[in] touch The raw touch data.
 329    * @note This can be called from either the event thread OR a dedicated touch thread.
 330    */
 331   void UpdateTouchData(const TouchData& touch);
 332
 333   /**
 334    * The Core::Update() method prepares a frame for rendering. This method determines how many frames
 335    * may be prepared, ahead of the rendering.
 336    * For example if the maximum update count is 2, then Core::Update() for frame N+1 may be processed
 337    * whilst frame N is being rendered. However the Core::Update() for frame N+2 may not be called, until
 338    * the Core::Render() method for frame N has returned.
 339    * @return The maximum update count (>= 1).
 340    */
 341   unsigned int GetMaximumUpdateCount() const;
 342
 343   /**
 344    * Update the scene for the next frame. This method must be called before each frame is rendered.
 345    * Multi-threading notes: this method should be called from a dedicated update-thread.
 346    * The update for frame N+1 may be processed whilst frame N is being rendered.
 347    * However the update-thread must wait until frame N has been rendered, before processing frame N+2.
 348    * After this method returns, messages may be queued internally for the main thread.
 349    * In order to process these messages, a notification is sent via the main thread's event loop.
 350    * @param[in] elapsedSeconds Number of seconds since the last call
 351    * @param[in] lastVSyncTimeMilliseconds The last vsync time in milliseconds
 352    * @param[in] nextVSyncTimeMilliseconds The time of the next predicted VSync in milliseconds
 353    * @param[out] status showing whether further updates are required. This also shows
 354    * whether a Notification event should be sent, regardless of whether the multi-threading is used.
 355    */
 356   void Update( float elapsedSeconds, unsigned int lastVSyncTimeMilliseconds, unsigned int nextVSyncTimeMilliseconds, UpdateStatus& status );
 357
 358   /**
 359    * Render the next frame. This method should be preceded by a call up Update.
 360    * Multi-threading note: this method should be called from a dedicated rendering thread.
 361    * @pre The GL context must have been created, and made current.
 362    * @param[out] status showing whether update is required to run.
 363    */
 364   void Render( RenderStatus& status );
 365
 366   // System-level overlay
 367
 368   /**
 369    * Use the SystemOverlay to draw content for system-level indicators, dialogs etc.
 370    * @return The SystemOverlay.
 371    */
 372   SystemOverlay& GetSystemOverlay();
 373
 374   /**
 375    * Set the stereoscopic 3D view mode
 376    * @param[in] viewMode The new view mode
 377    */
 378   void SetViewMode( ViewMode viewMode );
 379
 380   /**
 381    * Get the current view mode
 382    * @return The current view mode
 383    * @see SetViewMode.
 384    */
 385   ViewMode GetViewMode() const;
 386
 387   /**
 388    * Set the stereo base (eye seperation) for stereoscopic 3D
 389    * @param[in] stereoBase The stereo base (eye seperation) for stereoscopic 3D (mm)
 390    */
 391   void SetStereoBase( float stereoBase );
 392
 393   /**
 394    * Get the stereo base (eye seperation) for stereoscopic 3D
 395    * @return The stereo base (eye seperation) for stereoscopic 3D (mm)
 396    */
 397   float GetStereoBase() const;
 398
 399 private:
 400
 401   /**
 402    * Private constructor; see also Core::New()
 403    */
 404   Core();
 405
 406   /**
 407    * Undefined copy-constructor.
 408    * This avoids accidental calls to a default copy-constructor.
 409    * @param[in] core A reference to the object to copy.
 410    */
 411   Core(const Core& core);
 412
 413   /**
 414    * Undefined assignment operator.
 415    * This avoids accidental calls to a default assignment operator.
 416    * @param[in] rhs A reference to the object to copy.
 417    */
 418   Core& operator=(const Core& rhs);
 419
 420 private:
 421
 422   Internal::Core* mImpl;
 423
 424 };
 425
 426 } // namespace Integration
 427
 428 } // namespace Dali
 429
 430 #endif // __DALI_INTEGRATION_CORE_H__