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   {
 124   }
 125
 126   /**
 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.
 130    */
 131   void SetNeedsUpdate(bool updateRequired) { needsUpdate = updateRequired; }
 132
 133   /**
 134    * Query the update status following rendering of a frame.
 135    * @return true if update should run.
 136    */
 137   bool NeedsUpdate() { return needsUpdate; }
 138
 139 private:
 140
 141   bool needsUpdate;
 142 };
 143
 144 /**
 145  * Integration::Core is used for integration with the native windowing system.
 146  * The following integration tasks must be completed:
 147  *
 148  * 1) Handle GL context creation, and notify the Core when this occurs.
 149  *
 150  * 2) Provide suspend/resume behaviour (see below for more details).
 151  *
 152  * 3) Run an event loop, for passing events to the Core e.g. multi-touch input events.
 153  * Notification events should be sent after a frame is updated (see UpdateStatus).
 154  *
 155  * 4) Run a rendering loop, instructing the Core to render each frame.
 156  * A separate rendering thread is recommended; see multi-threading options below.
 157  *
 158  * 5) Provide an implementation of the PlatformAbstraction interface, used to access platform specific services.
 159  *
 160  * 6) Provide an implementation of the GlAbstraction interface, used to access OpenGL services.
 161  *
 162  * 7) Provide an implementation of the GestureManager interface, used to register gestures provided by the platform.
 163  *
 164  * Suspend/Resume behaviour:
 165  *
 166  * The Core has no knowledge of the application lifecycle, but can be suspended.
 167  * In the suspended state, input events will not be processed, and animations will not progress any further.
 168  * The Core can still render in the suspended state; the same frame will be produced each time.
 169  *
 170  * Multi-threading notes:
 171  *
 172  * The Dali API methods are not reentrant.  If you access the API from multiple threads simultaneously, then the results
 173  * are undefined. This means that your application might segfault, or behave unpredictably.
 174  *
 175  * Rendering strategies:
 176  *
 177  * 1) Single-threaded. Call every Core method from the same thread. Event handling and rendering will occur in the same thread.
 178  * This is not recommended, since processing input (slowly) can affect the smooth flow of animations.
 179  *
 180  * 2) Multi-threaded. The Core update & render operations can be processed in separate threads.
 181  * See the method descriptions in Core to see which thread they should be called from.
 182  * This is the recommended option, so that input processing will not affect the smoothness of animations.
 183  * Note that the rendering thread must be halted, before destroying the GL context.
 184  */
 185 class DALI_IMPORT_API Core
 186 {
 187 public:
 188
 189   /**
 190    * Create a new Core.
 191    * This object is used for integration with the native windowing system.
 192    * @param[in] renderController The interface to an object which controls rendering.
 193    * @param[in] platformAbstraction The interface providing platform specific services.
 194    * @param[in] glAbstraction The interface providing OpenGL services.
 195    * @param[in] glSyncAbstraction The interface providing OpenGL sync objects.
 196    * @param[in] gestureManager The interface providing gesture manager services.
 197    * @param[in] policy The data retention policy. This depends on application setting
 198    * and platform support. Dali should honour this policy when deciding to discard
 199    * intermediate resource data.
 200    * @return A newly allocated Core.
 201    */
 202   static Core* New(RenderController& renderController,
 203                    PlatformAbstraction& platformAbstraction,
 204                    GlAbstraction& glAbstraction,
 205                    GlSyncAbstraction& glSyncAbstraction,
 206                    GestureManager& gestureManager,
 207                    ResourcePolicy::DataRetention policy);
 208
 209   /**
 210    * Non-virtual destructor. Core is not intended as a base class.
 211    */
 212   ~Core();
 213
 214   // GL Context Lifecycle
 215
 216   /**
 217    * Get the object that will notify the application/toolkit when context is lost/regained
 218    */
 219   ContextNotifierInterface* GetContextNotifier();
 220
 221   /**
 222    * Notify the Core that the GL context has been created.
 223    * The context must be created before the Core can render.
 224    * Multi-threading note: this method should be called from the rendering thread only
 225    * @post The Core is aware of the GL context.
 226    */
 227   void ContextCreated();
 228
 229   /**
 230    * Notify the Core that that GL context is about to be destroyed.
 231    * The Core will free any previously allocated GL resources.
 232    * Multi-threading note: this method should be called from the rendering thread only
 233    * @post The Core is unaware of any GL context.
 234    */
 235   void ContextDestroyed();
 236
 237   /**
 238    * Notify the Core that the GL context has been re-created, e.g. after ReplaceSurface
 239    * or Context loss.
 240    *
 241    * In the case of ReplaceSurface, both ContextToBeDestroyed() and ContextCreated() will have
 242    * been called on the render thread before this is called on the event thread.
 243    *
 244    * Multi-threading note: this method should be called from the main thread
 245    */
 246   void RecoverFromContextLoss();
 247
 248   /**
 249    * Notify the Core that the GL surface has been resized.
 250    * This should be done at least once i.e. after the first call to ContextCreated().
 251    * The Core will use the surface size for camera calculations, and to set the GL viewport.
 252    * Multi-threading note: this method should be called from the main thread
 253    * @param[in] width The new surface width.
 254    * @param[in] height The new surface height.
 255    */
 256   void SurfaceResized(unsigned int width, unsigned int height);
 257
 258   /**
 259    * Notify the Core about the top margin size.
 260    * Available stage size is reduced by this size.
 261    * The stage is located below the size at the top of the display
 262    * It is mainly useful for indicator in mobile device
 263    * @param[in] margin margin size
 264    */
 265   void SetTopMargin( unsigned int margin );
 266
 267   // Core setters
 268
 269   /**
 270    * Notify the Core about the display's DPI values.
 271    * This should be done after the display is initialized and a Core instance is created.
 272    * The Core will use the DPI values for font rendering.
 273    * Multi-threading note: this method should be called from the main thread
 274    * @param[in] dpiHorizontal Horizontal DPI value.
 275    * @param[in] dpiVertical   Vertical DPI value.
 276    */
 277   void SetDpi(unsigned int dpiHorizontal, unsigned int dpiVertical);
 278
 279   // Core Lifecycle
 280
 281   /**
 282    * Put Core into the suspended state.
 283    * Any ongoing event processing will be cancelled, for example multi-touch sequences.
 284    * The core expects the system has suspended us. Animation time will continue during the suspended
 285    * state.
 286    * Multi-threading note: this method should be called from the main thread
 287    * @post The Core is in the suspended state.
 288    */
 289   void Suspend();
 290
 291   /**
 292    * Resume the Core from the suspended state.
 293    * At the first update, the elapsed time passed to the animations will be equal to the time spent
 294    * suspended.
 295    * Multi-threading note: this method should be called from the main thread
 296    * @post The Core is not in the suspended state.
 297    */
 298   void Resume();
 299
 300   /**
 301    * Notify Core that the scene has been created.
 302    */
 303   void SceneCreated();
 304
 305   /**
 306    * Queue an event with Core.
 307    * 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.
 308    * Multi-threading note: this method should be called from the main thread.
 309    * @param[in] event The new event.
 310    */
 311   void QueueEvent(const Event& event);
 312
 313   /**
 314    * Process the events queued with QueueEvent().
 315    * Multi-threading note: this method should be called from the main thread.
 316    * @pre ProcessEvents should not be called during ProcessEvents.
 317    */
 318   void ProcessEvents();
 319
 320   /**
 321    * The Core::Update() method prepares a frame for rendering. This method determines how many frames
 322    * may be prepared, ahead of the rendering.
 323    * For example if the maximum update count is 2, then Core::Update() for frame N+1 may be processed
 324    * whilst frame N is being rendered. However the Core::Update() for frame N+2 may not be called, until
 325    * the Core::Render() method for frame N has returned.
 326    * @return The maximum update count (>= 1).
 327    */
 328   unsigned int GetMaximumUpdateCount() const;
 329
 330   /**
 331    * Update the scene for the next frame. This method must be called before each frame is rendered.
 332    * Multi-threading notes: this method should be called from a dedicated update-thread.
 333    * The update for frame N+1 may be processed whilst frame N is being rendered.
 334    * However the update-thread must wait until frame N has been rendered, before processing frame N+2.
 335    * After this method returns, messages may be queued internally for the main thread.
 336    * In order to process these messages, a notification is sent via the main thread's event loop.
 337    * @param[in] elapsedSeconds Number of seconds since the last call
 338    * @param[in] lastVSyncTimeMilliseconds The last vsync time in milliseconds
 339    * @param[in] nextVSyncTimeMilliseconds The time of the next predicted VSync in milliseconds
 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.
 342    */
 343   void Update( float elapsedSeconds, unsigned int lastVSyncTimeMilliseconds, unsigned int nextVSyncTimeMilliseconds, UpdateStatus& status );
 344
 345   /**
 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.
 350    */
 351   void Render( RenderStatus& status );
 352
 353   // System-level overlay
 354
 355   /**
 356    * Use the SystemOverlay to draw content for system-level indicators, dialogs etc.
 357    * @return The SystemOverlay.
 358    */
 359   SystemOverlay& GetSystemOverlay();
 360
 361   /**
 362    * Set the stereoscopic 3D view mode
 363    * @param[in] viewMode The new view mode
 364    */
 365   void SetViewMode( ViewMode viewMode );
 366
 367   /**
 368    * Get the current view mode
 369    * @return The current view mode
 370    * @see SetViewMode.
 371    */
 372   ViewMode GetViewMode() const;
 373
 374   /**
 375    * Set the stereo base (eye seperation) for stereoscopic 3D
 376    * @param[in] stereoBase The stereo base (eye seperation) for stereoscopic 3D (mm)
 377    */
 378   void SetStereoBase( float stereoBase );
 379
 380   /**
 381    * Get the stereo base (eye seperation) for stereoscopic 3D
 382    * @return The stereo base (eye seperation) for stereoscopic 3D (mm)
 383    */
 384   float GetStereoBase() const;
 385
 386 private:
 387
 388   /**
 389    * Private constructor; see also Core::New()
 390    */
 391   Core();
 392
 393   /**
 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.
 397    */
 398   Core(const Core& core);
 399
 400   /**
 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.
 404    */
 405   Core& operator=(const Core& rhs);
 406
 407 private:
 408
 409   Internal::Core* mImpl;
 410
 411 };
 412
 413 } // namespace Integration
 414
 415 } // namespace Dali
 416
 417 #endif // __DALI_INTEGRATION_CORE_H__