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

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