dali/internal/common/core-impl.h

   1 #ifndef DALI_INTERNAL_CORE_H
   2 #define DALI_INTERNAL_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 // INTERNAL INCLUDES
  22 #include <dali/public-api/common/dali-vector.h>
  23 #include <dali/public-api/object/ref-object.h>
  24 #include <dali/integration-api/context-notifier.h>
  25 #include <dali/integration-api/core-enumerations.h>
  26 #include <dali/internal/common/owner-pointer.h>
  27 #include <dali/devel-api/common/owner-container.h>
  28 #include <dali/internal/event/animation/animation-playlist-declarations.h>
  29 #include <dali/internal/event/common/stage-def.h>
  30 #include <dali/integration-api/resource-policies.h>
  31 #include <dali/internal/event/common/scene-impl.h>
  32 #include <dali/internal/event/common/object-registry-impl.h>
  33
  34 namespace Dali
  35 {
  36
  37 namespace Integration
  38 {
  39 class Processor;
  40 class RenderController;
  41 class PlatformAbstraction;
  42 class GlAbstraction;
  43 class GlSyncAbstraction;
  44 class GlContextHelperAbstraction;
  45 class UpdateStatus;
  46 class RenderStatus;
  47 class RenderSurface;
  48 struct Event;
  49 struct TouchData;
  50 }
  51
  52 namespace Internal
  53 {
  54
  55 class NotificationManager;
  56 class AnimationPlaylist;
  57 class PropertyNotificationManager;
  58 class EventProcessor;
  59 class GestureEventProcessor;
  60 class ShaderFactory;
  61 class TouchResampler;
  62 class RelayoutController;
  63 class EventThreadServices;
  64
  65 namespace SceneGraph
  66 {
  67 class UpdateManager;
  68 class RenderManager;
  69 class DiscardQueue;
  70 class RenderTaskProcessor;
  71 }
  72
  73 /**
  74  * Internal class for Dali::Integration::Core
  75  */
  76 class Core : public EventThreadServices
  77 {
  78 public:
  79
  80   /**
  81    * Create and initialise a new Core instance
  82    */
  83   Core( Integration::RenderController& renderController,
  84         Integration::PlatformAbstraction& platform,
  85         Integration::GlAbstraction& glAbstraction,
  86         Integration::GlSyncAbstraction& glSyncAbstraction,
  87         Integration::GlContextHelperAbstraction& glContextHelperAbstraction,
  88         ResourcePolicy::DataRetention dataRetentionPolicy,
  89         Integration::RenderToFrameBuffer renderToFboEnabled,
  90         Integration::DepthBufferAvailable depthBufferAvailable,
  91         Integration::StencilBufferAvailable stencilBufferAvailable,
  92         Integration::PartialUpdateAvailable partialUpdateAvailable );
  93
  94   /**
  95    * Destructor
  96    */
  97   ~Core();
  98
  99   /**
 100    * @copydoc Dali::Integration::Core::Initialize()
 101    */
 102   void Initialize();
 103
 104   /**
 105    * @copydoc Dali::Integration::Core::GetContextNotifier()
 106    */
 107   Integration::ContextNotifierInterface* GetContextNotifier();
 108
 109   /**
 110    * @copydoc Dali::Integration::Core::ContextCreated()
 111    */
 112   void ContextCreated();
 113
 114   /**
 115    * @copydoc Dali::Integration::Core::ContextDestroyed()
 116    */
 117   void ContextDestroyed();
 118
 119   /**
 120    * @copydoc Dali::Integration::Core::RecoverFromContextLoss()
 121    */
 122   void RecoverFromContextLoss();
 123
 124   /**
 125    * @copydoc Dali::Integration::Core::SurfaceDeleted(Integration::RenderSurface*)
 126    */
 127   void SurfaceDeleted( Integration::RenderSurface* surface );
 128
 129   /**
 130    * @copydoc Dali::Integration::Core::SetMinimumFrameTimeInterval(uint32_t)
 131    */
 132   void SetMinimumFrameTimeInterval(uint32_t interval);
 133
 134   /**
 135    * @copydoc Dali::Integration::Core::Update()
 136    */
 137   void Update( float elapsedSeconds, uint32_t lastVSyncTimeMilliseconds, uint32_t nextVSyncTimeMilliseconds, Integration::UpdateStatus& status, bool renderToFboEnabled, bool isRenderingToFbo );
 138
 139   /**
 140    * @copydoc Dali::Integration::Core::Render()
 141    */
 142   void Render( Integration::RenderStatus& status, bool forceClear );
 143
 144   /**
 145    * @copydoc Dali::Integration::Core::SceneCreated()
 146    */
 147   void SceneCreated();
 148
 149   /**
 150    * @copydoc Dali::Integration::Core::QueueEvent(const Integration::Event&)
 151    */
 152   void QueueEvent( const Integration::Event& event );
 153
 154   /**
 155    * @copydoc Dali::Integration::Core::ProcessEvents()
 156    */
 157   void ProcessEvents();
 158
 159   /**
 160    * @copydoc Dali::Integration::Core::GetMaximumUpdateCount()
 161    */
 162   uint32_t GetMaximumUpdateCount() const;
 163
 164   /**
 165    * @copydoc Dali::Integration::Core::RegisterProcessor
 166    */
 167   void RegisterProcessor( Dali::Integration::Processor& processor );
 168
 169   /**
 170    * @copydoc Dali::Integration::Core::UnregisterProcessor
 171    */
 172   void UnregisterProcessor( Dali::Integration::Processor& processor );
 173
 174   /**
 175    * @copydoc Dali::Internal::ThreadLocalStorage::AddScene()
 176    */
 177   void AddScene( Scene* scene );
 178
 179   /**
 180    * @copydoc Dali::Internal::ThreadLocalStorage::RemoveScene()
 181    */
 182   void RemoveScene( Scene* scene );
 183
 184 public: // Implementation of EventThreadServices
 185
 186   /**
 187    * @copydoc EventThreadServices::RegisterObject
 188    */
 189   void RegisterObject( BaseObject* object) override;
 190
 191   /**
 192    * @copydoc EventThreadServices::UnregisterObject
 193    */
 194   void UnregisterObject( BaseObject* object) override;
 195
 196   /**
 197    * @copydoc EventThreadServices::GetUpdateManager
 198    */
 199   SceneGraph::UpdateManager& GetUpdateManager() override;
 200
 201   /**
 202    * @copydoc EventThreadServices::GetRenderController
 203    */
 204   Integration::RenderController& GetRenderController() override;
 205
 206   /**
 207    * @copydoc EventThreadServices::ReserveMessageSlot
 208    */
 209   uint32_t* ReserveMessageSlot( uint32_t size, bool updateScene ) override;
 210
 211   /**
 212    * @copydoc EventThreadServices::GetEventBufferIndex
 213    */
 214   BufferIndex GetEventBufferIndex() const override;
 215
 216   /**
 217    * @copydoc EventThreadServices::ForceNextUpdate
 218    */
 219   void ForceNextUpdate() override;
 220
 221   /**
 222    * @copydoc EventThreadServices::IsNextUpdateForced
 223    */
 224   bool IsNextUpdateForced() override;
 225
 226 private:
 227   /**
 228    * Run each registered processor
 229    */
 230   void RunProcessors();
 231
 232   // for use by ThreadLocalStorage
 233
 234   /**
 235    * Returns the current stage.
 236    * @return A smart-pointer to the current stage.
 237    */
 238   StagePtr GetCurrentStage();
 239
 240   /**
 241    * Returns the platform abstraction.
 242    * @return A reference to the platform abstraction.
 243    */
 244   Integration::PlatformAbstraction& GetPlatform();
 245
 246   /**
 247    * Returns the render manager.
 248    * @return A reference to the render manager.
 249    */
 250   SceneGraph::RenderManager& GetRenderManager();
 251
 252   /**
 253    * Returns the notification manager.
 254    * @return A reference to the Notification Manager.
 255    */
 256   NotificationManager& GetNotificationManager();
 257
 258   /**
 259    * Returns the Shader factory
 260    * @return A reference to the Shader binary factory.
 261    */
 262   ShaderFactory& GetShaderFactory();
 263
 264   /**
 265    * Returns the gesture event processor.
 266    * @return A reference to the gesture event processor.
 267    */
 268   GestureEventProcessor& GetGestureEventProcessor();
 269
 270   /**
 271    * Return the relayout controller
 272    * @Return Return a reference to the relayout controller
 273    */
 274   RelayoutController& GetRelayoutController();
 275
 276   /**
 277    * @brief Gets the Object registry.
 278    * @return A reference to the object registry
 279    */
 280   ObjectRegistry& GetObjectRegistry() const;
 281
 282   /**
 283    * @brief Gets the event thread services.
 284    * @return A reference to the event thread services
 285    */
 286   EventThreadServices& GetEventThreadServices();
 287
 288   /**
 289    * @brief Gets the property notification manager.
 290    * @return A reference to the property notification manager
 291    */
 292   PropertyNotificationManager& GetPropertyNotificationManager() const;
 293
 294   /**
 295    * @brief Gets the animation play list.
 296    * @return A reference to the animation play list
 297    */
 298   AnimationPlaylist& GetAnimationPlaylist() const;
 299
 300 private:
 301
 302   /**
 303    * Undefined copy and assignment operators
 304    */
 305   Core(const Core& core) = delete;  // No definition
 306   Core& operator=(const Core& core) = delete;  // No definition
 307
 308   /**
 309    * Create Thread local storage
 310    */
 311   void CreateThreadLocalStorage();
 312
 313 private:
 314
 315   Integration::RenderController&            mRenderController;            ///< Reference to Render controller to tell it to keep rendering
 316   Integration::PlatformAbstraction&         mPlatform;                    ///< The interface providing platform specific services.
 317
 318   IntrusivePtr<Stage>                       mStage;                       ///< The current stage
 319   AnimationPlaylistOwner                    mAnimationPlaylist;           ///< For 'Fire and forget' animation support
 320   OwnerPointer<PropertyNotificationManager> mPropertyNotificationManager; ///< For safe signal emmision of property changed notifications
 321   IntrusivePtr< RelayoutController >        mRelayoutController;          ///< Size negotiation relayout controller
 322
 323   OwnerPointer<SceneGraph::RenderTaskProcessor> mRenderTaskProcessor;         ///< Handles the processing of render tasks
 324   OwnerPointer<SceneGraph::RenderManager>       mRenderManager;               ///< Render manager
 325   OwnerPointer<SceneGraph::UpdateManager>       mUpdateManager;               ///< Update manager
 326   OwnerPointer<SceneGraph::DiscardQueue>        mDiscardQueue;                ///< Used to cleanup nodes & resources when no longer in use.
 327   OwnerPointer<ShaderFactory>                   mShaderFactory;               ///< Shader resource factory
 328   OwnerPointer<NotificationManager>             mNotificationManager;         ///< Notification manager
 329   OwnerPointer<GestureEventProcessor>           mGestureEventProcessor;       ///< The gesture event processor
 330   Dali::Vector<Integration::Processor*>         mProcessors;                  ///< Registered processors (not owned)
 331
 332   using SceneContainer = std::vector<ScenePtr>;
 333   SceneContainer                                mScenes;                      ///< A container of scenes that bound to a surface for rendering, owned by Core
 334
 335   // The object registry
 336   ObjectRegistryPtr                             mObjectRegistry;
 337
 338   bool                                      mProcessingEvent  : 1;        ///< True during ProcessEvents()
 339   bool                                      mForceNextUpdate:1;           ///< True if the next rendering is really required.
 340
 341   friend class ThreadLocalStorage;
 342
 343 };
 344
 345 } // namespace Internal
 346
 347 } // namespace Dali
 348
 349 #endif // DALI_INTERNAL_CORE_H