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