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

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