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