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