dali/integration-api/core.h

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