dali/integration-api/core.h

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