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

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