Merge "Skip rendering if no animation is currently active" into devel/master
[platform/core/uifw/dali-core.git] / dali / internal / update / manager / update-manager.h
1 #ifndef DALI_INTERNAL_SCENE_GRAPH_UPDATE_MANAGER_H
2 #define DALI_INTERNAL_SCENE_GRAPH_UPDATE_MANAGER_H
3
4 /*
5  * Copyright (c) 2020 Samsung Electronics Co., Ltd.
6  *
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  * http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  *
19  */
20
21 // INTERNAL INCLUDES
22 #include <dali/public-api/common/vector-wrapper.h>
23 #include <dali/public-api/common/dali-common.h>
24
25 #include <dali/devel-api/common/stage-devel.h>
26
27 #include <dali/internal/common/message.h>
28 #include <dali/internal/common/type-abstraction-enums.h>
29 #include <dali/internal/common/shader-saver.h>
30 #include <dali/internal/event/common/event-thread-services.h>
31 #include <dali/internal/update/animation/scene-graph-animation.h>
32 #include <dali/internal/update/common/property-resetter.h>
33 #include <dali/internal/update/common/scene-graph-buffers.h>
34 #include <dali/internal/update/common/scene-graph-property-notification.h>
35 #include <dali/internal/update/common/scene-graph-scene.h>
36 #include <dali/internal/update/nodes/node.h>
37 #include <dali/internal/update/nodes/scene-graph-layer.h>
38 #include <dali/internal/update/manager/scene-graph-frame-callback.h> // for OwnerPointer< FrameCallback >
39 #include <dali/internal/update/rendering/scene-graph-renderer.h>  // for OwnerPointer< Renderer >
40 #include <dali/internal/update/rendering/scene-graph-texture-set.h> // for OwnerPointer< TextureSet >
41 #include <dali/internal/update/gestures/scene-graph-pan-gesture.h>
42 #include <dali/internal/update/render-tasks/scene-graph-camera.h>
43 #include <dali/internal/update/render-tasks/scene-graph-render-task-list.h>
44 #include <dali/internal/render/shaders/scene-graph-shader.h>   // for OwnerPointer< Shader >
45 #include <dali/internal/render/renderers/render-vertex-buffer.h>
46 #include <dali/internal/event/rendering/texture-impl.h>
47
48 namespace Dali
49 {
50
51 class FrameCallbackInterface;
52
53 namespace Integration
54 {
55 class GlSyncAbstraction;
56 class RenderController;
57
58 } // namespace Integration
59
60 namespace Internal
61 {
62
63 class PropertyNotifier;
64 class NotificationManager;
65 class CompleteNotificationInterface;
66 class TouchResampler;
67
68 namespace Render
69 {
70 struct Sampler;
71 class FrameBuffer;
72 }
73 // value types used by messages
74 template <> struct ParameterType< PropertyNotification::NotifyMode >
75 : public BasicType< PropertyNotification::NotifyMode > {};
76
77 namespace SceneGraph
78 {
79
80 class Animation;
81 class DiscardQueue;
82 class RenderManager;
83 class RenderTaskList;
84 class RenderTaskProcessor;
85 class RenderQueue;
86 class VertexBuffer;
87
88 struct NodeDepthPair
89 {
90   SceneGraph::Node* node;
91   uint32_t sortedDepth;
92   NodeDepthPair( SceneGraph::Node* node, uint32_t sortedDepth )
93   : node(node),
94     sortedDepth(sortedDepth)
95   {
96   }
97 };
98
99 struct NodeDepths
100 {
101   NodeDepths()
102   {
103   }
104
105   void Add( SceneGraph::Node* node, uint32_t sortedDepth )
106   {
107     nodeDepths.push_back( NodeDepthPair( node, sortedDepth ) );
108   }
109
110   std::vector<NodeDepthPair> nodeDepths;
111 };
112
113
114 /**
115  * UpdateManager maintains a scene graph i.e. a tree of nodes as well as
116  * other scene graph property owning objects.
117  * It controls the Update traversal, in which nodes are repositioned/animated,
118  * and organizes the the culling and rendering of the scene.
119  * It also maintains the lifecycle of nodes and other property owners that are
120  * disconnected from the scene graph.
121  */
122 class UpdateManager : public ShaderSaver
123 {
124 public:
125
126   /**
127    * Construct a new UpdateManager.
128    * @param[in] notificationManager This should be notified when animations have finished.
129    * @param[in] animationPlaylist The CompleteNotificationInterface that handles the animations
130    * @param[in] propertyNotifier The PropertyNotifier
131    * @param[in] discardQueue Nodes are added here when disconnected from the scene-graph.
132    * @param[in] controller After messages are flushed, we request a render from the RenderController.
133    * @param[in] renderManager This is responsible for rendering the results of each "update".
134    * @param[in] renderQueue Used to queue messages for the next render.
135    * @param[in] renderTaskProcessor Handles RenderTasks and RenderInstrucitons.
136    */
137   UpdateManager( NotificationManager& notificationManager,
138                  CompleteNotificationInterface& animationPlaylist,
139                  PropertyNotifier& propertyNotifier,
140                  DiscardQueue& discardQueue,
141                  Integration::RenderController& controller,
142                  RenderManager& renderManager,
143                  RenderQueue& renderQueue,
144                  RenderTaskProcessor& renderTaskProcessor );
145
146   /**
147    * Destructor.
148    */
149   ~UpdateManager() override;
150
151   // Node connection methods
152
153   /**
154    * Installs a new layer as the root node.
155    * @pre The layer is of derived Node type Layer.
156    * @pre The layer does not have a parent.
157    * @param[in] layer The new root node.
158    * @post The node is owned by UpdateManager.
159    */
160   void InstallRoot( OwnerPointer<Layer>& layer );
161
162   /**
163    * Uninstalls the root node.
164    * @pre The layer is of derived Node type Layer.
165    * @pre The layer does not have a parent.
166    * @param[in] layer The root node.
167    * @post The node is owned by UpdateManager.
168    */
169   void UninstallRoot( Layer* layer );
170
171   /**
172    * Add a Node; UpdateManager takes ownership.
173    * @pre The node does not have a parent.
174    * @note even though nodes are pool allocated, they also contain other heap allocated data, thus using OwnerPointer when transferring the data
175    * @param[in] node The node to add.
176    */
177   void AddNode( OwnerPointer<Node>& node );
178
179   /**
180    * Connect a Node to the scene-graph.
181    * A disconnected Node has has no parent or children, and its properties cannot be animated/constrained.
182    * @pre The node does not already have a parent.
183    * @param[in] parent The new parent node.
184    */
185   void ConnectNode( Node* parent, Node* node );
186
187   /**
188    * Disconnect a Node from the scene-graph.
189    * A disconnected Node has has no parent or children, and its properties cannot be animated/constrained.
190    * @pre The node has a parent.
191    * @param[in] node The node to disconnect.
192    */
193   void DisconnectNode( Node* node );
194
195   /**
196    * Destroy a Node owned by UpdateManager.
197    * This is not immediate; Nodes are passed to the RenderQueue to allow GL resources to be deleted.
198    * In the following update, the previously queued Nodes may be deleted.
199    * @pre The node has been disconnected from the scene-graph i.e. has no parent or children.
200    * @param[in] node The node to destroy.
201    */
202   void DestroyNode( Node* node );
203
204   /**
205    * Add a camera on scene
206    * @param[in] camera The camera to add
207    */
208   void AddCamera( OwnerPointer< Camera >& camera );
209
210   /**
211    * Remove a camera from scene
212    * @param[in] camera to remove
213    */
214   void RemoveCamera( Camera* camera );
215
216   /**
217    * Add a newly created object.
218    * @param[in] object The object to add.
219    * @post The object is owned by UpdateManager.
220    */
221   void AddObject( OwnerPointer<PropertyOwner>& object );
222
223   /**
224    * Remove an object.
225    * @param[in] object The object to remove.
226    */
227   void RemoveObject( PropertyOwner* object );
228
229   /**
230    * Add a newly created render task list.
231    * @param[in] taskList The render task list to add.
232    * @post The render task list is owned by UpdateManager.
233    */
234   void AddRenderTaskList( OwnerPointer<RenderTaskList>& taskList );
235
236   /**
237    * Remove a render task list.
238    * @param[in] taskList The render task list to remove.
239    */
240   void RemoveRenderTaskList( RenderTaskList* taskList );
241
242   /**
243    * Add a newly created scene.
244    * @param[in] scene The scene to add.
245    * @post The scene is owned by UpdateManager.
246    */
247   void AddScene( OwnerPointer<Scene>& scene );
248
249   /**
250    * Remove a scene.
251    * @param[in] scene The scene to remove.
252    */
253   void RemoveScene( Scene* scene );
254
255   // Animations
256
257   /**
258    * Add a newly created animation.
259    * @param[in] animation The animation to add.
260    * @post The animation is owned by UpdateManager.
261    */
262   void AddAnimation( OwnerPointer< SceneGraph::Animation >& animation );
263
264   /**
265    * Stop an animation.
266    * @param[in] animation The animation to stop.
267    */
268   void StopAnimation( Animation* animation );
269
270   /**
271    * Remove an animation.
272    * @param[in] animation The animation to remove.
273    */
274   void RemoveAnimation( Animation* animation );
275
276   /**
277    * Query whether any animations are currently running.
278    * @return True if any animations are running.
279    */
280   bool IsAnimationRunning() const;
281
282   /**
283    * Add a property resetter. UpdateManager takes ownership of the object.
284    * It will be killed by UpdateManager when the associated animator or
285    * constraint has finished; or the property owner of the property is destroyed.
286    */
287   void AddPropertyResetter( OwnerPointer<PropertyResetterBase>& propertyResetter );
288
289   // Property Notification
290
291   /**
292    * Add a newly created property notification
293    * @param[in] propertyNotification The notification to add
294    * @post The propertyNotification is owned by UpdateManager.
295    */
296   void AddPropertyNotification( OwnerPointer< PropertyNotification >& propertyNotification );
297
298   /**
299    * Remove a property notification
300    * @param[in] propertyNotification The notification to remove
301    */
302   void RemovePropertyNotification( PropertyNotification* propertyNotification );
303
304   /**
305    * Set Notify state for PropertyNotification
306    * @param[in] propertyNotification The notification to remove
307    * @param[in] notifyMode The notification mode.
308    */
309   void PropertyNotificationSetNotify( PropertyNotification* propertyNotification, PropertyNotification::NotifyMode notifyMode );
310
311   // Shaders
312
313   /**
314    * Add a newly created shader.
315    * @param[in] shader The shader to add.
316    * @post The shader is owned by the UpdateManager.
317    */
318   void AddShader( OwnerPointer< Shader >& shader );
319
320   /**
321    * Remove a shader.
322    * @pre The shader has been added to the UpdateManager.
323    * @param[in] shader The shader to remove.
324    * @post The shader is destroyed.
325    */
326   void RemoveShader( Shader* shader );
327
328   /**
329    * Set the shader program for a Shader object
330    * @param[in] shader        The shader to modify
331    * @param[in] shaderData    Source code, hash over source, and optional compiled binary for the shader program
332    * @param[in] modifiesGeometry True if the vertex shader modifies geometry
333    */
334   void SetShaderProgram( Shader* shader, Internal::ShaderDataPtr shaderData, bool modifiesGeometry );
335
336   /**
337    * @brief Accept compiled shaders passed back on render thread for saving.
338    * @param[in] shaderData Source code, hash over source, and corresponding compiled binary to be saved.
339    */
340   void SaveBinary( Internal::ShaderDataPtr shaderData ) override;
341
342   /**
343    * @brief Set the destination for compiled shader binaries to be passed on to.
344    * The dispatcher passed in will be called from the update thread.
345    * @param[in] upstream A sink for ShaderDatas to be passed into.
346    */
347   void SetShaderSaver( ShaderSaver& upstream );
348
349   // Renderers
350
351   /**
352    * Add a new renderer to scene
353    * @param renderer to add
354    */
355   void AddRenderer( OwnerPointer< Renderer >& renderer );
356
357   /**
358    * Add a renderer from scene
359    * @param renderer to remove
360    */
361   void RemoveRenderer( Renderer* renderer );
362
363   // Gestures
364
365   /**
366    * Set the pan gesture processor.
367    * Pan Gesture processor lives for the lifetime of UpdateManager
368    * @param[in] gesture The gesture processor.
369    * @post The gestureProcessor is owned by the UpdateManager.
370    */
371   void SetPanGestureProcessor( PanGesture* gestureProcessor );
372
373   // Textures
374
375   /**
376    * Add a newly created TextureSet.
377    * @param[in] textureSet The texture set to add.
378    * @post The TextureSet is owned by the UpdateManager.
379    */
380   void AddTextureSet( OwnerPointer< TextureSet >& textureSet );
381
382   /**
383    * Remove a TextureSet.
384    * @pre The TextureSet has been added to the UpdateManager.
385    * @param[in] textureSet The TextureSet to remove.
386    * @post The TextureSet is destroyed.
387    */
388   void RemoveTextureSet( TextureSet* textureSet );
389
390   // Render tasks
391
392   /**
393    * Get the scene graph side list of RenderTasks.
394    * @param[in] systemLevel True if using the system-level overlay.
395    * @return The list of render tasks
396    */
397   RenderTaskList* GetRenderTaskList( bool systemLevel );
398
399 // Message queue handling
400
401   /**
402    * Reserve space for another message in the queue; this must then be initialized by the caller.
403    * The message will be read from the update-thread after the next FlushMessages is called.
404    * @post Calling this method may invalidate any previously returned slots.
405    * @param[in] size The message size with respect to the size of type "char".
406    * @param[in] updateScene A flag, when true denotes that the message will cause the scene-graph node tree to require an update.
407    * @note the default value of updateScene should match that in EventThreadServices::ReserveMessageSlot.
408    * @return A pointer to the first char allocated for the message.
409    */
410   uint32_t* ReserveMessageSlot( uint32_t size, bool updateScene = true );
411
412   /**
413    * @return the current event-buffer index.
414    */
415   BufferIndex GetEventBufferIndex() const
416   {
417     // inlined as its called often from event thread
418     return mSceneGraphBuffers.GetEventBufferIndex();
419   }
420
421   /**
422    * Called by the event-thread to signal that FlushQueue will be called
423    * e.g. when it has finished event processing.
424    */
425   void EventProcessingStarted();
426
427   /**
428    * Flush the set of messages, which were previously stored with QueueMessage().
429    * Calls to this thread-safe method should be minimized, to avoid thread blocking.
430    *
431    * @return True if there are messages to process.
432    */
433   bool FlushQueue();
434
435   /**
436    * Add a new sampler to RenderManager
437    * @param[in] sampler The sampler to add
438    * @post Sends a message to RenderManager to add the sampler.
439    * The sampler will be owned by RenderManager
440    */
441   void AddSampler( OwnerPointer< Render::Sampler >& sampler );
442
443   /**
444    * Removes an existing sampler from RenderManager
445    * @param[in] sampler The sampler to remove
446    * @post The sampler will be destroyed in the render thread
447    */
448   void RemoveSampler( Render::Sampler* sampler );
449
450   /**
451    * Sets the filter modes for an existing sampler
452    * @param[in] sampler The sampler
453    * @param[in] minFilterMode The filter to use under minification
454    * @param[in] magFilterMode The filter to use under magnification
455    */
456   void SetFilterMode( Render::Sampler* sampler, uint32_t minFilterMode, uint32_t magFilterMode );
457
458   /**
459    * Sets the wrap mode for an existing sampler
460    * @param[in] sampler The sampler
461    * @param[in] rWrapMode Wrapping mode in z direction
462    * @param[in] sWrapMode Wrapping mode in x direction
463    * @param[in] tWrapMode Wrapping mode in y direction
464    */
465   void SetWrapMode( Render::Sampler* sampler, uint32_t rWrapMode, uint32_t sWrapMode, uint32_t tWrapMode );
466
467   /**
468    * Add a new property buffer to RenderManager
469    * @param[in] propertryBuffer The property buffer to add
470    * @post Sends a message to RenderManager to add the property buffer.
471    * The property buffer will be owned by RenderManager
472    */
473   void AddVertexBuffer( OwnerPointer< Render::VertexBuffer >& propertryBuffer );
474
475   /**
476    * Removes an existing VertexBuffer from RenderManager
477    * @param[in] propertryBuffer The property buffer to remove
478    * @post The property buffer will be destroyed in the render thread
479    */
480   void RemoveVertexBuffer( Render::VertexBuffer* propertryBuffer );
481
482   /**
483    * Sets the format of an existing property buffer
484    * @param[in] vertexBuffer The property buffer.
485    * @param[in] format The new format of the buffer
486    * @post Sends a message to RenderManager to set the new format to the property buffer.
487    */
488   void SetVertexBufferFormat( Render::VertexBuffer* vertexBuffer, OwnerPointer< Render::VertexBuffer::Format>& format );
489
490   /**
491    * Sets the data of an existing property buffer
492    * @param[in] vertexBuffer The property buffer.
493    * @param[in] data The new data of the buffer
494    * @param[in] size The new size of the buffer
495    * @post Sends a message to RenderManager to set the new data to the property buffer.
496    */
497   void SetVertexBufferData( Render::VertexBuffer* vertexBuffer, OwnerPointer< Vector<uint8_t> >& data, uint32_t size );
498
499   /**
500    * Adds a geometry to the RenderManager
501    * @param[in] geometry The geometry to add
502    * @post Sends a message to RenderManager to add the Geometry
503    * The geometry will be owned by RenderManager
504    */
505   void AddGeometry( OwnerPointer< Render::Geometry >& geometry );
506
507   /**
508    * Removes an existing Geometry from RenderManager
509    * @param[in] geometry The geometry to remove
510    * @post The geometry will be destroyed in the render thread
511    */
512   void RemoveGeometry( Render::Geometry* geometry );
513
514   /**
515    * Sets the geometry type of an existing Geometry
516    * @param[in] geometry The geometry
517    * @param[in] geometryType The type of the geometry
518    */
519   void SetGeometryType( Render::Geometry* geometry, uint32_t geometryType );
520
521   /**
522    * Sets the index buffer to be used by a geometry
523    * @param[in] geometry The geometry
524    * @param[in] indices A vector containing the indices for the geometry
525    */
526   void SetIndexBuffer( Render::Geometry* geometry, Dali::Vector<uint16_t>& indices );
527
528   /**
529    * Adds a vertex buffer to a geometry
530    * @param[in] geometry The geometry
531    * @param[in] vertexBuffer The property buffer
532    */
533   void AttachVertexBuffer( Render::Geometry* geometry, Render::VertexBuffer* vertexBuffer );
534
535   /**
536    * Removes a vertex buffer from a geometry
537    * @param[in] geometry The geometry
538    * @param[in] vertexBuffer The property buffer
539    */
540   void RemoveVertexBuffer( Render::Geometry* geometry, Render::VertexBuffer* vertexBuffer );
541
542   /**
543    * Adds a texture to the render manager
544    * @param[in] texture The texture to add
545    * The texture will be owned by RenderManager
546    */
547   void AddTexture( OwnerPointer< Render::Texture >& texture );
548
549   /**
550    * Removes a texture from the render manager
551    * @param[in] texture The texture to remove
552    * @post The texture will be destroyed in the render thread
553    */
554   void RemoveTexture( Render::Texture* texture );
555
556   /**
557    * Uploads data to a texture owned by the RenderManager
558    * @param[in] texture The texture
559    * @param[in] pixelData The pixel data object
560    * @param[in] params The parameters for the upload
561    */
562   void UploadTexture( Render::Texture* texture, PixelDataPtr pixelData, const Texture::UploadParams& params );
563
564   /**
565    * Generates mipmaps for a texture owned by the RenderManager
566    * @param[in] texture The texture
567    */
568   void GenerateMipmaps( Render::Texture* texture );
569
570   /**
571    * Adds a framebuffer to the render manager
572    * @param[in] frameBuffer The framebuffer to add
573    * The framebuffer will be owned by RenderManager
574    */
575   void AddFrameBuffer( OwnerPointer< Render::FrameBuffer >& frameBuffer );
576
577   /**
578    * Removes a FrameBuffer from the render manager
579    * @param[in] frameBuffer The FrameBuffer to remove
580    * @post The FrameBuffer will be destroyed in the render thread
581    */
582   void RemoveFrameBuffer( Render::FrameBuffer* frameBuffer );
583
584   /**
585    * Attach a texture as color output to an existing FrameBuffer
586    * @param[in] frameBuffer The FrameBuffer
587    * @param[in] texture The texture that will be used as output when rendering
588    * @param[in] mipmapLevel The mipmap of the texture to be attached
589    * @param[in] layer Indicates which layer of a cube map or array texture to attach. Unused for 2D textures
590    */
591   void AttachColorTextureToFrameBuffer( Render::FrameBuffer* frameBuffer, Render::Texture* texture, uint32_t mipmapLevel, uint32_t face );
592
593   /**
594    * Attach a texture as depth output to an existing FrameBuffer
595    * @param[in] frameBuffer The FrameBuffer
596    * @param[in] texture The texture that will be used as output when rendering
597    * @param[in] mipmapLevel The mipmap of the texture to be attached
598    */
599   void AttachDepthTextureToFrameBuffer( Render::FrameBuffer* frameBuffer, Render::Texture* texture, uint32_t mipmapLevel );
600
601   /**
602    * Attach a texture as depth/stencil output to an existing FrameBuffer
603    * @param[in] frameBuffer The FrameBuffer
604    * @param[in] texture The texture that will be used as output when rendering
605    * @param[in] mipmapLevel The mipmap of the texture to be attached
606    */
607   void AttachDepthStencilTextureToFrameBuffer( Render::FrameBuffer* frameBuffer, Render::Texture* texture, uint32_t mipmapLevel );
608
609   /**
610    * This is called when the surface of the scene has been replaced.
611    * @param[in] scene The scene.
612    */
613   void SurfaceReplaced( Scene* scene );
614
615 public:
616
617   /**
618    * Performs an Update traversal on the scene-graph.
619    * @param[in] elapsedSeconds The elapsed time that should be applied to animations.
620    * @param[in] lastVSyncTimeMilliseconds The last time, in milliseconds, that we had a VSync.
621    * @param[in] nextVSyncTimeMilliseconds The estimated time, in milliseconds, of the next VSync.
622    * @param[in] renderToFboEnabled Whether rendering into the Frame Buffer Object is enabled.
623    * @param[in] isRenderingToFbo   Whether this frame is being rendered into the Frame Buffer Object.
624    * @return True if further updates are required e.g. during animations.
625    */
626   uint32_t Update( float elapsedSeconds,
627                    uint32_t lastVSyncTimeMilliseconds,
628                    uint32_t nextVSyncTimeMilliseconds,
629                    bool renderToFboEnabled,
630                    bool isRenderingToFbo );
631
632   /**
633    * Set the default surface rect.
634    * @param[in] rect The rect value representing the surface.
635    */
636   void SetDefaultSurfaceRect( const Rect<int>& rect );
637
638   /**
639    * @copydoc Dali::Stage::KeepRendering()
640    */
641   void KeepRendering( float durationSeconds );
642
643   /**
644    * @copydoc Dali::DevelStage::SetRenderingBehavior()
645    */
646   void SetRenderingBehavior( DevelStage::Rendering renderingBehavior );
647
648   /**
649    * Request to render the current frame
650    * @note This is a temporary workaround (to be removed in the future) to request the rendering of
651    *       the current frame if the color or visibility of any actor is updated. It MUST NOT be used
652    *       for any other purposes.
653    */
654   void RequestRendering();
655
656   /**
657    * Sets the depths of all layers.
658    * @param layers The layers in depth order.
659    * @param[in] rootLayer The root layer of the sorted layers.
660    */
661   void SetLayerDepths( const std::vector< Layer* >& layers, const Layer* rootLayer );
662
663   /**
664    * Set the depth indices of all nodes (in LayerUI's)
665    * @param[in] nodeDepths A vector of nodes and associated depth indices
666    */
667   void SetDepthIndices( OwnerPointer< NodeDepths >& nodeDepths );
668
669   /**
670    * Query wheter the default surface rect is changed or not.
671    * @return true if the default surface rect is changed.
672    */
673   bool IsDefaultSurfaceRectChanged();
674
675   /**
676    * Adds an implementation of the FrameCallbackInterface.
677    * @param[in] frameCallback An OwnerPointer to the SceneGraph FrameCallback object
678    * @param[in] rootNode A pointer to the root node to apply the FrameCallback to
679    */
680   void AddFrameCallback( OwnerPointer< FrameCallback >& frameCallback, const Node* rootNode );
681
682   /**
683    * Removes the specified implementation of FrameCallbackInterface.
684    * @param[in] frameCallback A pointer to the implementation of the FrameCallbackInterface to remove.
685    */
686   void RemoveFrameCallback( FrameCallbackInterface* frameCallback );
687
688 private:
689
690   // Undefined
691   UpdateManager(const UpdateManager&);
692
693   // Undefined
694   UpdateManager& operator=(const UpdateManager& rhs);
695
696   /**
697    * Helper to check whether the update-thread should keep going.
698    * @param[in] elapsedSeconds The time in seconds since the previous update.
699    * @return True if the update-thread should keep going.
700    */
701   uint32_t KeepUpdatingCheck( float elapsedSeconds ) const;
702
703   /**
704    * Helper to reset all Node properties
705    * @param[in] bufferIndex to use
706    */
707   void ResetProperties( BufferIndex bufferIndex );
708
709   /**
710    * Perform gesture updates.
711    * @param[in] bufferIndex to use
712    * @param[in] lastVSyncTime  The last VSync time in milliseconds.
713    * @param[in] nextVSyncTime  The estimated time of the next VSync in milliseconds.
714    * @return true, if any properties were updated.
715    */
716   bool ProcessGestures( BufferIndex bufferIndex, uint32_t lastVSyncTimeMilliseconds, uint32_t nextVSyncTimeMilliseconds );
717
718   /**
719    * Perform animation updates
720    * @param[in] bufferIndex to use
721    * @param[in] elapsedSeconds time since last frame
722    * @return true if at least one animations is currently active or false otherwise
723    */
724   bool Animate( BufferIndex bufferIndex, float elapsedSeconds );
725
726   /**
727    * Applies constraints to CustomObjects
728    * @param[in] bufferIndex to use
729    */
730   void ConstrainCustomObjects( BufferIndex bufferIndex );
731
732   /**
733    * Applies constraints to RenderTasks
734    * @param[in] bufferIndex to use
735    */
736   void ConstrainRenderTasks( BufferIndex bufferIndex );
737
738   /**
739    * Applies constraints to Shaders
740    * @param[in] bufferIndex to use
741    */
742   void ConstrainShaders( BufferIndex bufferIndex );
743
744   /**
745    * Perform property notification updates
746    * @param[in] bufferIndex to use
747    */
748   void ProcessPropertyNotifications( BufferIndex bufferIndex );
749
750   /**
751    * Pass shader binaries queued here on to event thread.
752    */
753   void ForwardCompiledShadersToEventThread();
754
755   /**
756    * Update node shaders, opacity, geometry etc.
757    * @param[in] bufferIndex to use
758    */
759   void UpdateNodes( BufferIndex bufferIndex );
760
761   /**
762    * Update Renderers
763    * @param[in] bufferIndex to use
764    */
765   void UpdateRenderers( BufferIndex bufferIndex );
766
767 private:
768
769   // needs to be direct member so that getter for event buffer can be inlined
770   SceneGraphBuffers mSceneGraphBuffers;
771
772   struct Impl;
773   Impl* mImpl;
774
775 };
776
777 // Messages for UpdateManager
778
779 inline void InstallRootMessage( UpdateManager& manager, OwnerPointer<Layer>& root )
780 {
781   // Message has ownership of Layer while in transit from event -> update
782   using LocalType = MessageValue1<UpdateManager, OwnerPointer<Layer> >;
783
784   // Reserve some memory inside the message queue
785   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
786
787   // Construct message in the message queue memory; note that delete should not be called on the return value
788   new (slot) LocalType( &manager, &UpdateManager::InstallRoot, root );
789 }
790
791 inline void UninstallRootMessage( UpdateManager& manager, const Layer* constRoot )
792 {
793   // Scene graph thread can destroy this object.
794   Layer* root = const_cast< Layer* >( constRoot );
795
796   using LocalType = MessageValue1<UpdateManager, Layer*>;
797
798   // Reserve some memory inside the message queue
799   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
800
801   // Construct message in the message queue memory; note that delete should not be called on the return value
802   new (slot) LocalType( &manager, &UpdateManager::UninstallRoot, root );
803 }
804
805 inline void AddNodeMessage( UpdateManager& manager, OwnerPointer<Node>& node )
806 {
807   // Message has ownership of Node while in transit from event -> update
808   using LocalType = MessageValue1<UpdateManager, OwnerPointer<Node> >;
809
810   // Reserve some memory inside the message queue
811   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
812
813   // Construct message in the message queue memory; note that delete should not be called on the return value
814   new (slot) LocalType( &manager, &UpdateManager::AddNode, node );
815 }
816
817 inline void ConnectNodeMessage( UpdateManager& manager, const Node& constParent, const Node& constChild )
818 {
819   // Update thread can edit the object
820   Node& parent = const_cast< Node& >( constParent );
821   Node& child = const_cast< Node& >( constChild );
822
823   using LocalType = MessageValue2<UpdateManager, Node*, Node*>;
824
825   // Reserve some memory inside the message queue
826   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
827
828   // Construct message in the message queue memory; note that delete should not be called on the return value
829   new (slot) LocalType( &manager, &UpdateManager::ConnectNode, &parent, &child );
830 }
831
832 inline void DisconnectNodeMessage( UpdateManager& manager, const Node& constNode )
833 {
834   // Scene graph thread can modify this object.
835   Node& node = const_cast< Node& >( constNode );
836
837   using LocalType = MessageValue1<UpdateManager, Node*>;
838
839   // Reserve some memory inside the message queue
840   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
841
842   // Construct message in the message queue memory; note that delete should not be called on the return value
843   new (slot) LocalType( &manager, &UpdateManager::DisconnectNode, &node );
844 }
845
846 inline void DestroyNodeMessage( UpdateManager& manager, const Node& constNode )
847 {
848   // Scene graph thread can destroy this object.
849   Node& node = const_cast< Node& >( constNode );
850
851   using LocalType = MessageValue1<UpdateManager, Node*>;
852
853   // Reserve some memory inside the message queue
854   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
855
856   // Construct message in the message queue memory; note that delete should not be called on the return value
857   new (slot) LocalType( &manager, &UpdateManager::DestroyNode, &node );
858 }
859
860 inline void AddCameraMessage( UpdateManager& manager, OwnerPointer< Camera >& camera )
861 {
862   // Message has ownership of Camera while in transit from event -> update
863   using LocalType = MessageValue1<UpdateManager, OwnerPointer<Camera> >;
864
865   // Reserve some memory inside the message queue
866   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
867
868   // Construct message in the message queue memory; note that delete should not be called on the return value
869   new (slot) LocalType( &manager, &UpdateManager::AddCamera, camera );
870 }
871
872 inline void RemoveCameraMessage( UpdateManager& manager, const Camera* camera )
873 {
874   using LocalType = MessageValue1<UpdateManager, Camera*>;
875
876   // Reserve some memory inside the message queue
877   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
878
879   // Construct message in the message queue memory; note that delete should not be called on the return value
880   new (slot) LocalType( &manager, &UpdateManager::RemoveCamera, const_cast<Camera*>( camera ) );
881 }
882
883 inline void AddObjectMessage( UpdateManager& manager, OwnerPointer<PropertyOwner>& object )
884 {
885   // Message has ownership of object while in transit from event -> update
886   using LocalType = MessageValue1<UpdateManager, OwnerPointer<PropertyOwner> >;
887
888   // Reserve some memory inside the message queue
889   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
890
891   // Construct message in the message queue memory; note that delete should not be called on the return value
892   new (slot) LocalType( &manager, &UpdateManager::AddObject, object );
893 }
894
895 inline void RemoveObjectMessage( UpdateManager& manager, const PropertyOwner* object )
896 {
897   using LocalType = MessageValue1<UpdateManager, PropertyOwner*>;
898
899   // Reserve some memory inside the message queue
900   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
901
902   // Construct message in the message queue memory; note that delete should not be called on the return value
903   new (slot) LocalType( &manager, &UpdateManager::RemoveObject, const_cast<PropertyOwner*>( object ) );
904 }
905
906 inline void AddAnimationMessage( UpdateManager& manager, OwnerPointer< SceneGraph::Animation >& animation )
907 {
908   using LocalType = MessageValue1<UpdateManager, OwnerPointer<SceneGraph::Animation> >;
909
910   // Reserve some memory inside the message queue
911   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
912
913   // Construct message in the message queue memory; note that delete should not be called on the return value
914   new (slot) LocalType( &manager, &UpdateManager::AddAnimation, animation );
915 }
916
917 inline void StopAnimationMessage( UpdateManager& manager, const Animation& constAnimation )
918 {
919   // The scene-graph thread owns this object so it can safely edit it.
920   Animation& animation = const_cast< Animation& >( constAnimation );
921
922   using LocalType = MessageValue1<UpdateManager, Animation*>;
923
924   // Reserve some memory inside the message queue
925   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
926
927   // Construct message in the message queue memory; note that delete should not be called on the return value
928   new (slot) LocalType( &manager, &UpdateManager::StopAnimation, &animation );
929 }
930
931 inline void RemoveAnimationMessage( UpdateManager& manager, const Animation& constAnimation )
932 {
933   // The scene-graph thread owns this object so it can safely edit it.
934   Animation& animation = const_cast< Animation& >( constAnimation );
935
936   using LocalType = MessageValue1<UpdateManager, Animation*>;
937
938   // Reserve some memory inside the message queue
939   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
940
941   // Construct message in the message queue memory; note that delete should not be called on the return value
942   new (slot) LocalType( &manager, &UpdateManager::RemoveAnimation, &animation );
943 }
944
945 inline void AddRenderTaskListMessage( UpdateManager& manager, OwnerPointer< SceneGraph::RenderTaskList >& taskList )
946 {
947   using LocalType = MessageValue1<UpdateManager, OwnerPointer<SceneGraph::RenderTaskList> >;
948
949   // Reserve some memory inside the message queue
950   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
951
952   // Construct message in the message queue memory; note that delete should not be called on the return value
953   new (slot) LocalType( &manager, &UpdateManager::AddRenderTaskList, taskList );
954 }
955
956 inline void RemoveRenderTaskListMessage( UpdateManager& manager, const RenderTaskList& constTaskList )
957 {
958   // The scene-graph thread owns this object so it can safely edit it.
959   RenderTaskList& taskList = const_cast< RenderTaskList& >( constTaskList );
960
961   using LocalType = MessageValue1<UpdateManager, RenderTaskList*>;
962
963   // Reserve some memory inside the message queue
964   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
965
966   // Construct message in the message queue memory; note that delete should not be called on the return value
967   new (slot) LocalType( &manager, &UpdateManager::RemoveRenderTaskList, &taskList );
968 }
969
970 inline void AddSceneMessage( UpdateManager& manager, OwnerPointer< SceneGraph::Scene >& scene )
971 {
972   using LocalType = MessageValue1<UpdateManager, OwnerPointer<SceneGraph::Scene> >;
973
974   // Reserve some memory inside the message queue
975   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
976
977   // Construct message in the message queue memory; note that delete should not be called on the return value
978   new (slot) LocalType( &manager, &UpdateManager::AddScene, scene );
979 }
980
981 inline void RemoveSceneMessage( UpdateManager& manager, const SceneGraph::Scene& constScene )
982 {
983   // The scene-graph thread owns this object so it can safely edit it.
984   Scene& scene = const_cast< Scene& >( constScene );
985
986   using LocalType = MessageValue1<UpdateManager, Scene*>;
987
988   // Reserve some memory inside the message queue
989   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
990
991   // Construct message in the message queue memory; note that delete should not be called on the return value
992   new (slot) LocalType( &manager, &UpdateManager::RemoveScene, &scene );
993 }
994
995 inline void AddPropertyNotificationMessage( UpdateManager& manager, OwnerPointer< PropertyNotification >& propertyNotification )
996 {
997   // Message has ownership of PropertyNotification while in transit from event -> update
998   using LocalType = MessageValue1<UpdateManager, OwnerPointer<PropertyNotification> >;
999
1000   // Reserve some memory inside the message queue
1001   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1002
1003   // Construct message in the message queue memory; note that delete should not be called on the return value
1004   new (slot) LocalType( &manager, &UpdateManager::AddPropertyNotification, propertyNotification );
1005 }
1006
1007 inline void RemovePropertyNotificationMessage( UpdateManager& manager, const PropertyNotification& constPropertyNotification )
1008 {
1009   // The scene-graph thread owns this object so it can safely edit it.
1010   PropertyNotification& propertyNotification = const_cast< PropertyNotification& >( constPropertyNotification );
1011
1012   using LocalType = MessageValue1<UpdateManager, PropertyNotification*>;
1013
1014   // Reserve some memory inside the message queue
1015   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1016
1017   // Construct message in the message queue memory; note that delete should not be called on the return value
1018   new (slot) LocalType( &manager, &UpdateManager::RemovePropertyNotification, &propertyNotification );
1019 }
1020
1021 inline void PropertyNotificationSetNotifyModeMessage( UpdateManager& manager,
1022                                                       const PropertyNotification* constPropertyNotification,
1023                                                       PropertyNotification::NotifyMode notifyMode )
1024 {
1025   // The scene-graph thread owns this object so it can safely edit it.
1026   PropertyNotification* propertyNotification = const_cast< PropertyNotification* >( constPropertyNotification );
1027
1028   using LocalType = MessageValue2<UpdateManager, PropertyNotification*, PropertyNotification::NotifyMode>;
1029
1030   // Reserve some memory inside the message queue
1031   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1032
1033   // Construct message in the message queue memory; note that delete should not be called on the return value
1034   new (slot) LocalType( &manager, &UpdateManager::PropertyNotificationSetNotify, propertyNotification, notifyMode );
1035 }
1036
1037 // The render thread can safely change the Shader
1038 inline void AddShaderMessage( UpdateManager& manager, OwnerPointer< Shader >& shader )
1039 {
1040   using LocalType = MessageValue1<UpdateManager, OwnerPointer<Shader> >;
1041
1042   // Reserve some memory inside the message queue
1043   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1044
1045   // Construct message in the message queue memory; note that delete should not be called on the return value
1046   new (slot) LocalType( &manager, &UpdateManager::AddShader, shader );
1047 }
1048
1049 // The render thread can safely change the Shader
1050 inline void RemoveShaderMessage( UpdateManager& manager, const Shader* shader )
1051 {
1052   using LocalType = MessageValue1<UpdateManager, Shader*>;
1053
1054   // Reserve some memory inside the message queue
1055   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1056
1057   // Construct message in the message queue memory; note that delete should not be called on the return value
1058   new (slot) LocalType( &manager, &UpdateManager::RemoveShader, const_cast<Shader*>( shader ) );
1059 }
1060
1061 inline void SetShaderProgramMessage( UpdateManager& manager,
1062                                      const Shader& shader,
1063                                      Internal::ShaderDataPtr shaderData,
1064                                      bool modifiesGeometry )
1065 {
1066   using LocalType = MessageValue3<UpdateManager, Shader*, Internal::ShaderDataPtr, bool>;
1067
1068   // Reserve some memory inside the message queue
1069   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1070
1071   // Construct message in the message queue memory; note that delete should not be called on the return value
1072   new (slot) LocalType( &manager, &UpdateManager::SetShaderProgram, const_cast<Shader*>( &shader ), shaderData, modifiesGeometry );
1073 }
1074
1075 inline void SetDefaultSurfaceRectMessage( UpdateManager& manager, const Rect<int32_t>& rect  )
1076 {
1077   using LocalType = MessageValue1<UpdateManager, Rect<int32_t> >;
1078
1079   // Reserve some memory inside the message queue
1080   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1081
1082   // Construct message in the message queue memory; note that delete should not be called on the return value
1083   new (slot) LocalType( &manager, &UpdateManager::SetDefaultSurfaceRect, rect );
1084 }
1085
1086 inline void SurfaceReplacedMessage( UpdateManager& manager, const SceneGraph::Scene& constScene )
1087 {
1088   // The scene-graph thread owns this object so it can safely edit it.
1089   Scene& scene = const_cast< Scene& >( constScene );
1090
1091   using LocalType = MessageValue1<UpdateManager, Scene*>;
1092
1093   // Reserve some memory inside the message queue
1094   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1095
1096   // Construct message in the message queue memory; note that delete should not be called on the return value
1097   new (slot) LocalType( &manager, &UpdateManager::SurfaceReplaced, &scene );
1098 }
1099
1100 inline void KeepRenderingMessage( UpdateManager& manager, float durationSeconds )
1101 {
1102   using LocalType = MessageValue1<UpdateManager, float>;
1103
1104   // Reserve some memory inside the message queue
1105   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1106
1107   // Construct message in the message queue memory; note that delete should not be called on the return value
1108   new (slot) LocalType( &manager, &UpdateManager::KeepRendering, durationSeconds );
1109 }
1110
1111 inline void SetRenderingBehaviorMessage( UpdateManager& manager, DevelStage::Rendering renderingBehavior )
1112 {
1113   using LocalType = MessageValue1<UpdateManager, DevelStage::Rendering>;
1114
1115   // Reserve some memory inside the message queue
1116   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1117
1118   // Construct message in the message queue memory; note that delete should not be called on the return value
1119   new (slot) LocalType( &manager, &UpdateManager::SetRenderingBehavior, renderingBehavior );
1120 }
1121
1122 inline void RequestRenderingMessage( UpdateManager& manager )
1123 {
1124   using LocalType = Message<UpdateManager>;
1125
1126   // Reserve some memory inside the message queue
1127   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1128
1129   // Construct message in the message queue memory; note that delete should not be called on the return value
1130   new (slot) LocalType( &manager, &UpdateManager::RequestRendering );
1131 }
1132
1133 /**
1134  * Create a message for setting the depth of a layer
1135  * @param[in] manager The update manager
1136  * @param[in] layers list of layers
1137  * @param[in] rootLayer The rool layer
1138  */
1139 inline void SetLayerDepthsMessage( UpdateManager& manager, const std::vector< Layer* >& layers, const Layer* rootLayer )
1140 {
1141   using LocalType = MessageValue2<UpdateManager, std::vector<Layer*>, const Layer*>;
1142
1143   // Reserve some memory inside the message queue
1144   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1145
1146   // Construct message in the message queue memory; note that delete should not be called on the return value
1147   new (slot) LocalType( &manager, &UpdateManager::SetLayerDepths, layers, rootLayer );
1148 }
1149
1150 inline void AddRendererMessage( UpdateManager& manager, OwnerPointer< Renderer >& object )
1151 {
1152   using LocalType = MessageValue1<UpdateManager, OwnerPointer<Renderer> >;
1153
1154   // Reserve some memory inside the message queue
1155   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1156   // Construct message in the message queue memory; note that delete should not be called on the return value
1157   new (slot) LocalType( &manager, &UpdateManager::AddRenderer, object );
1158 }
1159
1160 inline void RemoveRendererMessage( UpdateManager& manager, const Renderer& object )
1161 {
1162   using LocalType = MessageValue1<UpdateManager, Renderer*>;
1163
1164   // Reserve some memory inside the message queue
1165   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1166   // Construct message in the message queue memory; note that delete should not be called on the return value
1167   new (slot) LocalType( &manager, &UpdateManager::RemoveRenderer, const_cast<Renderer*>( &object ) );
1168 }
1169
1170 // The render thread can safely change the Shader
1171 inline void AddTextureSetMessage( UpdateManager& manager, OwnerPointer< TextureSet >& textureSet )
1172 {
1173   using LocalType = MessageValue1<UpdateManager, OwnerPointer<TextureSet> >;
1174
1175   // Reserve some memory inside the message queue
1176   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1177
1178   // Construct message in the message queue memory; note that delete should not be called on the return value
1179   new (slot) LocalType( &manager, &UpdateManager::AddTextureSet, textureSet );
1180 }
1181
1182 // The render thread can safely change the Shader
1183 inline void RemoveTextureSetMessage( UpdateManager& manager, TextureSet& textureSet )
1184 {
1185   using LocalType = MessageValue1<UpdateManager, TextureSet*>;
1186
1187   // Reserve some memory inside the message queue
1188   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1189
1190   // Construct message in the message queue memory; note that delete should not be called on the return value
1191   new (slot) LocalType( &manager, &UpdateManager::RemoveTextureSet, &textureSet );
1192 }
1193
1194 inline void AddSamplerMessage( UpdateManager& manager, OwnerPointer< Render::Sampler >& sampler )
1195 {
1196   // Message has ownership of Sampler while in transit from event -> update
1197   using LocalType = MessageValue1<UpdateManager, OwnerPointer<Render::Sampler> >;
1198
1199   // Reserve some memory inside the message queue
1200   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1201
1202   // Construct message in the message queue memory; note that delete should not be called on the return value
1203   new (slot) LocalType( &manager, &UpdateManager::AddSampler, sampler );
1204 }
1205
1206 inline void RemoveSamplerMessage( UpdateManager& manager, Render::Sampler& sampler )
1207 {
1208   using LocalType = MessageValue1<UpdateManager, Render::Sampler*>;
1209
1210   // Reserve some memory inside the message queue
1211   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1212
1213   // Construct message in the message queue memory; note that delete should not be called on the return value
1214   new (slot) LocalType( &manager, &UpdateManager::RemoveSampler, &sampler );
1215 }
1216
1217 inline void SetFilterModeMessage( UpdateManager& manager, Render::Sampler& sampler, uint32_t minFilterMode, uint32_t magFilterMode )
1218 {
1219   using LocalType = MessageValue3<UpdateManager, Render::Sampler*, uint32_t, uint32_t>;
1220
1221   // Reserve some memory inside the message queue
1222   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1223
1224   // Construct message in the message queue memory; note that delete should not be called on the return value
1225   new (slot) LocalType( &manager, &UpdateManager::SetFilterMode, &sampler, minFilterMode, magFilterMode );
1226 }
1227
1228 inline void SetWrapModeMessage( UpdateManager& manager, Render::Sampler& sampler, uint32_t rWrapMode, uint32_t sWrapMode, uint32_t tWrapMode )
1229 {
1230   using LocalType = MessageValue4<UpdateManager, Render::Sampler*, uint32_t, uint32_t, uint32_t>;
1231
1232   // Reserve some memory inside the message queue
1233   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1234
1235   // Construct message in the message queue memory; note that delete should not be called on the return value
1236   new (slot) LocalType( &manager, &UpdateManager::SetWrapMode, &sampler, rWrapMode, sWrapMode, tWrapMode );
1237 }
1238
1239 inline void AddVertexBuffer( UpdateManager& manager, OwnerPointer< Render::VertexBuffer >& vertexBuffer )
1240 {
1241   // Message has ownership of vertexBuffer while in transit from event -> update
1242   using LocalType = MessageValue1<UpdateManager, OwnerPointer<Render::VertexBuffer> >;
1243
1244   // Reserve some memory inside the message queue
1245   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1246
1247   // Construct message in the message queue memory; note that delete should not be called on the return value
1248   new (slot) LocalType( &manager, &UpdateManager::AddVertexBuffer, vertexBuffer );
1249 }
1250
1251 inline void RemoveVertexBuffer( UpdateManager& manager, Render::VertexBuffer& vertexBuffer )
1252 {
1253   using LocalType = MessageValue1<UpdateManager, Render::VertexBuffer*>;
1254
1255   // Reserve some memory inside the message queue
1256   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1257
1258   // Construct message in the message queue memory; note that delete should not be called on the return value
1259   new (slot) LocalType( &manager, &UpdateManager::RemoveVertexBuffer, &vertexBuffer );
1260 }
1261
1262 inline void SetVertexBufferFormat( UpdateManager& manager, Render::VertexBuffer& vertexBuffer, OwnerPointer< Render::VertexBuffer::Format>& format )
1263 {
1264   // Message has ownership of VertexBuffer::Format while in transit from event -> update
1265   using LocalType = MessageValue2<UpdateManager, Render::VertexBuffer*, OwnerPointer<Render::VertexBuffer::Format> >;
1266
1267   // Reserve some memory inside the message queue
1268   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1269
1270   // Construct message in the message queue memory; note that delete should not be called on the return value
1271   new (slot) LocalType( &manager, &UpdateManager::SetVertexBufferFormat, &vertexBuffer, format );
1272 }
1273
1274 inline void SetVertexBufferData( UpdateManager& manager, Render::VertexBuffer& vertexBuffer, OwnerPointer< Vector<uint8_t> >& data, uint32_t size )
1275 {
1276   // Message has ownership of VertexBuffer data while in transit from event -> update
1277   using LocalType = MessageValue3<UpdateManager, Render::VertexBuffer*, OwnerPointer<Vector<uint8_t> >, uint32_t>;
1278
1279   // Reserve some memory inside the message queue
1280   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1281
1282   // Construct message in the message queue memory; note that delete should not be called on the return value
1283   new (slot) LocalType( &manager, &UpdateManager::SetVertexBufferData, &vertexBuffer, data, size );
1284 }
1285
1286 inline void AddGeometry( UpdateManager& manager, OwnerPointer< Render::Geometry >& geometry )
1287 {
1288   // Message has ownership of Geometry while in transit from event -> update
1289   using LocalType = MessageValue1<UpdateManager, OwnerPointer<Render::Geometry> >;
1290
1291   // Reserve some memory inside the message queue
1292   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1293
1294   // Construct message in the message queue memory; note that delete should not be called on the return value
1295   new (slot) LocalType( &manager, &UpdateManager::AddGeometry, geometry );
1296 }
1297
1298 inline void RemoveGeometry( UpdateManager& manager, Render::Geometry& geometry )
1299 {
1300   using LocalType = MessageValue1<UpdateManager, Render::Geometry*>;
1301
1302   // Reserve some memory inside the message queue
1303   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1304
1305   // Construct message in the message queue memory; note that delete should not be called on the return value
1306   new (slot) LocalType( &manager, &UpdateManager::RemoveGeometry, &geometry );
1307 }
1308
1309 inline void AttachVertexBufferMessage( UpdateManager& manager, Render::Geometry& geometry, const Render::VertexBuffer& vertexBuffer )
1310 {
1311   using LocalType = MessageValue2<UpdateManager, Render::Geometry*, Render::VertexBuffer*>;
1312
1313   // Reserve some memory inside the message queue
1314   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1315
1316   // Construct message in the message queue memory; note that delete should not be called on the return value
1317   new (slot) LocalType( &manager, &UpdateManager::AttachVertexBuffer, &geometry, const_cast<Render::VertexBuffer*>(&vertexBuffer) );
1318 }
1319
1320 inline void RemoveVertexBufferMessage( UpdateManager& manager, Render::Geometry& geometry, const Render::VertexBuffer& vertexBuffer )
1321 {
1322   using LocalType = MessageValue2<UpdateManager, Render::Geometry*, Render::VertexBuffer*>;
1323
1324   // Reserve some memory inside the message queue
1325   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1326
1327   // Construct message in the message queue memory; note that delete should not be called on the return value
1328   new (slot) LocalType( &manager, &UpdateManager::RemoveVertexBuffer, &geometry, const_cast<Render::VertexBuffer*>(&vertexBuffer) );
1329 }
1330
1331 // Custom message type for SetIndexBuffer() used to move data with Vector::Swap()
1332 template< typename T >
1333 class IndexBufferMessage : public MessageBase
1334 {
1335 public:
1336
1337   /**
1338    * Constructor which does a Vector::Swap()
1339    */
1340   IndexBufferMessage( T* manager, Render::Geometry* geometry, Dali::Vector<uint16_t>& indices )
1341   : MessageBase(),
1342     mManager( manager ),
1343     mRenderGeometry( geometry )
1344   {
1345     mIndices.Swap( indices );
1346   }
1347
1348   /**
1349    * Virtual destructor
1350    */
1351   ~IndexBufferMessage() override
1352   {
1353   }
1354
1355   /**
1356    * @copydoc MessageBase::Process
1357    */
1358   void Process( BufferIndex /*bufferIndex*/ ) override
1359   {
1360     DALI_ASSERT_DEBUG( mManager && "Message does not have an object" );
1361     mManager->SetIndexBuffer( mRenderGeometry, mIndices );
1362   }
1363
1364 private:
1365
1366   T* mManager;
1367   Render::Geometry* mRenderGeometry;
1368   Dali::Vector<uint16_t> mIndices;
1369 };
1370
1371 inline void SetIndexBufferMessage( UpdateManager& manager, Render::Geometry& geometry, Dali::Vector<uint16_t>& indices )
1372 {
1373   using LocalType = IndexBufferMessage<UpdateManager>;
1374
1375   // Reserve some memory inside the message queue
1376   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1377
1378   // Construct message in the message queue memory; note that delete should not be called on the return value
1379   new (slot) LocalType( &manager, &geometry, indices );
1380 }
1381
1382 inline void SetGeometryTypeMessage( UpdateManager& manager, Render::Geometry& geometry, uint32_t geometryType )
1383 {
1384   using LocalType = MessageValue2<UpdateManager, Render::Geometry*, uint32_t>;
1385
1386   // Reserve some memory inside the message queue
1387   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1388
1389   // Construct message in the message queue memory; note that delete should not be called on the return value
1390   new (slot) LocalType( &manager, &UpdateManager::SetGeometryType, &geometry, geometryType );
1391 }
1392
1393 inline void AddTexture( UpdateManager& manager, OwnerPointer< Render::Texture >& texture )
1394 {
1395   // Message has ownership of Texture while in transit from event -> update
1396   using LocalType = MessageValue1<UpdateManager, OwnerPointer<Render::Texture> >;
1397
1398   // Reserve some memory inside the message queue
1399   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1400
1401   // Construct message in the message queue memory; note that delete should not be called on the return value
1402   new (slot) LocalType( &manager, &UpdateManager::AddTexture, texture );
1403 }
1404
1405 inline void RemoveTexture( UpdateManager& manager, Render::Texture& texture )
1406 {
1407   using LocalType = MessageValue1<UpdateManager, Render::Texture*>;
1408
1409   // Reserve some memory inside the message queue
1410   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1411
1412   // Construct message in the message queue memory; note that delete should not be called on the return value
1413   new (slot) LocalType( &manager, &UpdateManager::RemoveTexture, &texture );
1414 }
1415
1416 inline void UploadTextureMessage( UpdateManager& manager, Render::Texture& texture, PixelDataPtr pixelData, const Texture::UploadParams& params )
1417 {
1418   using LocalType = MessageValue3<UpdateManager, Render::Texture*, PixelDataPtr, Texture::UploadParams>;
1419
1420   // Reserve some memory inside the message queue
1421   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1422
1423   // Construct message in the message queue memory; note that delete should not be called on the return value
1424   new (slot) LocalType( &manager, &UpdateManager::UploadTexture, &texture, pixelData, params );
1425 }
1426
1427 inline void GenerateMipmapsMessage( UpdateManager& manager, Render::Texture& texture )
1428 {
1429   using LocalType = MessageValue1<UpdateManager, Render::Texture*>;
1430
1431   // Reserve some memory inside the message queue
1432   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1433
1434   // Construct message in the message queue memory; note that delete should not be called on the return value
1435   new (slot) LocalType( &manager, &UpdateManager::GenerateMipmaps, &texture );
1436 }
1437
1438
1439 inline void AddFrameBuffer( UpdateManager& manager, OwnerPointer< Render::FrameBuffer >& frameBuffer )
1440 {
1441   using LocalType = MessageValue1<UpdateManager, OwnerPointer<Render::FrameBuffer> >;
1442
1443   // Reserve some memory inside the message queue
1444   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1445
1446   // Construct message in the message queue memory; note that delete should not be called on the return value
1447   new (slot) LocalType( &manager, &UpdateManager::AddFrameBuffer, frameBuffer );
1448 }
1449
1450 inline void RemoveFrameBuffer( UpdateManager& manager, Render::FrameBuffer& frameBuffer )
1451 {
1452   using LocalType = MessageValue1<UpdateManager, Render::FrameBuffer*>;
1453
1454   // Reserve some memory inside the message queue
1455   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1456
1457   // Construct message in the message queue memory; note that delete should not be called on the return value
1458   new (slot) LocalType( &manager, &UpdateManager::RemoveFrameBuffer, &frameBuffer );
1459 }
1460
1461 inline void AttachColorTextureToFrameBuffer( UpdateManager& manager, Render::FrameBuffer& frameBuffer, Render::Texture* texture, uint32_t mipmapLevel, uint32_t layer )
1462 {
1463   using LocalType = MessageValue4<UpdateManager, Render::FrameBuffer*, Render::Texture*, uint32_t, uint32_t>;
1464
1465   // Reserve some memory inside the message queue
1466   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1467
1468   // Construct message in the message queue memory; note that delete should not be called on the return value
1469   new (slot) LocalType( &manager, &UpdateManager::AttachColorTextureToFrameBuffer, &frameBuffer, texture, mipmapLevel, layer );
1470 }
1471
1472 inline void AttachDepthTextureToFrameBuffer( UpdateManager& manager, Render::FrameBuffer& frameBuffer, Render::Texture* texture, uint32_t mipmapLevel )
1473 {
1474   using LocalType = MessageValue3<UpdateManager, Render::FrameBuffer*, Render::Texture*, uint32_t>;
1475
1476   // Reserve some memory inside the message queue
1477   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1478
1479   // Construct message in the message queue memory; note that delete should not be called on the return value
1480   new (slot) LocalType( &manager, &UpdateManager::AttachDepthTextureToFrameBuffer, &frameBuffer, texture, mipmapLevel );
1481 }
1482
1483 inline void AttachDepthStencilTextureToFrameBuffer( UpdateManager& manager, Render::FrameBuffer& frameBuffer, Render::Texture* texture, uint32_t mipmapLevel )
1484 {
1485   using LocalType = MessageValue3<UpdateManager, Render::FrameBuffer*, Render::Texture*, uint32_t>;
1486
1487   // Reserve some memory inside the message queue
1488   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1489
1490   // Construct message in the message queue memory; note that delete should not be called on the return value
1491   new (slot) LocalType( &manager, &UpdateManager::AttachDepthStencilTextureToFrameBuffer, &frameBuffer, texture, mipmapLevel );
1492 }
1493
1494 inline void SetDepthIndicesMessage( UpdateManager& manager, OwnerPointer< NodeDepths >& nodeDepths )
1495 {
1496   using LocalType = MessageValue1<UpdateManager, OwnerPointer<NodeDepths> >;
1497
1498   // Reserve some memory inside the message queue
1499   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1500
1501   // Construct message in the message queue memory; note that delete should not be called on the return value
1502   new (slot) LocalType( &manager, &UpdateManager::SetDepthIndices, nodeDepths );
1503 }
1504
1505 inline void AddResetterMessage( UpdateManager& manager, OwnerPointer<PropertyResetterBase> resetter )
1506 {
1507   using LocalType = MessageValue1<UpdateManager, OwnerPointer<PropertyResetterBase> >;
1508
1509   // Reserve some memory inside the message queue
1510   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1511
1512   // Construct message in the message queue memory; note that delete should not be called on the return value
1513   new (slot) LocalType( &manager, &UpdateManager::AddPropertyResetter, resetter );
1514 }
1515
1516 inline void AddFrameCallbackMessage( UpdateManager& manager, OwnerPointer< FrameCallback >& frameCallback, const Node& rootNode )
1517 {
1518   using LocalType = MessageValue2<UpdateManager, OwnerPointer<FrameCallback>, const Node*>;
1519
1520   // Reserve some memory inside the message queue
1521   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1522
1523   // Construct message in the message queue memory; note that delete should not be called on the return value
1524   new (slot) LocalType( &manager, &UpdateManager::AddFrameCallback, frameCallback, &rootNode );
1525 }
1526
1527 inline void RemoveFrameCallbackMessage( UpdateManager& manager, FrameCallbackInterface& frameCallback )
1528 {
1529   using LocalType = MessageValue1<UpdateManager, FrameCallbackInterface*>;
1530
1531   // Reserve some memory inside the message queue
1532   uint32_t* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1533
1534   // Construct message in the message queue memory; note that delete should not be called on the return value
1535   new (slot) LocalType( &manager, &UpdateManager::RemoveFrameCallback, &frameCallback );
1536 }
1537
1538 } // namespace SceneGraph
1539
1540 } // namespace Internal
1541
1542 } // namespace Dali
1543
1544 #endif // DALI_INTERNAL_SCENE_GRAPH_UPDATE_MANAGER_H