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