dali/integration-api/core.h

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