dali/devel-api/adaptor-framework/offscreen-application.h

   1 #ifndef DALI_OFFSCREEN_APPLICATION_H
   2 #define DALI_OFFSCREEN_APPLICATION_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/dali-signal.h>
  23 #include <dali/public-api/object/any.h>
  24 #include <dali/public-api/object/base-handle.h>
  25
  26 namespace Dali
  27 {
  28
  29 /**
  30  * @addtogroup dali_adaptor_framework
  31  * @{
  32  */
  33
  34 class OffscreenWindow;
  35
  36 namespace Internal
  37 {
  38 class OffscreenApplication;
  39 }
  40
  41 /**
  42  * @brief Appliations can draw UI on offscreen surface with the OffscreenApplication.
  43  * When you use a OffscreenApplication, you don't have to create a Window.
  44  */
  45 class DALI_IMPORT_API OffscreenApplication : public Dali::BaseHandle
  46 {
  47 public:
  48
  49   enum class RenderMode
  50   {
  51     AUTO,         // UI is rendered automatically
  52     MANUAL        // UI is rendered by RenderOnce()
  53   };
  54
  55   typedef Signal<void (void)> OffscreenApplicationSignalType;
  56
  57 public:
  58
  59   /**
  60    * @brief This is the constructor of OffscreenApplication
  61    *
  62    * @param[in] width The initial width of the default OffscreenWindow
  63    * @param[in] height The initial height of the default OffscreenWindow
  64    * @param[in] isTranslucent Whether the OffscreenWindow is translucent or not
  65    * @param[in] renderMode The RenderMode of the OffscreenApplication
  66    */
  67   static OffscreenApplication New( uint16_t width, uint16_t height, bool isTranslucent,
  68                                    RenderMode renderMode = RenderMode::AUTO );
  69
  70   /**
  71    * @brief This is the constructor of OffscreenApplication
  72    *
  73    * @param[in] surface The native surface handle to create the OffscreenWindow
  74    * @param[in] isTranslucent Whether the OffscreenWindow is translucent or not
  75    * @param[in] renderMode The RenderMode of the OffscreenApplication
  76    */
  77   static OffscreenApplication New( Dali::Any surface, bool isTranslucent,
  78                                    RenderMode renderMode = RenderMode::AUTO );
  79
  80   /**
  81    * @brief Constructs an empty handle
  82    */
  83   OffscreenApplication();
  84
  85   /**
  86    * @brief Copy constructor
  87    */
  88   OffscreenApplication( const OffscreenApplication& offscreenApplication );
  89
  90   /**
  91    * @brief Assignment operator
  92    */
  93   OffscreenApplication& operator=( const OffscreenApplication& offscreenApplication );
  94
  95   /**
  96    * @brief Destructor
  97    */
  98   ~OffscreenApplication();
  99
 100 public:
 101
 102   /**
 103    * @brief Starts the OffscreenApplication (rendering, event handling, etc)
 104    */
 105   void Start();
 106
 107   /**
 108    * @brief Stops the OffscreenApplication
 109    */
 110   void Stop();
 111
 112
 113   /**
 114    * @brief Get the default Window handle
 115    * @return The default Window
 116    */
 117   OffscreenWindow GetWindow();
 118
 119   /**
 120    * @brief Renders once more even if we're paused
 121    */
 122   void RenderOnce();
 123
 124 public:  // Signals
 125
 126   /**
 127    * @brief Signal to notify the client when the application is ready to be initialized
 128    *
 129    * @note OffscreenApplication::Start() should be called to be initialized
 130    *
 131    * @return The signal
 132    */
 133  OffscreenApplicationSignalType& InitSignal();
 134
 135   /**
 136    * @brief Signal to notify the user when the application is about to be terminated
 137    *
 138    * @return The signal
 139    */
 140  OffscreenApplicationSignalType& TerminateSignal();
 141
 142 public: // Not intended for application developers
 143   /**
 144    * @brief Internal constructor
 145    */
 146   explicit DALI_INTERNAL OffscreenApplication( Internal::OffscreenApplication* offscreenApplication );
 147
 148 };
 149
 150 /**
 151  * @}
 152  */
 153
 154 }  // namespace Dali
 155
 156 #endif // DALI_OFFSCREEN_APPLICATION_H