dali/integration-api/adaptor-framework/adaptor.h

   1 #ifndef DALI_INTEGRATION_ADAPTOR_H
   2 #define DALI_INTEGRATION_ADAPTOR_H
   3
   4 /*
   5  * Copyright (c) 2020 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 <dali/public-api/signals/callback.h>
  23 #include <dali/public-api/signals/dali-signal.h>
  24 #include <dali/public-api/math/uint-16-pair.h>
  25 #include <dali/public-api/math/rect.h>
  26 #include <dali/public-api/events/touch-event.h>
  27 #include <dali/public-api/common/view-mode.h>
  28 #include <dali/public-api/object/any.h>
  29 #include <dali/integration-api/processor-interface.h>
  30
  31 // INTERNAL INCLUDES
  32 #include <dali/public-api/adaptor-framework/window.h>
  33 #include <dali/public-api/adaptor-framework/application-configuration.h>
  34 #include <dali/public-api/dali-adaptor-common.h>
  35 #include <dali/integration-api/adaptor-framework/log-factory-interface.h>
  36
  37 namespace Dali
  38 {
  39
  40 class RenderSurfaceInterface;
  41
  42 using WindowContainer = std::vector<Window>;
  43
  44 namespace Integration
  45 {
  46 class SceneHolder;
  47 }
  48
  49 using SceneHolderList = std::vector<Dali::Integration::SceneHolder>;
  50
  51
  52 namespace Internal
  53 {
  54 namespace Adaptor
  55 {
  56 class GraphicsFactory;
  57 class Adaptor;
  58 }
  59 }
  60
  61 /**
  62  * @brief An Adaptor object is used to initialize and control how Dali runs.
  63  *
  64  * It provides a lifecycle interface that allows the application
  65  * writer to provide their own main loop and other platform related
  66  * features.
  67  *
  68  * The Adaptor class provides a means for initialising the resources required by the Dali::Core.
  69  *
  70  * When dealing with platform events, the application writer MUST ensure that Dali is called in a
  71  * thread-safe manner.
  72  *
  73  * As soon as the Adaptor class is created and started, the application writer can initialise their
  74  * Dali::Actor objects straight away or as required by the main loop they intend to use (there is no
  75  * need to wait for an initialise signal as per the Dali::Application class).
  76  *
  77  * The Adaptor does emit a Resize signal which informs the user when the surface is resized.
  78  * Tizen and Linux Adaptors should follow the example below:
  79  *
  80  * @code
  81  * void CreateProgram(DaliAdaptor& adaptor)
  82  * {
  83  *   // Create Dali components...
  84  *   // Can instantiate adaptor here instead, if required
  85  * }
  86  *
  87  * int main ()
  88  * {
  89  *   // Initialise platform
  90  *   MyPlatform.Init();
  91  *
  92  *   // Create an 800 by 1280 window positioned at (0,0).
  93  *   Dali::PositionSize positionSize(0, 0, 800, 1280);
  94  *   Dali::Window window = Dali::Window::New( positionSize, "My Application" );
  95  *
  96  *   // Create an adaptor which uses that window for rendering
  97  *   Dali::Adaptor adaptor = Dali::Adaptor::New( window );
  98  *   adaptor.Start();
  99  *
 100  *   CreateProgram(adaptor);
 101  *   // Or use this as a callback function depending on the platform initialisation sequence.
 102  *
 103  *   // Start Main Loop of your platform
 104  *   MyPlatform.StartMainLoop();
 105  *
 106  *   return 0;
 107  * }
 108  * @endcode
 109  *
 110  * If required, you can also connect class member functions to a signal:
 111  *
 112  * @code
 113  * MyApplication application;
 114  * adaptor.ResizedSignal().Connect(&application, &MyApplication::Resize);
 115  * @endcode
 116  *
 117  * @see RenderSurface
 118  */
 119 class DALI_ADAPTOR_API Adaptor
 120 {
 121 public:
 122
 123   typedef Signal< void (Adaptor&) > AdaptorSignalType; ///< Generic Type for adaptor signals
 124   typedef Signal< void (Dali::Integration::SceneHolder&) > WindowCreatedSignalType;  ///< SceneHolder created signal type
 125
 126   using SurfaceSize = Uint16Pair; ///< Surface size type
 127
 128 public:
 129   /**
 130    * @brief Create a new adaptor using the window.
 131    *
 132    * @param[in] window The window to draw onto
 133    * @return a reference to the adaptor handle
 134    */
 135   static Adaptor& New( Window window );
 136
 137   /**
 138    * @brief Create a new adaptor using the window.
 139    *
 140    * @param[in] window The window to draw onto
 141    * @param[in] configuration The context loss configuration.
 142    * @return a reference to the adaptor handle
 143    */
 144   static Adaptor& New( Window window, Configuration::ContextLoss configuration );
 145
 146   /**
 147    * @brief Create a new adaptor using render surface.
 148    *
 149    * @param[in] window The window to draw onto
 150    * @param[in] surface The surface to draw onto
 151    * @return a reference to the adaptor handle
 152    */
 153   static Adaptor& New( Window window, const Dali::RenderSurfaceInterface& surface );
 154
 155   /**
 156    * @brief Create a new adaptor using render surface.
 157    *
 158    * @param[in] window The window to draw onto
 159    * @param[in] surface The surface to draw onto
 160    * @param[in] configuration The context loss configuration.
 161    * @return a reference to the adaptor handle
 162    */
 163   static Adaptor& New( Window window, const Dali::RenderSurfaceInterface& surface, Configuration::ContextLoss configuration = Configuration::APPLICATION_DOES_NOT_HANDLE_CONTEXT_LOSS);
 164
 165   /**
 166    * @brief Create a new adaptor using the SceneHolder.
 167    *
 168    * @param[in] sceneHolder The SceneHolder to draw onto
 169    * @return a reference to the adaptor handle
 170    */
 171   static Adaptor& New( Dali::Integration::SceneHolder sceneHolder );
 172
 173   /**
 174    * @brief Create a new adaptor using the SceneHolder.
 175    *
 176    * @param[in] sceneHolder The SceneHolder to draw onto
 177    * @param[in] configuration The context loss configuration.
 178    * @return a reference to the adaptor handle
 179    */
 180   static Adaptor& New( Dali::Integration::SceneHolder sceneHolder, Configuration::ContextLoss configuration );
 181
 182   /**
 183    * @brief Create a new adaptor using render surface.
 184    *
 185    * @param[in] sceneHolder The SceneHolder to draw onto
 186    * @param[in] surface The surface to draw onto
 187    * @return a reference to the adaptor handle
 188    */
 189   static Adaptor& New( Dali::Integration::SceneHolder sceneHolder, const Dali::RenderSurfaceInterface& surface );
 190
 191   /**
 192    * @brief Create a new adaptor using render surface.
 193    *
 194    * @param[in] sceneHolder The SceneHolder to draw onto
 195    * @param[in] surface The surface to draw onto
 196    * @param[in] configuration The context loss configuration.
 197    * @return a reference to the adaptor handle
 198    */
 199   static Adaptor& New( Dali::Integration::SceneHolder sceneHolder, const Dali::RenderSurfaceInterface& surface, Configuration::ContextLoss configuration = Configuration::APPLICATION_DOES_NOT_HANDLE_CONTEXT_LOSS);
 200
 201   /**
 202    * @brief Virtual Destructor.
 203    */
 204   virtual ~Adaptor();
 205
 206 public:
 207
 208   /**
 209    * @brief Starts the Adaptor.
 210    */
 211   void Start();
 212
 213   /**
 214    * @brief Pauses the Adaptor.
 215    */
 216   void Pause();
 217
 218   /**
 219    * @brief Resumes the Adaptor, if previously paused.
 220    *
 221    * @note If the adaptor is not paused, this does not do anything.
 222    */
 223   void Resume();
 224
 225   /**
 226    * @brief Stops the Adaptor.
 227    */
 228   void Stop();
 229
 230   /**
 231    * @brief Ensures that the function passed in is called from the main loop when it is idle.
 232    * @note Function must be called from the main event thread only.
 233    *
 234    * Callbacks of the following types may be used:
 235    * @code
 236    *   void MyFunction();
 237    * @endcode
 238    * This callback will be deleted once it is called.
 239    *
 240    * @code
 241    *   bool MyFunction();
 242    * @endcode
 243    * This callback will be called repeatedly as long as it returns true. A return of 0 deletes this callback.
 244    *
 245    * @param[in] callback The function to call.
 246    * @param[in] hasReturnValue Sould be set to true if the callback function has a return value.
 247    * @return true if added successfully, false otherwise
 248    *
 249    * @note Ownership of the callback is passed onto this class.
 250    */
 251   bool AddIdle( CallbackBase* callback, bool hasReturnValue );
 252
 253   /**
 254    * @brief Adds a new Window instance to the Adaptor
 255    *
 256    * @param[in]  childWindow The child window instance
 257    * @param[in]  childWindowName The child window title/name
 258    * @param[in]  childWindowClassName The class name that the child window belongs to
 259    * @param[in]  childWindowMode The mode of the child window
 260    */
 261   bool AddWindow( Dali::Integration::SceneHolder childWindow,
 262                   const std::string& childWindowName,
 263                   const std::string& childWindowClassName,
 264                   bool childWindowMode );
 265
 266   /**
 267    * @brief Removes a previously added @p callback.
 268    * @note Function must be called from the main event thread only.
 269    *
 270    * Does nothing if the @p callback doesn't exist.
 271    *
 272    * @param[in] callback The callback to be removed.
 273    */
 274   void RemoveIdle( CallbackBase* callback );
 275
 276   /**
 277    * @brief Replaces the rendering surface
 278    *
 279    * @param[in] window The window to replace the surface for
 280    * @param[in] surface to use
 281    */
 282   void ReplaceSurface( Window window, Dali::RenderSurfaceInterface& surface );
 283
 284   /**
 285    * @brief Replaces the rendering surface
 286    *
 287    * @param[in] sceneHolder The SceneHolder to replace the surface for
 288    * @param[in] surface to use
 289    */
 290   void ReplaceSurface( Dali::Integration::SceneHolder sceneHolder, Dali::RenderSurfaceInterface& surface );
 291
 292   /**
 293    * @brief Get the render surface the adaptor is using to render to.
 294    *
 295    * @return reference to current render surface
 296    */
 297   Dali::RenderSurfaceInterface& GetSurface();
 298
 299   /**
 300    * @brief Gets native window handle
 301    *
 302    * @return Native window handle
 303    */
 304   Any GetNativeWindowHandle();
 305
 306   /**
 307    * @brief Retrieve native window handle that the given actor is added to.
 308    *
 309    * @param[in] actor The actor
 310    * @return native window handle
 311    */
 312   Any GetNativeWindowHandle( Actor actor );
 313
 314   /**
 315    * @brief Get the native display associated with the graphics backend
 316    *
 317    * @return A handle to the native display
 318    */
 319   Any GetGraphicsDisplay();
 320
 321   /**
 322    * @brief Release any locks the surface may hold.
 323    *
 324    * For example, after compositing an offscreen surface, use this method to allow
 325    * rendering to continue.
 326    */
 327   void ReleaseSurfaceLock();
 328
 329   /**
 330    * @brief Set the number of frames per render.
 331    *
 332    * This enables an application to deliberately render with a reduced FPS.
 333    * @param[in] numberOfVSyncsPerRender The number of vsyncs between successive renders.
 334    * Suggest this is a power of two:
 335    * 1 - render each vsync frame
 336    * 2 - render every other vsync frame
 337    * 4 - render every fourth vsync frame
 338    * 8 - render every eighth vsync frame
 339    */
 340   void SetRenderRefreshRate( unsigned int numberOfVSyncsPerRender );
 341
 342   /**
 343    * @brief The callback is called from the Update/Render thread prior to rendering.
 344    *
 345    * @param[in] callback The function to call
 346    *
 347    * @note The function is called from the Update thread, so should do as little processing as possible.
 348    * It is not possible to call any DALi event side APIs from within the callback; doing so will cause
 349    * instability. Only 1 callback is supported. Setting the callback to NULL will remove the current callback.
 350    *
 351    * A callback of the following type should be used:
 352    * @code
 353    *   bool MyFunction();
 354    * @endcode
 355    * This callback will be called repeatedly as long as it returns true. A return of 0 deletes this callback.
 356    */
 357   void SetPreRenderCallback( CallbackBase* callback );
 358
 359   /**
 360    * @brief Returns a reference to the instance of the adaptor used by the current thread.
 361    *
 362    * @return A reference to the adaptor.
 363    * @pre The adaptor has been initialised.
 364    * @note This is only valid in the main thread.
 365    */
 366   static Adaptor& Get();
 367
 368   /**
 369    * @brief Checks whether the adaptor is available.
 370    *
 371    * @return true, if it is available, false otherwise.
 372    */
 373   static bool IsAvailable();
 374
 375   /**
 376    * @brief Call this method to notify Dali when scene is created and initialized.
 377    *
 378    * Notify Adaptor that the scene has been created.
 379    */
 380   void NotifySceneCreated();
 381
 382   /**
 383    * @brief Call this method to notify Dali when the system language changes.
 384    *
 385    * Use this only when NOT using Dali::Application, As Application created using
 386    * Dali::Application will automatically receive notification of language change.
 387    * When Dali::Application is not used, the application developer should
 388    * use app-core to receive language change notifications and should update Dali
 389    * by calling this method.
 390    */
 391   void NotifyLanguageChanged();
 392
 393   /**
 394    * @brief Feed a touch point to the adaptor.
 395    *
 396    * @param[in] point touch point
 397    * @param[in] timeStamp time value of event
 398    */
 399   void FeedTouchPoint( TouchPoint& point, int timeStamp );
 400
 401   /**
 402    * @brief Feed a wheel event to the adaptor.
 403    *
 404    * @param[in]  wheelEvent wheel event
 405    */
 406   void FeedWheelEvent( WheelEvent& wheelEvent );
 407
 408   /**
 409    * @brief Feed a key event to the adaptor.
 410    *
 411    * @param[in] keyEvent The key event holding the key information.
 412    */
 413   void FeedKeyEvent( KeyEvent& keyEvent );
 414
 415   /**
 416    * @copydoc Dali::Core::SceneCreated();
 417    */
 418   void SceneCreated();
 419
 420   /**
 421    * @brief Informs core the surface size has changed.
 422    *
 423    * @param[in] surface The current render surface
 424    * @param[in] surfaceSize The new surface size
 425    */
 426   void SurfaceResizePrepare( Dali::RenderSurfaceInterface* surface, SurfaceSize surfaceSize );
 427
 428   /**
 429    * @brief Informs ThreadController the surface size has changed.
 430    *
 431    * @param[in] surface The current render surface
 432    * @param[in] surfaceSize The new surface size
 433    */
 434   void SurfaceResizeComplete( Dali::RenderSurfaceInterface* surface, SurfaceSize surfaceSize );
 435
 436   /**
 437    * @brief Renders once more even if we're paused
 438    * @note Will not work if the window is hidden.
 439    */
 440   void RenderOnce();
 441
 442   /**
 443    * @brief The log factory allows installation of a logger function in worker threads.
 444    * @return An interface to a logging factory
 445    */
 446   const LogFactoryInterface& GetLogFactory();
 447
 448   /**
 449    * @brief Register a processor implementing the Integration::Processor interface with dali-core.
 450    * @param[in] processor the Processor to register
 451    * @note using this api does not maintain the processor's lifecycle, must be done elsewhere.
 452    */
 453   void RegisterProcessor( Integration::Processor& processor );
 454
 455   /**
 456    * @brief Unregister a previously registered processor from dali-core.
 457    * @param[in] processor the Processor to unregister
 458    */
 459   void UnregisterProcessor( Integration::Processor& processor );
 460
 461   /**
 462    * @brief Get the list of windows created.
 463    * @return The list of windows
 464    */
 465   Dali::WindowContainer GetWindows() const;
 466
 467   /**
 468    * @brief Get the list of scene holders.
 469    * @return The list of scene holers
 470    */
 471   SceneHolderList GetSceneHolders() const;
 472
 473   /**
 474    * @brief Called when the window becomes fully or partially visible.
 475    */
 476   void OnWindowShown();
 477
 478   /**
 479    * @brief Called when the window is fully hidden.
 480    */
 481   void OnWindowHidden();
 482
 483 public:  // Signals
 484
 485   /**
 486    * @brief The user should connect to this signal if they need to perform any
 487    * special activities when the surface Dali is being rendered on is resized.
 488    *
 489    * @return The signal to connect to
 490    */
 491   AdaptorSignalType& ResizedSignal();
 492
 493   /**
 494    * @brief This signal is emitted when the language is changed on the device.
 495    *
 496    * @return The signal to connect to
 497    */
 498   AdaptorSignalType& LanguageChangedSignal();
 499
 500   /**
 501    * @brief This signal is emitted when a new window (scene holder) is created
 502    *
 503    * @return The signal to connect to
 504    */
 505   WindowCreatedSignalType& WindowCreatedSignal();
 506
 507 private:
 508
 509   // Undefined
 510   Adaptor(const Adaptor&);
 511   Adaptor& operator=(Adaptor&);
 512
 513 private:
 514
 515   /**
 516    * @brief Create an uninitialized Adaptor.
 517    */
 518   Adaptor();
 519
 520   Internal::Adaptor::Adaptor* mImpl; ///< Implementation object
 521   friend class Internal::Adaptor::Adaptor;
 522 };
 523
 524 } // namespace Dali
 525
 526 #endif // DALI_INTEGRATION_ADAPTOR_H