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