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