dali/internal/update/manager/update-manager.cpp

   1 /*
   2  * Copyright (c) 2023 Samsung Electronics Co., Ltd.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  *
  16  */
  17
  18 // CLASS HEADER
  19 #include <dali/internal/update/manager/update-manager.h>
  20
  21 // INTERNAL INCLUDES
  22 #include <dali/integration-api/core.h>
  23
  24 #include <dali/internal/common/owner-key-container.h>
  25
  26 #include <dali/internal/event/animation/animation-playlist.h>
  27 #include <dali/internal/event/common/notification-manager.h>
  28 #include <dali/internal/event/common/property-notifier.h>
  29 #include <dali/internal/event/effects/shader-factory.h>
  30
  31 #include <dali/internal/update/common/discard-queue.h>
  32 #include <dali/internal/update/controllers/render-message-dispatcher.h>
  33 #include <dali/internal/update/controllers/scene-controller-impl.h>
  34 #include <dali/internal/update/manager/frame-callback-processor.h>
  35 #include <dali/internal/update/manager/render-task-processor.h>
  36 #include <dali/internal/update/manager/transform-manager.h>
  37 #include <dali/internal/update/manager/update-algorithms.h>
  38 #include <dali/internal/update/manager/update-manager-debug.h>
  39 #include <dali/internal/update/nodes/node.h>
  40 #include <dali/internal/update/queue/update-message-queue.h>
  41
  42 #include <dali/internal/render/common/render-manager.h>
  43 #include <dali/internal/render/queue/render-queue.h>
  44
  45 // Un-comment to enable node tree debug logging
  46 //#define NODE_TREE_LOGGING 1
  47
  48 #if(defined(DEBUG_ENABLED) && defined(NODE_TREE_LOGGING))
  49 #define SNAPSHOT_NODE_LOGGING                                                   \
  50   const uint32_t FRAME_COUNT_TRIGGER = 16;                                      \
  51   if(mImpl->frameCounter >= FRAME_COUNT_TRIGGER)                                \
  52   {                                                                             \
  53     for(auto&& scene : mImpl->scenes)                                           \
  54     {                                                                           \
  55       if(scene && scene->root)                                                  \
  56       {                                                                         \
  57         mImpl->frameCounter = 0;                                                \
  58         PrintNodes(*scene->root, mSceneGraphBuffers.GetUpdateBufferIndex(), 0); \
  59       }                                                                         \
  60     }                                                                           \
  61   }                                                                             \
  62   mImpl->frameCounter++;
  63 #else
  64 #define SNAPSHOT_NODE_LOGGING
  65 #endif
  66
  67 #if defined(DEBUG_ENABLED)
  68 extern Debug::Filter* gRenderTaskLogFilter;
  69 namespace
  70 {
  71 Debug::Filter* gLogFilter = Debug::Filter::New(Debug::NoLogging, false, "LOG_UPDATE_MANAGER");
  72 } // unnamed namespace
  73 #endif
  74
  75 using namespace Dali::Integration;
  76 using Dali::Internal::Update::MessageQueue;
  77
  78 namespace Dali
  79 {
  80 namespace Internal
  81 {
  82 namespace SceneGraph
  83 {
  84 namespace
  85 {
  86 /**
  87  * Helper to Erase an object from OwnerContainer using discard queue
  88  * @param container to remove from
  89  * @param object to remove
  90  * @param discardQueue to put the object to
  91  * @param updateBufferIndex to use
  92  */
  93 template<class Type>
  94 inline void EraseUsingDiscardQueue(OwnerContainer<Type*>& container, Type* object, DiscardQueue<Type*, OwnerContainer<Type*>>& discardQueue, BufferIndex updateBufferIndex)
  95 {
  96   DALI_ASSERT_DEBUG(object && "NULL object not allowed");
  97
  98   // need to use the reference version of auto as we need the pointer to the pointer for the Release call below
  99   for(auto&& iter : container)
 100   {
 101     if(iter == object)
 102     {
 103       // Transfer ownership to the discard queue, this keeps the object alive, until the render-thread has finished with it
 104       discardQueue.Add(updateBufferIndex, container.Release(&iter)); // take the address of the reference to a pointer (iter)
 105       return;                                                        // return as we only ever remove one object. Iterators to container are now invalidated as well so cannot continue
 106     }
 107   }
 108 }
 109
 110 /**
 111  * Helper to Erase an object from std::vector using discard queue
 112  * @param container to remove from
 113  * @param object to remove
 114  * @param discardQueue to put the object to
 115  * @param updateBufferIndex to use
 116  */
 117 template<class Type>
 118 inline void EraseUsingDiscardQueue(OwnerKeyContainer<Type>& container, const MemoryPoolKey<Type>& key, DiscardQueue<MemoryPoolKey<Type>, OwnerKeyContainer<Type>>& discardQueue, BufferIndex updateBufferIndex)
 119 {
 120   DALI_ASSERT_DEBUG(key && "INVALID Key not allowed");
 121
 122   for(auto iter = container.begin(), end = container.end(); iter != end; ++iter)
 123   {
 124     if(*iter == key)
 125     {
 126       // Transfer ownership to the discard queue, this keeps the object alive, until the render-thread has finished with it
 127       discardQueue.Add(updateBufferIndex, container.Release(iter));
 128       return; // return as we only ever remove one object. Iterators to container are now invalidated as well so cannot continue
 129     }
 130   }
 131 }
 132
 133 } // unnamed namespace
 134
 135 /**
 136  * Structure to contain UpdateManager internal data
 137  */
 138 struct UpdateManager::Impl
 139 {
 140   // SceneInfo keeps the root node of the Scene, its scene graph render task list, and the list of Layer pointers sorted by depth
 141   struct SceneInfo
 142   {
 143     SceneInfo(Layer* root) ///< Constructor
 144     : root(root)
 145     {
 146     }
 147
 148     ~SceneInfo()               = default;                ///< Default non-virtual destructor
 149     SceneInfo(SceneInfo&& rhs) = default;                ///< Move constructor
 150     SceneInfo& operator=(SceneInfo&& rhs) = default;     ///< Move assignment operator
 151     SceneInfo& operator=(const SceneInfo& rhs) = delete; ///< Assignment operator
 152     SceneInfo(const SceneInfo& rhs)            = delete; ///< Copy constructor
 153
 154     Layer*                       root{nullptr};   ///< Root node (root is a layer). The layer is not stored in the node memory pool.
 155     OwnerPointer<RenderTaskList> taskList;        ///< Scene graph render task list
 156     SortedLayerPointers          sortedLayerList; ///< List of Layer pointers sorted by depth (one list of sorted layers per root)
 157     OwnerPointer<Scene>          scene;           ///< Scene graph object of the scene
 158   };
 159
 160   Impl(NotificationManager&           notificationManager,
 161        CompleteNotificationInterface& animationPlaylist,
 162        PropertyNotifier&              propertyNotifier,
 163        RenderController&              renderController,
 164        RenderManager&                 renderManager,
 165        RenderQueue&                   renderQueue,
 166        SceneGraphBuffers&             sceneGraphBuffers,
 167        RenderTaskProcessor&           renderTaskProcessor)
 168   : renderMessageDispatcher(renderManager, renderQueue, sceneGraphBuffers),
 169     notificationManager(notificationManager),
 170     transformManager(),
 171     animationPlaylist(animationPlaylist),
 172     propertyNotifier(propertyNotifier),
 173     shaderSaver(nullptr),
 174     renderController(renderController),
 175     sceneController(nullptr),
 176     renderManager(renderManager),
 177     renderQueue(renderQueue),
 178     renderTaskProcessor(renderTaskProcessor),
 179     backgroundColor(Dali::DEFAULT_BACKGROUND_COLOR),
 180     renderers(),
 181     textureSets(),
 182     shaders(),
 183     panGestureProcessor(nullptr),
 184     messageQueue(renderController, sceneGraphBuffers),
 185     frameCallbackProcessor(nullptr),
 186     keepRenderingSeconds(0.0f),
 187     nodeDirtyFlags(NodePropertyFlags::TRANSFORM), // set to TransformFlag to ensure full update the first time through Update()
 188     frameCounter(0),
 189     renderingBehavior(DevelStage::Rendering::IF_REQUIRED),
 190     animationFinishedDuringUpdate(false),
 191     previousUpdateScene(false),
 192     renderTaskWaiting(false),
 193     renderersAdded(false),
 194     renderingRequired(false)
 195   {
 196     sceneController = new SceneControllerImpl(renderMessageDispatcher, renderQueue);
 197
 198     // create first 'dummy' node
 199     nodes.PushBack(nullptr);
 200   }
 201
 202   ~Impl()
 203   {
 204     // Disconnect render tasks from nodes, before destroying the nodes
 205     for(auto&& scene : scenes)
 206     {
 207       if(scene && scene->taskList)
 208       {
 209         RenderTaskList::RenderTaskContainer& tasks = scene->taskList->GetTasks();
 210         for(auto&& task : tasks)
 211         {
 212           task->SetSourceNode(nullptr);
 213         }
 214       }
 215     }
 216
 217     // UpdateManager owns the Nodes. Although Nodes are pool allocated they contain heap allocated parts
 218     // like custom properties, which get released here
 219     Vector<Node*>::Iterator iter    = nodes.Begin() + 1;
 220     Vector<Node*>::Iterator endIter = nodes.End();
 221     for(; iter != endIter; ++iter)
 222     {
 223       (*iter)->OnDestroy();
 224       Node::Delete(*iter);
 225     }
 226
 227     for(auto&& scene : scenes)
 228     {
 229       if(scene && scene->root)
 230       {
 231         scene->root->OnDestroy();
 232         Node::Delete(scene->root);
 233       }
 234     }
 235     scenes.clear();
 236
 237     delete sceneController;
 238
 239     // Ensure to clear renderers
 240     renderers.Clear();
 241     shaders.Clear();
 242   }
 243
 244   /**
 245    * Lazy init for FrameCallbackProcessor.
 246    * @param[in]  updateManager  A reference to the update-manager
 247    */
 248   FrameCallbackProcessor& GetFrameCallbackProcessor(UpdateManager& updateManager)
 249   {
 250     if(!frameCallbackProcessor)
 251     {
 252       frameCallbackProcessor = new FrameCallbackProcessor(updateManager, transformManager);
 253     }
 254     return *frameCallbackProcessor;
 255   }
 256
 257   SceneGraphBuffers              sceneGraphBuffers;       ///< Used to keep track of which buffers are being written or read
 258   RenderMessageDispatcher        renderMessageDispatcher; ///< Used for passing messages to the render-thread
 259   NotificationManager&           notificationManager;     ///< Queues notification messages for the event-thread.
 260   TransformManager               transformManager;        ///< Used to update the transformation matrices of the nodes
 261   CompleteNotificationInterface& animationPlaylist;       ///< Holds handles to all the animations
 262   PropertyNotifier&              propertyNotifier;        ///< Provides notification to applications when properties are modified.
 263   ShaderSaver*                   shaderSaver;             ///< Saves shader binaries.
 264   RenderController&              renderController;        ///< render controller
 265   SceneControllerImpl*           sceneController;         ///< scene controller
 266   RenderManager&                 renderManager;           ///< This is responsible for rendering the results of each "update"
 267   RenderQueue&                   renderQueue;             ///< Used to queue messages for the next render
 268   RenderTaskProcessor&           renderTaskProcessor;     ///< Handles RenderTasks and RenderInstrucitons
 269
 270   Vector4 backgroundColor; ///< The glClear color used at the beginning of each frame.
 271
 272   using SceneInfoPtr = std::unique_ptr<SceneInfo>;
 273   std::vector<SceneInfoPtr> scenes; ///< A container of SceneInfo.
 274
 275   Vector<Node*> nodes; ///< A container of all instantiated nodes
 276
 277   Vector<Camera*> cameras; ///< A container of cameras. Note : these cameras are owned by Impl::nodes.
 278
 279   OwnerContainer<PropertyOwner*> customObjects; ///< A container of owned objects (with custom properties)
 280
 281   OwnerContainer<PropertyResetterBase*> propertyResetters;     ///< A container of property resetters
 282   OwnerContainer<NodeResetter*>         nodeResetters;         ///< A container of node resetters
 283   OwnerContainer<Animation*>            animations;            ///< A container of owned animations
 284   PropertyNotificationContainer         propertyNotifications; ///< A container of owner property notifications.
 285   OwnerKeyContainer<Renderer>           renderers;             ///< A container of owned renderers
 286   OwnerContainer<TextureSet*>           textureSets;           ///< A container of owned texture sets
 287   OwnerContainer<Shader*>               shaders;               ///< A container of owned shaders
 288
 289   DiscardQueue<Node*, OwnerContainer<Node*>>                         nodeDiscardQueue; ///< Nodes are added here when disconnected from the scene-graph.
 290   DiscardQueue<Shader*, OwnerContainer<Shader*>>                     shaderDiscardQueue;
 291   DiscardQueue<MemoryPoolKey<Renderer>, OwnerKeyContainer<Renderer>> rendererDiscardQueue;
 292   DiscardQueue<Scene*, OwnerContainer<Scene*>>                       sceneDiscardQueue;
 293
 294   OwnerPointer<PanGesture> panGestureProcessor; ///< Owned pan gesture processor; it lives for the lifecycle of UpdateManager
 295
 296   MessageQueue                         messageQueue;          ///< The messages queued from the event-thread
 297   std::vector<Internal::ShaderDataPtr> renderCompiledShaders; ///< Shaders compiled on Render thread are inserted here for update thread to pass on to event thread.
 298   std::vector<Internal::ShaderDataPtr> updateCompiledShaders; ///< Shaders to be sent from Update to Event
 299   Mutex                                compiledShaderMutex;   ///< lock to ensure no corruption on the renderCompiledShaders
 300
 301   OwnerPointer<FrameCallbackProcessor> frameCallbackProcessor; ///< Owned FrameCallbackProcessor, only created if required.
 302
 303   std::atomic<std::size_t> renderInstructionCapacity{0u};
 304   float                    keepRenderingSeconds; ///< Set via Dali::Stage::KeepRendering
 305   NodePropertyFlags        nodeDirtyFlags;       ///< cumulative node dirty flags from previous frame
 306   uint32_t                 frameCounter;         ///< Frame counter used in debugging to choose which frame to debug and which to ignore.
 307   DevelStage::Rendering    renderingBehavior;    ///< Set via DevelStage::SetRenderingBehavior
 308
 309   bool animationFinishedDuringUpdate; ///< Flag whether any animations finished during the Update()
 310   bool previousUpdateScene;           ///< True if the scene was updated in the previous frame (otherwise it was optimized out)
 311   bool renderTaskWaiting;             ///< A REFRESH_ONCE render task is waiting to be rendered
 312   bool renderersAdded;                ///< Flag to keep track when renderers have been added to avoid unnecessary processing
 313   bool renderingRequired;             ///< True if required to render the current frame
 314
 315 private:
 316   Impl(const Impl&);            ///< Undefined
 317   Impl& operator=(const Impl&); ///< Undefined
 318 };
 319
 320 UpdateManager::UpdateManager(NotificationManager&           notificationManager,
 321                              CompleteNotificationInterface& animationFinishedNotifier,
 322                              PropertyNotifier&              propertyNotifier,
 323                              RenderController&              controller,
 324                              RenderManager&                 renderManager,
 325                              RenderQueue&                   renderQueue,
 326                              RenderTaskProcessor&           renderTaskProcessor)
 327 : mImpl(nullptr)
 328 {
 329   mImpl = new Impl(notificationManager,
 330                    animationFinishedNotifier,
 331                    propertyNotifier,
 332                    controller,
 333                    renderManager,
 334                    renderQueue,
 335                    mSceneGraphBuffers,
 336                    renderTaskProcessor);
 337 }
 338
 339 UpdateManager::~UpdateManager()
 340 {
 341   delete mImpl;
 342 }
 343
 344 void UpdateManager::InstallRoot(OwnerPointer<Layer>& layer)
 345 {
 346   DALI_ASSERT_DEBUG(layer->IsLayer());
 347   DALI_ASSERT_DEBUG(layer->GetParent() == NULL);
 348
 349   Layer* rootLayer = layer.Release();
 350
 351   DALI_ASSERT_DEBUG(std::find_if(mImpl->scenes.begin(), mImpl->scenes.end(), [rootLayer](Impl::SceneInfoPtr& scene) { return scene && scene->root == rootLayer; }) == mImpl->scenes.end() &&
 352                     "Root Node already installed");
 353
 354   rootLayer->CreateTransform(&mImpl->transformManager);
 355   rootLayer->SetRoot(true);
 356
 357   AddNodeResetter(*rootLayer);
 358
 359   mImpl->scenes.emplace_back(new Impl::SceneInfo(rootLayer));
 360 }
 361
 362 void UpdateManager::UninstallRoot(Layer* layer)
 363 {
 364   DALI_ASSERT_DEBUG(layer->IsLayer());
 365   DALI_ASSERT_DEBUG(layer->GetParent() == NULL);
 366
 367   for(auto iter = mImpl->scenes.begin(); iter != mImpl->scenes.end(); ++iter)
 368   {
 369     if((*iter) && (*iter)->root == layer)
 370     {
 371       mImpl->scenes.erase(iter);
 372       break;
 373     }
 374   }
 375
 376   mImpl->nodeDiscardQueue.Add(mSceneGraphBuffers.GetUpdateBufferIndex(), layer);
 377
 378   // Notify the layer about impending destruction
 379   layer->OnDestroy();
 380 }
 381
 382 void UpdateManager::AddNode(OwnerPointer<Node>& node)
 383 {
 384   DALI_ASSERT_ALWAYS(nullptr == node->GetParent()); // Should not have a parent yet
 385
 386   Node* rawNode = node.Release();
 387   DALI_LOG_INFO(gLogFilter, Debug::General, "[%x] AddNode\n", rawNode);
 388
 389   // Add camera nodes occured rarely.
 390   if(DALI_UNLIKELY(rawNode->IsCamera()))
 391   {
 392     AddCamera(static_cast<Camera*>(rawNode));
 393   }
 394
 395   mImpl->nodes.PushBack(rawNode);
 396   rawNode->CreateTransform(&mImpl->transformManager);
 397 }
 398
 399 void UpdateManager::ConnectNode(Node* parent, Node* node)
 400 {
 401   DALI_ASSERT_ALWAYS(nullptr != parent);
 402   DALI_ASSERT_ALWAYS(nullptr != node);
 403   DALI_ASSERT_ALWAYS(nullptr == node->GetParent()); // Should not have a parent yet
 404
 405   DALI_LOG_INFO(gLogFilter, Debug::General, "[%x] ConnectNode\n", node);
 406
 407   parent->ConnectChild(node);
 408
 409   AddNodeResetter(*node);
 410
 411   // Inform the frame-callback-processor, if set, about the node-hierarchy changing
 412   if(mImpl->frameCallbackProcessor)
 413   {
 414     mImpl->frameCallbackProcessor->NodeHierarchyChanged();
 415   }
 416 }
 417
 418 void UpdateManager::DisconnectNode(Node* node)
 419 {
 420   DALI_LOG_INFO(gLogFilter, Debug::General, "[%x] DisconnectNode\n", node);
 421
 422   Node* parent = node->GetParent();
 423   DALI_ASSERT_ALWAYS(nullptr != parent);
 424   parent->SetDirtyFlag(NodePropertyFlags::CHILD_DELETED); // make parent dirty so that render items dont get reused
 425
 426   parent->DisconnectChild(mSceneGraphBuffers.GetUpdateBufferIndex(), *node);
 427
 428   // Inform the frame-callback-processor, if set, about the node-hierarchy changing
 429   if(mImpl->frameCallbackProcessor)
 430   {
 431     mImpl->frameCallbackProcessor->NodeHierarchyChanged();
 432   }
 433 }
 434
 435 void UpdateManager::DestroyNode(Node* node)
 436 {
 437   DALI_ASSERT_ALWAYS(nullptr != node);
 438   DALI_ASSERT_ALWAYS(nullptr == node->GetParent()); // Should have been disconnected
 439
 440   DALI_LOG_INFO(gLogFilter, Debug::General, "[%x] DestroyNode\n", node);
 441
 442   Vector<Node*>::Iterator iter    = mImpl->nodes.Begin() + 1;
 443   Vector<Node*>::Iterator endIter = mImpl->nodes.End();
 444   for(; iter != endIter; ++iter)
 445   {
 446     if((*iter) == node)
 447     {
 448       mImpl->nodes.Erase(iter);
 449       break;
 450     }
 451   }
 452
 453   // Remove camera nodes occured rarely.
 454   if(DALI_UNLIKELY(node->IsCamera()))
 455   {
 456     RemoveCamera(static_cast<Camera*>(node));
 457   }
 458
 459   mImpl->nodeDiscardQueue.Add(mSceneGraphBuffers.GetUpdateBufferIndex(), node);
 460
 461   // Notify the Node about impending destruction
 462   node->OnDestroy();
 463 }
 464
 465 void UpdateManager::AddCamera(Camera* camera)
 466 {
 467   DALI_LOG_INFO(gLogFilter, Debug::General, "[%x] AddCamera\n", camera);
 468
 469   mImpl->cameras.PushBack(camera);
 470 }
 471
 472 void UpdateManager::RemoveCamera(Camera* camera)
 473 {
 474   DALI_LOG_INFO(gLogFilter, Debug::General, "[%x] RemoveCamera\n", camera);
 475
 476   // Find the camera and remove it from list of cameras
 477   Vector<Camera*>::Iterator iter    = mImpl->cameras.Begin();
 478   Vector<Camera*>::Iterator endIter = mImpl->cameras.End();
 479   for(; iter != endIter; ++iter)
 480   {
 481     if((*iter) == camera)
 482     {
 483       mImpl->cameras.Erase(iter);
 484       break;
 485     }
 486   }
 487 }
 488
 489 void UpdateManager::AddObject(OwnerPointer<PropertyOwner>& object)
 490 {
 491   mImpl->customObjects.PushBack(object.Release());
 492 }
 493
 494 void UpdateManager::RemoveObject(PropertyOwner* object)
 495 {
 496   mImpl->customObjects.EraseObject(object);
 497 }
 498
 499 void UpdateManager::AddRenderTaskList(OwnerPointer<RenderTaskList>& taskList)
 500 {
 501   RenderTaskList* taskListPointer = taskList.Release();
 502   taskListPointer->SetRenderMessageDispatcher(&mImpl->renderMessageDispatcher);
 503
 504   mImpl->scenes.back()->taskList = taskListPointer;
 505 }
 506
 507 void UpdateManager::RemoveRenderTaskList(RenderTaskList* taskList)
 508 {
 509   for(auto&& scene : mImpl->scenes)
 510   {
 511     if(scene && scene->taskList == taskList)
 512     {
 513       scene->taskList.Reset();
 514       break;
 515     }
 516   }
 517 }
 518
 519 void UpdateManager::AddScene(OwnerPointer<Scene>& scene)
 520 {
 521   auto& sceneInfo  = mImpl->scenes.back();
 522   sceneInfo->scene = scene.Release();
 523
 524   // Set root to the Scene
 525   sceneInfo->scene->SetRoot(sceneInfo->root);
 526
 527   // Initialize the context from render manager
 528   typedef MessageValue1<RenderManager, SceneGraph::Scene*> DerivedType;
 529
 530   // Reserve some memory inside the render queue
 531   uint32_t* slot = mImpl->renderQueue.ReserveMessageSlot(mSceneGraphBuffers.GetUpdateBufferIndex(), sizeof(DerivedType));
 532
 533   // Construct message in the render queue memory; note that delete should not be called on the return value
 534   SceneGraph::Scene& sceneObject = *sceneInfo->scene;
 535   new(slot) DerivedType(&mImpl->renderManager, &RenderManager::InitializeScene, &sceneObject);
 536 }
 537
 538 void UpdateManager::RemoveScene(Scene* scene)
 539 {
 540   // Initialize the context from render manager
 541   using DerivedType = MessageValue1<RenderManager, SceneGraph::Scene*>;
 542
 543   // Reserve some memory inside the render queue
 544   uint32_t* slot = mImpl->renderQueue.ReserveMessageSlot(mSceneGraphBuffers.GetUpdateBufferIndex(), sizeof(DerivedType));
 545
 546   // Construct message in the render queue memory; note that delete should not be called on the return value
 547   new(slot) DerivedType(&mImpl->renderManager, &RenderManager::UninitializeScene, scene);
 548
 549   for(auto&& sceneInfo : mImpl->scenes)
 550   {
 551     if(sceneInfo && sceneInfo->scene && sceneInfo->scene.Get() == scene)
 552     {
 553       mImpl->sceneDiscardQueue.Add(mSceneGraphBuffers.GetUpdateBufferIndex(), sceneInfo->scene.Release()); // take the address of the reference to a pointer
 554       break;
 555     }
 556   }
 557 }
 558
 559 void UpdateManager::AddAnimation(OwnerPointer<SceneGraph::Animation>& animation)
 560 {
 561   mImpl->animations.PushBack(animation.Release());
 562 }
 563
 564 void UpdateManager::StopAnimation(Animation* animation)
 565 {
 566   DALI_ASSERT_DEBUG(animation && "NULL animation called to stop");
 567
 568   bool animationFinished = animation->Stop(mSceneGraphBuffers.GetUpdateBufferIndex());
 569
 570   mImpl->animationFinishedDuringUpdate = mImpl->animationFinishedDuringUpdate || animationFinished;
 571 }
 572
 573 void UpdateManager::RemoveAnimation(Animation* animation)
 574 {
 575   DALI_ASSERT_DEBUG(animation && "NULL animation called to remove");
 576
 577   animation->OnDestroy(mSceneGraphBuffers.GetUpdateBufferIndex());
 578
 579   DALI_ASSERT_DEBUG(animation->GetState() == Animation::Destroyed);
 580 }
 581
 582 bool UpdateManager::IsAnimationRunning() const
 583 {
 584   // Find any animation that isn't stopped or paused
 585   for(auto&& iter : mImpl->animations)
 586   {
 587     const Animation::State state = iter->GetState();
 588
 589     if(state != Animation::Stopped &&
 590        state != Animation::Paused)
 591     {
 592       return true; // stop iteration as soon as first one is found
 593     }
 594   }
 595
 596   return false;
 597 }
 598
 599 void UpdateManager::AddPropertyResetter(OwnerPointer<PropertyResetterBase>& propertyResetter)
 600 {
 601   propertyResetter->Initialize();
 602   mImpl->propertyResetters.PushBack(propertyResetter.Release());
 603 }
 604
 605 void UpdateManager::AddNodeResetter(const Node& node)
 606 {
 607   OwnerPointer<SceneGraph::NodeResetter> nodeResetter = SceneGraph::NodeResetter::New(node);
 608   nodeResetter->Initialize();
 609   mImpl->nodeResetters.PushBack(nodeResetter.Release());
 610 }
 611
 612 void UpdateManager::AddPropertyNotification(OwnerPointer<PropertyNotification>& propertyNotification)
 613 {
 614   mImpl->propertyNotifications.PushBack(propertyNotification.Release());
 615 }
 616
 617 void UpdateManager::RemovePropertyNotification(PropertyNotification* propertyNotification)
 618 {
 619   mImpl->propertyNotifications.EraseObject(propertyNotification);
 620 }
 621
 622 void UpdateManager::PropertyNotificationSetNotify(PropertyNotification* propertyNotification, PropertyNotification::NotifyMode notifyMode)
 623 {
 624   DALI_ASSERT_DEBUG(propertyNotification && "propertyNotification scene graph object missing");
 625   propertyNotification->SetNotifyMode(notifyMode);
 626 }
 627
 628 void UpdateManager::AddShader(OwnerPointer<Shader>& shader)
 629 {
 630   mImpl->shaders.PushBack(shader.Release());
 631 }
 632
 633 void UpdateManager::RemoveShader(Shader* shader)
 634 {
 635   // Find the shader and destroy it
 636   EraseUsingDiscardQueue(mImpl->shaders, shader, mImpl->shaderDiscardQueue, mSceneGraphBuffers.GetUpdateBufferIndex());
 637 }
 638
 639 void UpdateManager::SaveBinary(Internal::ShaderDataPtr shaderData)
 640 {
 641   DALI_ASSERT_DEBUG(shaderData && "No NULL shader data pointers please.");
 642   DALI_ASSERT_DEBUG(shaderData->GetBufferSize() > 0 && "Shader binary empty so nothing to save.");
 643   {
 644     // lock as update might be sending previously compiled shaders to event thread
 645     Mutex::ScopedLock lock(mImpl->compiledShaderMutex);
 646     mImpl->renderCompiledShaders.push_back(shaderData);
 647   }
 648 }
 649
 650 void UpdateManager::SetShaderSaver(ShaderSaver& upstream)
 651 {
 652   mImpl->shaderSaver = &upstream;
 653 }
 654
 655 void UpdateManager::AddRenderer(const RendererKey& rendererKey)
 656 {
 657   SceneGraph::Renderer* renderer = rendererKey.Get();
 658
 659   DALI_LOG_INFO(gLogFilter, Debug::General, "[%x] AddRenderer\n", renderer);
 660
 661   renderer->ConnectToSceneGraph(*mImpl->sceneController, mSceneGraphBuffers.GetUpdateBufferIndex());
 662   mImpl->renderers.PushBack(rendererKey);
 663 }
 664
 665 void UpdateManager::RemoveRenderer(const RendererKey& rendererKey)
 666 {
 667   DALI_LOG_INFO(gLogFilter, Debug::General, "[%x] RemoveRenderer\n", rendererKey.Get());
 668
 669   // Find the renderer and destroy it
 670   EraseUsingDiscardQueue(mImpl->renderers, rendererKey, mImpl->rendererDiscardQueue, mSceneGraphBuffers.GetUpdateBufferIndex());
 671   // Need to remove the render object as well
 672   rendererKey->DisconnectFromSceneGraph(*mImpl->sceneController, mSceneGraphBuffers.GetUpdateBufferIndex());
 673 }
 674
 675 void UpdateManager::AttachRenderer(Node* node, Renderer* renderer)
 676 {
 677   node->AddRenderer(Renderer::GetKey(renderer));
 678   mImpl->renderersAdded = true;
 679 }
 680
 681 void UpdateManager::SetPanGestureProcessor(PanGesture* panGestureProcessor)
 682 {
 683   DALI_ASSERT_DEBUG(NULL != panGestureProcessor);
 684
 685   mImpl->panGestureProcessor = panGestureProcessor;
 686 }
 687
 688 void UpdateManager::AddTextureSet(OwnerPointer<TextureSet>& textureSet)
 689 {
 690   mImpl->textureSets.PushBack(textureSet.Release());
 691 }
 692
 693 void UpdateManager::RemoveTextureSet(TextureSet* textureSet)
 694 {
 695   mImpl->textureSets.EraseObject(textureSet);
 696 }
 697
 698 uint32_t* UpdateManager::ReserveMessageSlot(uint32_t size, bool updateScene)
 699 {
 700   return mImpl->messageQueue.ReserveMessageSlot(size, updateScene);
 701 }
 702
 703 std::size_t UpdateManager::GetUpdateMessageQueueCapacity() const
 704 {
 705   return mImpl->messageQueue.GetCapacity();
 706 }
 707
 708 std::size_t UpdateManager::GetRenderMessageQueueCapacity() const
 709 {
 710   return mImpl->renderQueue.GetCapacity();
 711 }
 712
 713 std::size_t UpdateManager::GetRenderInstructionCapacity() const
 714 {
 715   return mImpl->renderInstructionCapacity;
 716 }
 717
 718 void UpdateManager::EventProcessingStarted()
 719 {
 720   mImpl->messageQueue.EventProcessingStarted();
 721 }
 722
 723 bool UpdateManager::FlushQueue()
 724 {
 725   return mImpl->messageQueue.FlushQueue();
 726 }
 727
 728 void UpdateManager::ResetProperties(BufferIndex bufferIndex)
 729 {
 730   // Clear the "animations finished" flag; This should be set if any (previously playing) animation is stopped
 731   mImpl->animationFinishedDuringUpdate = false;
 732
 733   // Reset node properties
 734   std::vector<NodeResetter*> nodeResetterToDelete;
 735   for(auto&& element : mImpl->nodeResetters)
 736   {
 737     element->ResetToBaseValue(bufferIndex);
 738     if(element->IsFinished())
 739     {
 740       nodeResetterToDelete.push_back(element);
 741     }
 742   }
 743
 744   // If a node resetter is no longer required, delete it.
 745   for(auto&& elementPtr : nodeResetterToDelete)
 746   {
 747     mImpl->nodeResetters.EraseObject(elementPtr);
 748   }
 749
 750   // Reset all animating / constrained properties
 751   std::vector<PropertyResetterBase*> propertyResettertoDelete;
 752   for(auto&& element : mImpl->propertyResetters)
 753   {
 754     element->ResetToBaseValue(bufferIndex);
 755     if(element->IsFinished())
 756     {
 757       propertyResettertoDelete.push_back(element);
 758     }
 759   }
 760
 761   // If a property resetter is no longer required (the animator or constraint has been removed), delete it.
 762   for(auto&& elementPtr : propertyResettertoDelete)
 763   {
 764     mImpl->propertyResetters.EraseObject(elementPtr);
 765   }
 766
 767   // Clear all root nodes dirty flags
 768   for(auto& scene : mImpl->scenes)
 769   {
 770     auto root = scene->root;
 771     root->ResetDirtyFlags(bufferIndex);
 772   }
 773
 774   // Clear node dirty flags
 775   Vector<Node*>::Iterator iter    = mImpl->nodes.Begin() + 1;
 776   Vector<Node*>::Iterator endIter = mImpl->nodes.End();
 777   for(; iter != endIter; ++iter)
 778   {
 779     (*iter)->ResetDirtyFlags(bufferIndex);
 780   }
 781 }
 782
 783 bool UpdateManager::ProcessGestures(BufferIndex bufferIndex, uint32_t lastVSyncTimeMilliseconds, uint32_t nextVSyncTimeMilliseconds)
 784 {
 785   bool gestureUpdated(false);
 786
 787   if(mImpl->panGestureProcessor)
 788   {
 789     // gesture processor only supports default properties
 790     mImpl->panGestureProcessor->ResetDefaultProperties(bufferIndex); // Needs to be done every time as gesture data is written directly to an update-buffer rather than via a message
 791     gestureUpdated |= mImpl->panGestureProcessor->UpdateProperties(lastVSyncTimeMilliseconds, nextVSyncTimeMilliseconds);
 792   }
 793
 794   return gestureUpdated;
 795 }
 796
 797 bool UpdateManager::Animate(BufferIndex bufferIndex, float elapsedSeconds)
 798 {
 799   bool animationActive = false;
 800
 801   auto&& iter            = mImpl->animations.Begin();
 802   bool   animationLooped = false;
 803
 804   while(iter != mImpl->animations.End())
 805   {
 806     Animation* animation             = *iter;
 807     bool       finished              = false;
 808     bool       looped                = false;
 809     bool       progressMarkerReached = false;
 810     animation->Update(bufferIndex, elapsedSeconds, looped, finished, progressMarkerReached);
 811
 812     animationActive = animationActive || animation->IsActive();
 813
 814     if(progressMarkerReached)
 815     {
 816       mImpl->notificationManager.QueueMessage(Internal::NotifyProgressReachedMessage(mImpl->animationPlaylist, animation));
 817     }
 818
 819     mImpl->animationFinishedDuringUpdate = mImpl->animationFinishedDuringUpdate || finished;
 820     animationLooped                      = animationLooped || looped;
 821
 822     // Remove animations that had been destroyed but were still waiting for an update
 823     if(animation->GetState() == Animation::Destroyed)
 824     {
 825       iter = mImpl->animations.Erase(iter);
 826     }
 827     else
 828     {
 829       ++iter;
 830     }
 831   }
 832
 833   // queue the notification on finished or looped (to update loop count)
 834   if(mImpl->animationFinishedDuringUpdate || animationLooped)
 835   {
 836     // The application should be notified by NotificationManager, in another thread
 837     mImpl->notificationManager.QueueCompleteNotification(&mImpl->animationPlaylist);
 838   }
 839
 840   return animationActive;
 841 }
 842
 843 void UpdateManager::ConstrainCustomObjects(BufferIndex bufferIndex)
 844 {
 845   // Constrain custom objects (in construction order)
 846   for(auto&& object : mImpl->customObjects)
 847   {
 848     ConstrainPropertyOwner(*object, bufferIndex);
 849   }
 850 }
 851
 852 void UpdateManager::ConstrainRenderTasks(BufferIndex bufferIndex)
 853 {
 854   // Constrain render-tasks
 855   for(auto&& scene : mImpl->scenes)
 856   {
 857     if(scene && scene->taskList)
 858     {
 859       RenderTaskList::RenderTaskContainer& tasks = scene->taskList->GetTasks();
 860       for(auto&& task : tasks)
 861       {
 862         ConstrainPropertyOwner(*task, bufferIndex);
 863       }
 864     }
 865   }
 866 }
 867
 868 void UpdateManager::ConstrainShaders(BufferIndex bufferIndex)
 869 {
 870   // constrain shaders... (in construction order)
 871   for(auto&& shader : mImpl->shaders)
 872   {
 873     ConstrainPropertyOwner(*shader, bufferIndex);
 874   }
 875 }
 876
 877 void UpdateManager::ProcessPropertyNotifications(BufferIndex bufferIndex)
 878 {
 879   for(auto&& notification : mImpl->propertyNotifications)
 880   {
 881     bool valid = notification->Check(bufferIndex);
 882     if(valid)
 883     {
 884       mImpl->notificationManager.QueueMessage(PropertyChangedMessage(mImpl->propertyNotifier, notification, notification->GetValidity()));
 885     }
 886   }
 887 }
 888
 889 void UpdateManager::ForwardCompiledShadersToEventThread()
 890 {
 891   DALI_ASSERT_DEBUG((mImpl->shaderSaver != 0) && "shaderSaver should be wired-up during startup.");
 892   if(mImpl->shaderSaver)
 893   {
 894     // lock and swap the queues
 895     {
 896       // render might be attempting to send us more binaries at the same time
 897       Mutex::ScopedLock lock(mImpl->compiledShaderMutex);
 898       mImpl->renderCompiledShaders.swap(mImpl->updateCompiledShaders);
 899     }
 900
 901     if(mImpl->updateCompiledShaders.size() > 0)
 902     {
 903       ShaderSaver& factory = *mImpl->shaderSaver;
 904       for(auto&& shader : mImpl->updateCompiledShaders)
 905       {
 906         mImpl->notificationManager.QueueMessage(ShaderCompiledMessage(factory, shader));
 907       }
 908       // we don't need them in update anymore
 909       mImpl->updateCompiledShaders.clear();
 910     }
 911   }
 912 }
 913
 914 void UpdateManager::UpdateRenderers(BufferIndex bufferIndex)
 915 {
 916   for(auto rendererKey : mImpl->renderers)
 917   {
 918     // Apply constraints
 919     auto renderer = rendererKey.Get();
 920     ConstrainPropertyOwner(*renderer, bufferIndex);
 921
 922     mImpl->renderingRequired = renderer->PrepareRender(bufferIndex) || mImpl->renderingRequired;
 923   }
 924 }
 925
 926 void UpdateManager::UpdateNodes(BufferIndex bufferIndex)
 927 {
 928   mImpl->nodeDirtyFlags = NodePropertyFlags::NOTHING;
 929
 930   for(auto&& scene : mImpl->scenes)
 931   {
 932     if(scene && scene->root)
 933     {
 934       // Prepare resources, update shaders, for each node
 935       // And add the renderers to the sorted layers. Start from root, which is also a layer
 936       mImpl->nodeDirtyFlags |= UpdateNodeTree(*scene->root,
 937                                               bufferIndex,
 938                                               mImpl->renderQueue);
 939     }
 940   }
 941 }
 942
 943 void UpdateManager::UpdateLayers(BufferIndex bufferIndex)
 944 {
 945   for(auto&& scene : mImpl->scenes)
 946   {
 947     if(scene && scene->root)
 948     {
 949       SceneGraph::UpdateLayerTree(*scene->root, bufferIndex);
 950     }
 951   }
 952 }
 953
 954 uint32_t UpdateManager::Update(float    elapsedSeconds,
 955                                uint32_t lastVSyncTimeMilliseconds,
 956                                uint32_t nextVSyncTimeMilliseconds,
 957                                bool     renderToFboEnabled,
 958                                bool     isRenderingToFbo,
 959                                bool     uploadOnly)
 960 {
 961   const BufferIndex bufferIndex = mSceneGraphBuffers.GetUpdateBufferIndex();
 962
 963   // Clear nodes/resources which were previously discarded
 964   mImpl->nodeDiscardQueue.Clear(bufferIndex);
 965   mImpl->shaderDiscardQueue.Clear(bufferIndex);
 966   mImpl->rendererDiscardQueue.Clear(bufferIndex);
 967   mImpl->sceneDiscardQueue.Clear(bufferIndex);
 968
 969   bool isAnimationRunning = IsAnimationRunning();
 970
 971   // Process Touches & Gestures
 972   const bool gestureUpdated = ProcessGestures(bufferIndex, lastVSyncTimeMilliseconds, nextVSyncTimeMilliseconds);
 973
 974   bool updateScene =                                   // The scene-graph requires an update if..
 975     (mImpl->nodeDirtyFlags & RenderableUpdateFlags) || // ..nodes were dirty in previous frame OR
 976     isAnimationRunning ||                              // ..at least one animation is running OR
 977     mImpl->messageQueue.IsSceneUpdateRequired() ||     // ..a message that modifies the scene graph node tree is queued OR
 978     mImpl->frameCallbackProcessor ||                   // ..a frame callback processor is existed OR
 979     gestureUpdated;                                    // ..a gesture property was updated
 980
 981   bool keepRendererRendering = false;
 982   mImpl->renderingRequired   = false;
 983
 984   // Although the scene-graph may not require an update, we still need to synchronize double-buffered
 985   // values if the scene was updated in the previous frame.
 986   if(updateScene || mImpl->previousUpdateScene)
 987   {
 988     // Reset properties from the previous update
 989     ResetProperties(bufferIndex);
 990     mImpl->transformManager.ResetToBaseValue();
 991   }
 992
 993   // Process the queued scene messages. Note, MessageQueue::FlushQueue may be called
 994   // between calling IsSceneUpdateRequired() above and here, so updateScene should
 995   // be set again
 996   updateScene |= mImpl->messageQueue.ProcessMessages(bufferIndex);
 997
 998   // Forward compiled shader programs to event thread for saving
 999   ForwardCompiledShadersToEventThread();
1000
1001   // Although the scene-graph may not require an update, we still need to synchronize double-buffered
1002   // renderer lists if the scene was updated in the previous frame.
1003   // We should not start skipping update steps or reusing lists until there has been two frames where nothing changes
1004   if(updateScene || mImpl->previousUpdateScene)
1005   {
1006     // Animate
1007     bool animationActive = Animate(bufferIndex, elapsedSeconds);
1008
1009     // Constraint custom objects
1010     ConstrainCustomObjects(bufferIndex);
1011
1012     // Clear the lists of renderers from the previous update
1013     for(auto&& scene : mImpl->scenes)
1014     {
1015       if(scene)
1016       {
1017         for(auto&& layer : scene->sortedLayerList)
1018         {
1019           if(layer)
1020           {
1021             layer->ClearRenderables();
1022           }
1023         }
1024       }
1025     }
1026
1027     // Call the frame-callback-processor if set
1028     if(mImpl->frameCallbackProcessor)
1029     {
1030       mImpl->frameCallbackProcessor->Update(bufferIndex, elapsedSeconds);
1031     }
1032
1033     // Update node hierarchy, apply constraints,
1034     UpdateNodes(bufferIndex);
1035
1036     // Apply constraints to RenderTasks, shaders
1037     ConstrainRenderTasks(bufferIndex);
1038     ConstrainShaders(bufferIndex);
1039
1040     // Update renderers and apply constraints
1041     UpdateRenderers(bufferIndex);
1042
1043     // Update the transformations of all the nodes
1044     if(mImpl->transformManager.Update())
1045     {
1046       mImpl->nodeDirtyFlags |= NodePropertyFlags::TRANSFORM;
1047     }
1048
1049     // Initialise layer renderable reuse
1050     UpdateLayers(bufferIndex);
1051
1052     // Process Property Notifications
1053     ProcessPropertyNotifications(bufferIndex);
1054
1055     // Update cameras
1056     for(auto&& cameraIterator : mImpl->cameras)
1057     {
1058       cameraIterator->Update(bufferIndex);
1059     }
1060
1061     // Process the RenderTasks if renderers exist. This creates the instructions for rendering the next frame.
1062     // reset the update buffer index and make sure there is enough room in the instruction container
1063     if(mImpl->renderersAdded)
1064     {
1065       // Calculate how many render tasks we have in total
1066       std::size_t numberOfRenderTasks = 0;
1067       for(auto&& scene : mImpl->scenes)
1068       {
1069         if(scene && scene->taskList)
1070         {
1071           numberOfRenderTasks += scene->taskList->GetTasks().Count();
1072         }
1073       }
1074
1075       std::size_t numberOfRenderInstructions = 0;
1076       mImpl->renderInstructionCapacity       = 0u;
1077       for(auto&& scene : mImpl->scenes)
1078       {
1079         if(scene && scene->root && scene->taskList && scene->scene)
1080         {
1081           scene->scene->GetRenderInstructions().ResetAndReserve(bufferIndex,
1082                                                                 static_cast<uint32_t>(scene->taskList->GetTasks().Count()));
1083
1084           // If there are animations running, only add render instruction if at least one animation is currently active (i.e. not delayed)
1085           // or the nodes are dirty
1086           if(!isAnimationRunning || animationActive || mImpl->renderingRequired || (mImpl->nodeDirtyFlags & RenderableUpdateFlags))
1087           {
1088             keepRendererRendering |= mImpl->renderTaskProcessor.Process(bufferIndex,
1089                                                                         *scene->taskList,
1090                                                                         *scene->root,
1091                                                                         scene->sortedLayerList,
1092                                                                         scene->scene->GetRenderInstructions(),
1093                                                                         renderToFboEnabled,
1094                                                                         isRenderingToFbo);
1095
1096             mImpl->renderInstructionCapacity += scene->scene->GetRenderInstructions().GetCapacity();
1097             scene->scene->SetSkipRendering(false);
1098           }
1099           else
1100           {
1101             scene->scene->SetSkipRendering(true);
1102           }
1103
1104           numberOfRenderInstructions += scene->scene->GetRenderInstructions().Count(bufferIndex);
1105         }
1106       }
1107
1108       DALI_LOG_INFO(gLogFilter, Debug::General, "Update: numberOfRenderTasks(%d), Render Instructions(%d)\n", numberOfRenderTasks, numberOfRenderInstructions);
1109     }
1110   }
1111
1112   if(!uploadOnly)
1113   {
1114     for(auto&& scene : mImpl->scenes)
1115     {
1116       if(scene && scene->root && scene->taskList)
1117       {
1118         RenderTaskList::RenderTaskContainer& tasks = scene->taskList->GetTasks();
1119
1120         // check the countdown and notify
1121         bool doRenderOnceNotify  = false;
1122         mImpl->renderTaskWaiting = false;
1123         for(auto&& renderTask : tasks)
1124         {
1125           renderTask->UpdateState();
1126
1127           if(renderTask->IsWaitingToRender() &&
1128              renderTask->ReadyToRender(bufferIndex) /*avoid updating forever when source actor is off-stage*/)
1129           {
1130             mImpl->renderTaskWaiting = true; // keep update/render threads alive
1131           }
1132
1133           if(renderTask->HasRendered())
1134           {
1135             doRenderOnceNotify = true;
1136           }
1137         }
1138
1139         if(doRenderOnceNotify)
1140         {
1141           DALI_LOG_INFO(gRenderTaskLogFilter, Debug::General, "Notify a render task has finished\n");
1142           mImpl->notificationManager.QueueCompleteNotification(scene->taskList->GetCompleteNotificationInterface());
1143         }
1144       }
1145     }
1146   }
1147
1148   // Macro is undefined in release build.
1149   SNAPSHOT_NODE_LOGGING;
1150
1151   // A ResetProperties() may be required in the next frame
1152   mImpl->previousUpdateScene = updateScene;
1153
1154   // Check whether further updates are required
1155   uint32_t keepUpdating = KeepUpdatingCheck(elapsedSeconds);
1156
1157   if(keepRendererRendering)
1158   {
1159     keepUpdating |= KeepUpdating::STAGE_KEEP_RENDERING;
1160
1161     // Set dirty flags for next frame to continue rendering
1162     mImpl->nodeDirtyFlags |= RenderableUpdateFlags;
1163   }
1164
1165   // tell the update manager that we're done so the queue can be given to event thread
1166   mImpl->notificationManager.UpdateCompleted();
1167
1168   // The update has finished; swap the double-buffering indices
1169   mSceneGraphBuffers.Swap();
1170
1171   return keepUpdating;
1172 }
1173
1174 void UpdateManager::PostRender()
1175 {
1176   // Reset dirty flag
1177   for(auto&& renderer : mImpl->renderers)
1178   {
1179     renderer->ResetDirtyFlag();
1180   }
1181
1182   for(auto&& scene : mImpl->scenes)
1183   {
1184     scene->root->SetUpdatedTree(false);
1185   }
1186 }
1187
1188 uint32_t UpdateManager::KeepUpdatingCheck(float elapsedSeconds) const
1189 {
1190   // Update the duration set via Stage::KeepRendering()
1191   if(mImpl->keepRenderingSeconds > 0.0f)
1192   {
1193     mImpl->keepRenderingSeconds -= elapsedSeconds;
1194   }
1195
1196   uint32_t keepUpdatingRequest = KeepUpdating::NOT_REQUESTED;
1197
1198   // If the rendering behavior is set to continuously render, then continue to render.
1199   // If Stage::KeepRendering() has been called, then continue until the duration has elapsed.
1200   // Keep updating until no messages are received and no animations are running.
1201   // If an animation has just finished, update at least once more for Discard end-actions.
1202   // No need to check for renderQueue as there is always a render after update and if that
1203   // render needs another update it will tell the adaptor to call update again
1204
1205   if((mImpl->renderingBehavior == DevelStage::Rendering::CONTINUOUSLY) ||
1206      (mImpl->keepRenderingSeconds > 0.0f))
1207   {
1208     keepUpdatingRequest |= KeepUpdating::STAGE_KEEP_RENDERING;
1209   }
1210
1211   if(IsAnimationRunning() ||
1212      mImpl->animationFinishedDuringUpdate)
1213   {
1214     keepUpdatingRequest |= KeepUpdating::ANIMATIONS_RUNNING;
1215   }
1216
1217   if(mImpl->renderTaskWaiting)
1218   {
1219     keepUpdatingRequest |= KeepUpdating::RENDER_TASK_SYNC;
1220   }
1221
1222   return keepUpdatingRequest;
1223 }
1224
1225 void UpdateManager::SurfaceReplaced(Scene* scene)
1226 {
1227   using DerivedType = MessageValue1<RenderManager, Scene*>;
1228
1229   // Reserve some memory inside the render queue
1230   uint32_t* slot = mImpl->renderQueue.ReserveMessageSlot(mSceneGraphBuffers.GetUpdateBufferIndex(), sizeof(DerivedType));
1231
1232   // Construct message in the render queue memory; note that delete should not be called on the return value
1233   new(slot) DerivedType(&mImpl->renderManager, &RenderManager::SurfaceReplaced, scene);
1234 }
1235
1236 void UpdateManager::KeepRendering(float durationSeconds)
1237 {
1238   mImpl->keepRenderingSeconds = std::max(mImpl->keepRenderingSeconds, durationSeconds);
1239 }
1240
1241 void UpdateManager::SetRenderingBehavior(DevelStage::Rendering renderingBehavior)
1242 {
1243   mImpl->renderingBehavior = renderingBehavior;
1244 }
1245
1246 void UpdateManager::RequestRendering()
1247 {
1248   mImpl->renderingRequired = true;
1249 }
1250
1251 void UpdateManager::SetLayerDepths(const SortedLayerPointers& layers, const Layer* rootLayer)
1252 {
1253   for(auto&& scene : mImpl->scenes)
1254   {
1255     if(scene && scene->root == rootLayer)
1256     {
1257       scene->sortedLayerList = layers;
1258       break;
1259     }
1260   }
1261 }
1262
1263 void UpdateManager::SetDepthIndices(OwnerPointer<NodeDepths>& nodeDepths)
1264 {
1265   // note, this vector is already in depth order.
1266   // So if we reverse iterate, we can assume that
1267   // my descendant node's depth index are updated.
1268   for(auto rIter = nodeDepths->nodeDepths.rbegin(), rEndIter = nodeDepths->nodeDepths.rend(); rIter != rEndIter; rIter++)
1269   {
1270     auto* node = rIter->node;
1271     node->SetDepthIndex(rIter->sortedDepth);
1272     if(node->IsChildrenReorderRequired())
1273     {
1274       // Reorder children container only if sibiling order changed.
1275       NodeContainer& container = node->GetChildren();
1276       std::sort(container.Begin(), container.End(), [](Node* a, Node* b) { return a->GetDepthIndex() < b->GetDepthIndex(); });
1277     }
1278   }
1279 }
1280
1281 void UpdateManager::AddFrameCallback(OwnerPointer<FrameCallback>& frameCallback, const Node* rootNode)
1282 {
1283   mImpl->GetFrameCallbackProcessor(*this).AddFrameCallback(frameCallback, rootNode);
1284 }
1285
1286 void UpdateManager::RemoveFrameCallback(FrameCallbackInterface* frameCallback)
1287 {
1288   mImpl->GetFrameCallbackProcessor(*this).RemoveFrameCallback(frameCallback);
1289 }
1290
1291 void UpdateManager::AddSampler(OwnerPointer<Render::Sampler>& sampler)
1292 {
1293   // Message has ownership of Sampler while in transit from update to render
1294   using DerivedType = MessageValue1<RenderManager, OwnerPointer<Render::Sampler>>;
1295
1296   // Reserve some memory inside the render queue
1297   uint32_t* slot = mImpl->renderQueue.ReserveMessageSlot(mSceneGraphBuffers.GetUpdateBufferIndex(), sizeof(DerivedType));
1298
1299   // Construct message in the render queue memory; note that delete should not be called on the return value
1300   new(slot) DerivedType(&mImpl->renderManager, &RenderManager::AddSampler, sampler);
1301 }
1302
1303 void UpdateManager::RemoveSampler(Render::Sampler* sampler)
1304 {
1305   using DerivedType = MessageValue1<RenderManager, Render::Sampler*>;
1306
1307   // Reserve some memory inside the render queue
1308   uint32_t* slot = mImpl->renderQueue.ReserveMessageSlot(mSceneGraphBuffers.GetUpdateBufferIndex(), sizeof(DerivedType));
1309
1310   // Construct message in the render queue memory; note that delete should not be called on the return value
1311   new(slot) DerivedType(&mImpl->renderManager, &RenderManager::RemoveSampler, sampler);
1312 }
1313
1314 void UpdateManager::SetFilterMode(Render::Sampler* sampler, uint32_t minFilterMode, uint32_t magFilterMode)
1315 {
1316   using DerivedType = MessageValue3<RenderManager, Render::Sampler*, uint32_t, uint32_t>;
1317
1318   // Reserve some memory inside the render queue
1319   uint32_t* slot = mImpl->renderQueue.ReserveMessageSlot(mSceneGraphBuffers.GetUpdateBufferIndex(), sizeof(DerivedType));
1320
1321   // Construct message in the render queue memory; note that delete should not be called on the return value
1322   new(slot) DerivedType(&mImpl->renderManager, &RenderManager::SetFilterMode, sampler, minFilterMode, magFilterMode);
1323 }
1324
1325 void UpdateManager::SetWrapMode(Render::Sampler* sampler, uint32_t rWrapMode, uint32_t sWrapMode, uint32_t tWrapMode)
1326 {
1327   using DerivedType = MessageValue4<RenderManager, Render::Sampler*, uint32_t, uint32_t, uint32_t>;
1328
1329   // Reserve some memory inside the render queue
1330   uint32_t* slot = mImpl->renderQueue.ReserveMessageSlot(mSceneGraphBuffers.GetUpdateBufferIndex(), sizeof(DerivedType));
1331
1332   // Construct message in the render queue memory; note that delete should not be called on the return value
1333   new(slot) DerivedType(&mImpl->renderManager, &RenderManager::SetWrapMode, sampler, rWrapMode, sWrapMode, tWrapMode);
1334 }
1335
1336 void UpdateManager::AddVertexBuffer(OwnerPointer<Render::VertexBuffer>& vertexBuffer)
1337 {
1338   // Message has ownership of format while in transit from update -> render
1339   using DerivedType = MessageValue1<RenderManager, OwnerPointer<Render::VertexBuffer>>;
1340
1341   // Reserve some memory inside the render queue
1342   uint32_t* slot = mImpl->renderQueue.ReserveMessageSlot(mSceneGraphBuffers.GetUpdateBufferIndex(), sizeof(DerivedType));
1343
1344   // Construct message in the render queue memory; note that delete should not be called on the return value
1345   new(slot) DerivedType(&mImpl->renderManager, &RenderManager::AddVertexBuffer, vertexBuffer);
1346 }
1347
1348 void UpdateManager::RemoveVertexBuffer(Render::VertexBuffer* vertexBuffer)
1349 {
1350   using DerivedType = MessageValue1<RenderManager, Render::VertexBuffer*>;
1351
1352   // Reserve some memory inside the render queue
1353   uint32_t* slot = mImpl->renderQueue.ReserveMessageSlot(mSceneGraphBuffers.GetUpdateBufferIndex(), sizeof(DerivedType));
1354
1355   // Construct message in the render queue memory; note that delete should not be called on the return value
1356   new(slot) DerivedType(&mImpl->renderManager, &RenderManager::RemoveVertexBuffer, vertexBuffer);
1357 }
1358
1359 void UpdateManager::SetVertexBufferFormat(Render::VertexBuffer* vertexBuffer, OwnerPointer<Render::VertexBuffer::Format>& format)
1360 {
1361   // Message has ownership of format while in transit from update -> render
1362   using DerivedType = MessageValue2<RenderManager, Render::VertexBuffer*, OwnerPointer<Render::VertexBuffer::Format>>;
1363
1364   // Reserve some memory inside the render queue
1365   uint32_t* slot = mImpl->renderQueue.ReserveMessageSlot(mSceneGraphBuffers.GetUpdateBufferIndex(), sizeof(DerivedType));
1366
1367   // Construct message in the render queue memory; note that delete should not be called on the return value
1368   new(slot) DerivedType(&mImpl->renderManager, &RenderManager::SetVertexBufferFormat, vertexBuffer, format);
1369 }
1370
1371 void UpdateManager::SetVertexBufferData(Render::VertexBuffer* vertexBuffer, OwnerPointer<Vector<uint8_t>>& data, uint32_t size)
1372 {
1373   // Message has ownership of format while in transit from update -> render
1374   using DerivedType = MessageValue3<RenderManager, Render::VertexBuffer*, OwnerPointer<Dali::Vector<uint8_t>>, uint32_t>;
1375
1376   // Reserve some memory inside the render queue
1377   uint32_t* slot = mImpl->renderQueue.ReserveMessageSlot(mSceneGraphBuffers.GetUpdateBufferIndex(), sizeof(DerivedType));
1378
1379   // Construct message in the render queue memory; note that delete should not be called on the return value
1380   new(slot) DerivedType(&mImpl->renderManager, &RenderManager::SetVertexBufferData, vertexBuffer, data, size);
1381 }
1382
1383 void UpdateManager::AddGeometry(OwnerPointer<Render::Geometry>& geometry)
1384 {
1385   // Message has ownership of format while in transit from update -> render
1386   using DerivedType = MessageValue1<RenderManager, OwnerPointer<Render::Geometry>>;
1387
1388   // Reserve some memory inside the render queue
1389   uint32_t* slot = mImpl->renderQueue.ReserveMessageSlot(mSceneGraphBuffers.GetUpdateBufferIndex(), sizeof(DerivedType));
1390
1391   // Construct message in the render queue memory; note that delete should not be called on the return value
1392   new(slot) DerivedType(&mImpl->renderManager, &RenderManager::AddGeometry, geometry);
1393 }
1394
1395 void UpdateManager::RemoveGeometry(Render::Geometry* geometry)
1396 {
1397   using DerivedType = MessageValue1<RenderManager, Render::Geometry*>;
1398
1399   // Reserve some memory inside the render queue
1400   uint32_t* slot = mImpl->renderQueue.ReserveMessageSlot(mSceneGraphBuffers.GetUpdateBufferIndex(), sizeof(DerivedType));
1401
1402   // Construct message in the render queue memory; note that delete should not be called on the return value
1403   new(slot) DerivedType(&mImpl->renderManager, &RenderManager::RemoveGeometry, geometry);
1404 }
1405
1406 void UpdateManager::SetGeometryType(Render::Geometry* geometry, uint32_t geometryType)
1407 {
1408   using DerivedType = MessageValue2<RenderManager, Render::Geometry*, uint32_t>;
1409
1410   // Reserve some memory inside the render queue
1411   uint32_t* slot = mImpl->renderQueue.ReserveMessageSlot(mSceneGraphBuffers.GetUpdateBufferIndex(), sizeof(DerivedType));
1412
1413   // Construct message in the render queue memory; note that delete should not be called on the return value
1414   new(slot) DerivedType(&mImpl->renderManager, &RenderManager::SetGeometryType, geometry, geometryType);
1415 }
1416
1417 void UpdateManager::SetIndexBuffer(Render::Geometry* geometry, Dali::Vector<uint16_t>& indices)
1418 {
1419   using DerivedType = IndexBufferMessage<RenderManager>;
1420
1421   // Reserve some memory inside the render queue
1422   uint32_t* slot = mImpl->renderQueue.ReserveMessageSlot(mSceneGraphBuffers.GetUpdateBufferIndex(), sizeof(DerivedType));
1423
1424   // Construct message in the render queue memory; note that delete should not be called on the return value
1425   new(slot) DerivedType(&mImpl->renderManager, geometry, indices);
1426 }
1427
1428 void UpdateManager::RemoveVertexBuffer(Render::Geometry* geometry, Render::VertexBuffer* vertexBuffer)
1429 {
1430   using DerivedType = MessageValue2<RenderManager, Render::Geometry*, Render::VertexBuffer*>;
1431
1432   // Reserve some memory inside the render queue
1433   uint32_t* slot = mImpl->renderQueue.ReserveMessageSlot(mSceneGraphBuffers.GetUpdateBufferIndex(), sizeof(DerivedType));
1434
1435   // Construct message in the render queue memory; note that delete should not be called on the return value
1436   new(slot) DerivedType(&mImpl->renderManager, &RenderManager::RemoveVertexBuffer, geometry, vertexBuffer);
1437 }
1438
1439 void UpdateManager::AttachVertexBuffer(Render::Geometry* geometry, Render::VertexBuffer* vertexBuffer)
1440 {
1441   using DerivedType = MessageValue2<RenderManager, Render::Geometry*, Render::VertexBuffer*>;
1442
1443   // Reserve some memory inside the render queue
1444   uint32_t* slot = mImpl->renderQueue.ReserveMessageSlot(mSceneGraphBuffers.GetUpdateBufferIndex(), sizeof(DerivedType));
1445
1446   // Construct message in the render queue memory; note that delete should not be called on the return value
1447   new(slot) DerivedType(&mImpl->renderManager, &RenderManager::AttachVertexBuffer, geometry, vertexBuffer);
1448 }
1449
1450 void UpdateManager::AddTexture(const Render::TextureKey& texture)
1451 {
1452   using DerivedType = MessageValue1<RenderManager, Render::TextureKey>;
1453
1454   // Reserve some memory inside the render queue
1455   uint32_t* slot = mImpl->renderQueue.ReserveMessageSlot(mSceneGraphBuffers.GetUpdateBufferIndex(), sizeof(DerivedType));
1456
1457   // Construct message in the render queue memory; note that delete should not be called on the return value
1458   new(slot) DerivedType(&mImpl->renderManager, &RenderManager::AddTexture, texture);
1459 }
1460
1461 void UpdateManager::RemoveTexture(const Render::TextureKey& texture)
1462 {
1463   using DerivedType = MessageValue1<RenderManager, Render::TextureKey>;
1464
1465   // Reserve some memory inside the render queue
1466   uint32_t* slot = mImpl->renderQueue.ReserveMessageSlot(mSceneGraphBuffers.GetUpdateBufferIndex(), sizeof(DerivedType));
1467
1468   // Construct message in the render queue memory; note that delete should not be called on the return value
1469   new(slot) DerivedType(&mImpl->renderManager, &RenderManager::RemoveTexture, texture);
1470 }
1471
1472 void UpdateManager::UploadTexture(const Render::TextureKey& texture, PixelDataPtr pixelData, const Texture::UploadParams& params)
1473 {
1474   using DerivedType = MessageValue3<RenderManager, Render::TextureKey, PixelDataPtr, Texture::UploadParams>;
1475
1476   // Reserve some memory inside the message queue
1477   uint32_t* slot = mImpl->renderQueue.ReserveMessageSlot(mSceneGraphBuffers.GetUpdateBufferIndex(), sizeof(DerivedType));
1478
1479   // Construct message in the message queue memory; note that delete should not be called on the return value
1480   new(slot) DerivedType(&mImpl->renderManager, &RenderManager::UploadTexture, texture, pixelData, params);
1481 }
1482
1483 void UpdateManager::GenerateMipmaps(const Render::TextureKey& texture)
1484 {
1485   using DerivedType = MessageValue1<RenderManager, Render::TextureKey>;
1486
1487   // Reserve some memory inside the render queue
1488   uint32_t* slot = mImpl->renderQueue.ReserveMessageSlot(mSceneGraphBuffers.GetUpdateBufferIndex(), sizeof(DerivedType));
1489
1490   // Construct message in the render queue memory; note that delete should not be called on the return value
1491   new(slot) DerivedType(&mImpl->renderManager, &RenderManager::GenerateMipmaps, texture);
1492 }
1493
1494 void UpdateManager::AddFrameBuffer(OwnerPointer<Render::FrameBuffer>& frameBuffer)
1495 {
1496   using DerivedType = MessageValue1<RenderManager, OwnerPointer<Render::FrameBuffer>>;
1497
1498   // Reserve some memory inside the render queue
1499   uint32_t* slot = mImpl->renderQueue.ReserveMessageSlot(mSceneGraphBuffers.GetUpdateBufferIndex(), sizeof(DerivedType));
1500
1501   // Construct message in the render queue memory; note that delete should not be called on the return value
1502   new(slot) DerivedType(&mImpl->renderManager, &RenderManager::AddFrameBuffer, frameBuffer);
1503 }
1504
1505 void UpdateManager::RemoveFrameBuffer(Render::FrameBuffer* frameBuffer)
1506 {
1507   using DerivedType = MessageValue1<RenderManager, Render::FrameBuffer*>;
1508
1509   // Reserve some memory inside the render queue
1510   uint32_t* slot = mImpl->renderQueue.ReserveMessageSlot(mSceneGraphBuffers.GetUpdateBufferIndex(), sizeof(DerivedType));
1511
1512   // Construct message in the render queue memory; note that delete should not be called on the return value
1513   new(slot) DerivedType(&mImpl->renderManager, &RenderManager::RemoveFrameBuffer, frameBuffer);
1514 }
1515
1516 void UpdateManager::AttachColorTextureToFrameBuffer(Render::FrameBuffer* frameBuffer, Render::Texture* texture, uint32_t mipmapLevel, uint32_t layer)
1517 {
1518   using DerivedType = MessageValue4<RenderManager, Render::FrameBuffer*, Render::Texture*, uint32_t, uint32_t>;
1519
1520   // Reserve some memory inside the render queue
1521   uint32_t* slot = mImpl->renderQueue.ReserveMessageSlot(mSceneGraphBuffers.GetUpdateBufferIndex(), sizeof(DerivedType));
1522
1523   // Construct message in the render queue memory; note that delete should not be called on the return value
1524   new(slot) DerivedType(&mImpl->renderManager, &RenderManager::AttachColorTextureToFrameBuffer, frameBuffer, texture, mipmapLevel, layer);
1525 }
1526
1527 void UpdateManager::AttachDepthTextureToFrameBuffer(Render::FrameBuffer* frameBuffer, Render::Texture* texture, uint32_t mipmapLevel)
1528 {
1529   using DerivedType = MessageValue3<RenderManager, Render::FrameBuffer*, Render::Texture*, uint32_t>;
1530
1531   // Reserve some memory inside the render queue
1532   uint32_t* slot = mImpl->renderQueue.ReserveMessageSlot(mSceneGraphBuffers.GetUpdateBufferIndex(), sizeof(DerivedType));
1533
1534   // Construct message in the render queue memory; note that delete should not be called on the return value
1535   new(slot) DerivedType(&mImpl->renderManager, &RenderManager::AttachDepthTextureToFrameBuffer, frameBuffer, texture, mipmapLevel);
1536 }
1537
1538 void UpdateManager::AttachDepthStencilTextureToFrameBuffer(Render::FrameBuffer* frameBuffer, Render::Texture* texture, uint32_t mipmapLevel)
1539 {
1540   using DerivedType = MessageValue3<RenderManager, Render::FrameBuffer*, Render::Texture*, uint32_t>;
1541
1542   // Reserve some memory inside the render queue
1543   uint32_t* slot = mImpl->renderQueue.ReserveMessageSlot(mSceneGraphBuffers.GetUpdateBufferIndex(), sizeof(DerivedType));
1544
1545   // Construct message in the render queue memory; note that delete should not be called on the return value
1546   new(slot) DerivedType(&mImpl->renderManager, &RenderManager::AttachDepthStencilTextureToFrameBuffer, frameBuffer, texture, mipmapLevel);
1547 }
1548
1549 void UpdateManager::SetMultiSamplingLevelToFrameBuffer(Render::FrameBuffer* frameBuffer, uint8_t multiSamplingLevel)
1550 {
1551   using DerivedType = MessageValue2<RenderManager, Render::FrameBuffer*, uint8_t>;
1552
1553   // Reserve some memory inside the render queue
1554   uint32_t* slot = mImpl->renderQueue.ReserveMessageSlot(mSceneGraphBuffers.GetUpdateBufferIndex(), sizeof(DerivedType));
1555
1556   // Construct message in the render queue memory; note that delete should not be called on the return value
1557   new(slot) DerivedType(&mImpl->renderManager, &RenderManager::SetMultiSamplingLevelToFrameBuffer, frameBuffer, multiSamplingLevel);
1558 }
1559
1560 } // namespace SceneGraph
1561
1562 } // namespace Internal
1563
1564 } // namespace Dali