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