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