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