1 #ifndef __DALI_INTERNAL_SCENE_GRAPH_UPDATE_MANAGER_H__
2 #define __DALI_INTERNAL_SCENE_GRAPH_UPDATE_MANAGER_H__
5 * Copyright (c) 2014 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
22 #include <dali/public-api/common/vector-wrapper.h>
23 #include <dali/public-api/common/dali-common.h>
25 #include <dali/integration-api/resource-declarations.h>
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/scene-graph-buffers.h>
33 #include <dali/internal/update/common/scene-graph-property-notification.h>
34 #include <dali/internal/update/manager/object-owner-container.h>
35 #include <dali/internal/update/node-attachments/node-attachment.h>
36 #include <dali/internal/update/nodes/node.h>
37 #include <dali/internal/update/nodes/scene-graph-layer.h>
38 #include <dali/internal/update/rendering/scene-graph-renderer.h>
39 #include <dali/internal/render/shaders/scene-graph-shader.h>
40 #include <dali/internal/render/renderers/render-property-buffer.h>
47 class GlSyncAbstraction;
48 class RenderController;
50 } // namespace Integration
55 class PropertyNotifier;
56 class NotificationManager;
57 class CompleteNotificationInterface;
58 class ResourceManager;
65 // value types used by messages
66 template <> struct ParameterType< PropertyNotification::NotifyMode >
67 : public BasicType< PropertyNotification::NotifyMode > {};
83 * UpdateManager maintains a scene graph i.e. a tree of nodes and attachments and
84 * other property owner objects.
85 * It controls the Update traversal, in which nodes are repositioned/animated,
86 * and organizes the the culling and rendering of the scene.
87 * It also maintains the lifecycle of nodes and other property owners that are
88 * disconnected from the scene graph.
90 class UpdateManager : public ShaderSaver
95 * Construct a new UpdateManager.
96 * @param[in] notificationManager This should be notified when animations have finished.
97 * @param[in] animationFinishedNotifier The CompleteNotificationInterface that handles animation completions
98 * @param[in] propertyNotifier The PropertyNotifier
99 * @param[in] resourceManager The resource manager used to load textures etc.
100 * @param[in] discardQueue Nodes are added here when disconnected from the scene-graph.
101 * @param[in] controller After messages are flushed, we request a render from the RenderController.
102 * @param[in] renderManager This is responsible for rendering the results of each "update".
103 * @param[in] renderQueue Used to queue messages for the next render.
104 * @param[in] textureCache Used for caching textures.
105 * @param[in] touchResampler Used for re-sampling touch events.
107 UpdateManager( NotificationManager& notificationManager,
108 CompleteNotificationInterface& animationFinishedNotifier,
109 PropertyNotifier& propertyNotifier,
110 ResourceManager& resourceManager,
111 DiscardQueue& discardQueue,
112 Integration::RenderController& controller,
113 RenderManager& renderManager,
114 RenderQueue& renderQueue,
115 TextureCache& textureCache,
116 TouchResampler& touchResampler );
121 virtual ~UpdateManager();
123 // Node connection methods
126 * Get the scene graph side list of RenderTasks.
127 * @param[in] systemLevel True if using the system-level overlay.
128 * @return The list of render tasks
130 RenderTaskList* GetRenderTaskList( bool systemLevel );
133 * Installs a new layer as the root node.
134 * @pre The UpdateManager does not already have an installed root node.
135 * @pre The layer is of derived Node type Layer.
136 * @pre The layer does not have a parent.
137 * @param[in] layer The new root node.
138 * @param[in] systemLevel True if using the system-level overlay.
139 * @post The node is owned by UpdateManager.
141 void InstallRoot( Layer* layer, bool systemLevel );
144 * Add a Node; UpdateManager takes ownership.
145 * @pre The node does not have a parent.
146 * @param[in] node The node to add.
148 void AddNode( Node* node );
151 * Connect a Node to the scene-graph.
152 * A disconnected Node has has no parent or children, and its properties cannot be animated/constrained.
153 * @pre The node does not already have a parent.
154 * @param[in] parent The new parent node.
156 void ConnectNode( Node* parent, Node* node );
159 * Disconnect a Node from the scene-graph.
160 * A disconnected Node has has no parent or children, and its properties cannot be animated/constrained.
161 * @pre The node has a parent.
162 * @param[in] node The node to disconnect.
164 void DisconnectNode( Node* node );
167 * Destroy a Node owned by UpdateManager.
168 * This is not immediate; Nodes are passed to the RenderQueue to allow GL resources to be deleted.
169 * In the following update, the previously queued Nodes may be deleted.
170 * @pre The node has been disconnected from the scene-graph i.e. has no parent or children.
171 * @param[in] node The node to destroy.
173 void DestroyNode( Node* node );
176 * Attach an object to a Node.
177 * The UpdateManager is responsible for calling NodeAttachment::Initialize().
178 * @param[in] node The node which will own the attachment.
179 * @param[in] attachment The object to attach.
181 void AttachToNode( Node* node, NodeAttachment* attachment );
184 * Add a newly created object.
185 * @param[in] object The object to add.
186 * @post The object is owned by UpdateManager.
188 void AddObject( PropertyOwner* object );
192 * @param[in] object The object to remove.
194 void RemoveObject( PropertyOwner* object );
199 * Add a newly created animation.
200 * @param[in] animation The animation to add.
201 * @post The animation is owned by UpdateManager.
203 void AddAnimation( Animation* animation );
207 * @param[in] animation The animation to stop.
209 void StopAnimation( Animation* animation );
212 * Remove an animation.
213 * @param[in] animation The animation to remove.
215 void RemoveAnimation( Animation* animation );
218 * Query whether any animations are currently running.
219 * @return True if any animations are running.
221 bool IsAnimationRunning() const;
223 // Property Notification
226 * Add a newly created property notification
227 * @param[in] propertyNotification The notification to add
228 * @post The propertyNotification is owned by UpdateManager.
230 void AddPropertyNotification( PropertyNotification* propertyNotification );
233 * Remove a property notification
234 * @param[in] propertyNotification The notification to remove
236 void RemovePropertyNotification( PropertyNotification* propertyNotification );
239 * Set Notify state for PropertyNotification
240 * @param[in] propertyNotification The notification to remove
241 * @param[in] notifyMode The notification mode.
243 void PropertyNotificationSetNotify( PropertyNotification* propertyNotification, PropertyNotification::NotifyMode notifyMode );
246 * @brief Get the renderer owner
248 * @return The renderer owner
250 ObjectOwnerContainer< Renderer >& GetRendererOwner();
253 * @brief Get the property buffer owner
255 * @return The property buffer owner
257 ObjectOwnerContainer< PropertyBuffer >& GetPropertyBufferOwner();
263 * Add a newly created shader.
264 * @param[in] shader The shader to add.
265 * @post The shader is owned by the UpdateManager.
267 void AddShader(Shader* shader);
271 * @pre The shader has been added to the UpdateManager.
272 * @param[in] shader The shader to remove.
273 * @post The shader is destroyed.
275 void RemoveShader(Shader* shader);
278 * Add a newly created TextureSet.
279 * @param[in] textureSet The texture set to add.
280 * @post The TextureSet is owned by the UpdateManager.
282 void AddTextureSet(TextureSet* textureSet);
285 * Remove a TextureSet.
286 * @pre The TextureSet has been added to the UpdateManager.
287 * @param[in] textureSet The TextureSet to remove.
288 * @post The TextureSet is destroyed.
290 void RemoveTextureSet(TextureSet* textureSet);
293 * Set the shader program for a Shader object
294 * @param[in] shader The shader to modify
295 * @param[in] shaderData Source code, hash over source, and optional compiled binary for the shader program
296 * @param[in] modifiesGeometry True if the vertex shader modifies geometry
298 void SetShaderProgram( Shader* shader, Internal::ShaderDataPtr shaderData, bool modifiesGeometry );
301 * @brief Accept compiled shaders passed back on render thread for saving.
302 * @param[in] shaderData Source code, hash over source, and corresponding compiled binary to be saved.
304 virtual void SaveBinary( Internal::ShaderDataPtr shaderData );
307 * @brief Set the destination for compiled shader binaries to be passed on to.
308 * The dispatcher passed in will be called from the update thread.
309 * @param[in] upstream A sink for ShaderDatas to be passed into.
311 void SetShaderSaver( ShaderSaver& upstream );
316 * Add a newly created gesture.
317 * @param[in] gesture The gesture to add.
318 * @post The gesture is owned by the UpdateManager.
320 void AddGesture( PanGesture* gesture );
324 * @pre The gesture has been added to the UpdateManager.
325 * @param[in] gesture The gesture to remove.
326 * @post The gesture is destroyed.
328 void RemoveGesture( PanGesture* gesture );
330 // Message queue handling
333 * Reserve space for another message in the queue; this must then be initialized by the caller.
334 * The message will be read from the update-thread after the next FlushMessages is called.
335 * @post Calling this method may invalidate any previously returned slots.
336 * @param[in] size The message size with respect to the size of type "char".
337 * @param[in] updateScene A flag, when true denotes that the message will cause the scene-graph node tree to require an update.
338 * @note the default value of updateScene should match that in EventThreadServices::ReserveMessageSlot.
339 * @return A pointer to the first char allocated for the message.
341 unsigned int* ReserveMessageSlot( std::size_t size, bool updateScene = true );
344 * @return the current event-buffer index.
346 BufferIndex GetEventBufferIndex() const
348 // inlined as its called often from event thread
349 return mSceneGraphBuffers.GetEventBufferIndex();
353 * Called by the event-thread to signal that FlushQueue will be called
354 * e.g. when it has finished event processing.
356 void EventProcessingStarted();
359 * Flush the set of messages, which were previously stored with QueueMessage().
360 * Calls to this thread-safe method should be minimized, to avoid thread blocking.
362 * @return True if there are messages to process.
367 * Add a new sampler to RenderManager
368 * @param[in] sampler The sampler to add
369 * @post Sends a message to RenderManager to add the sampler.
370 * The sampler will be owned by RenderManager
372 void AddSampler( Render::Sampler* sampler );
375 * Removes an existing sampler from RenderManager
376 * @param[in] sampler The sampler to remove
377 * @post The sampler will be destroyed in the render thread
379 void RemoveSampler( Render::Sampler* sampler );
382 * Sets the filter modes for an existing sampler
383 * @param[in] sampler The sampler
384 * @param[in] minFilterMode The filter to use under minification
385 * @param[in] magFilterMode The filter to use under magnification
387 void SetFilterMode( Render::Sampler* sampler, unsigned int minFilterMode, unsigned int magFilterMode );
390 * Sets the wrap mode for an existing sampler
391 * @param[in] sampler The sampler
392 * @param[in] uWrapMode Wrapping mode in x direction
393 * @param[in] vWrapMode Wrapping mode in y direction
395 void SetWrapMode( Render::Sampler* sampler, unsigned int uWrapMode, unsigned int vWrapMode );
398 * Add a new property buffer to RenderManager
399 * @param[in] propertryBuffer The property buffer to add
400 * @post Sends a message to RenderManager to add the property buffer.
401 * The property buffer will be owned by RenderManager
403 void AddPropertyBuffer( Render::PropertyBuffer* propertryBuffer );
406 * Removes an existing PropertyBuffer from RenderManager
407 * @param[in] propertryBuffer The property buffer to remove
408 * @post The property buffer will be destroyed in the render thread
410 void RemovePropertyBuffer( Render::PropertyBuffer* propertryBuffer );
413 * Sets the format of an existing property buffer
414 * @param[in] propertyBuffer The property buffer.
415 * @param[in] format The new format of the buffer
416 * @post Sends a message to RenderManager to set the new format to the property buffer.
418 void SetPropertyBufferFormat(Render::PropertyBuffer* propertyBuffer, Render::PropertyBuffer::Format* format );
421 * Sets the data of an existing property buffer
422 * @param[in] propertyBuffer The property buffer.
423 * @param[in] data The new data of the buffer
424 * @param[in] size The new size of the buffer
425 * @post Sends a message to RenderManager to set the new data to the property buffer.
427 void SetPropertyBufferData(Render::PropertyBuffer* propertyBuffer, Dali::Vector<char>* data, size_t size);
430 * Adds a geometry to the RenderManager
431 * @param[in] geometry The geometry to add
432 * @post Sends a message to RenderManager to add the Geometry
433 * The geometry will be owned by RenderManager
435 void AddGeometry( Render::Geometry* geometry );
438 * Removes an existing Geometry from RenderManager
439 * @param[in] geometry The geometry to remove
440 * @post The geometry will be destroyed in the render thread
442 void RemoveGeometry( Render::Geometry* geometry );
445 * Sets if a Geometry requieres depth testing
446 * @param[in] geometry The geometry
447 * @param[in] requiresDepthTest True if the geometry requires depth testing, false otherwise
449 void SetGeometryRequiresDepthTest( Render::Geometry* geometry, bool requiresDepthTest );
452 * Sets the geometry type of an existing Geometry
453 * @param[in] geometry The geometry
454 * @param[in] geometryType The type of the geometry
456 void SetGeometryType( Render::Geometry* geometry, unsigned int geometryType );
459 * Sets the index buffer to be used by a geometry
460 * @param[in] geometry The geometry
461 * @param[in] indices A vector containing the indices for the geometry
463 void SetIndexBuffer( Render::Geometry* geometry, Dali::Vector<unsigned short>& indices );
466 * Adds a vertex buffer to a geomtry
467 * @param[in] geometry The geometry
468 * @param[in] propertyBuffer The property buffer
470 void AddVertexBuffer( Render::Geometry* geometry, Render::PropertyBuffer* propertyBuffer );
473 * Removes a vertex buffer from a geometry
474 * @param[in] geometry The geometry
475 * @param[in] propertyBuffer The property buffer
477 void RemoveVertexBuffer( Render::Geometry* geometry, Render::PropertyBuffer* propertyBuffer );
483 * Performs an Update traversal on the scene-graph.
484 * @param[in] elapsedSeconds The elapsed time that should be applied to animations.
485 * @param[in] lastVSyncTimeMilliseconds The last time, in milliseconds, that we had a VSync.
486 * @param[in] nextVSyncTimeMilliseconds The estimated time, in milliseconds, of the next VSync.
487 * @return True if further updates are required e.g. during animations.
489 unsigned int Update( float elapsedSeconds, unsigned int lastVSyncTimeMilliseconds, unsigned int nextVSyncTimeMilliseconds );
492 * Set the background color i.e. the glClear color used at the beginning of each frame.
493 * @param[in] color The new background color.
495 void SetBackgroundColor(const Vector4& color);
498 * Set the default surface rect.
499 * @param[in] rect The rect value representing the surface.
501 void SetDefaultSurfaceRect( const Rect<int>& rect );
504 * @copydoc Dali::Stage::KeepRendering()
506 void KeepRendering( float durationSeconds );
509 * Sets the depths of all layers.
510 * @param layers The layers in depth order.
511 * @param[in] systemLevel True if using the system-level overlay.
513 void SetLayerDepths( const std::vector< Layer* >& layers, bool systemLevel );
518 UpdateManager(const UpdateManager&);
521 UpdateManager& operator=(const UpdateManager& rhs);
524 * Helper to check whether the update-thread should keep going.
525 * @param[in] elapsedSeconds The time in seconds since the previous update.
526 * @return True if the update-thread should keep going.
528 unsigned int KeepUpdatingCheck( float elapsedSeconds ) const;
531 * Helper to calculate new camera setup when root node resizes.
532 * @param[in] updateBuffer The buffer to read the root node size from.
534 void UpdateProjectionAndViewMatrices(int updateBuffer);
537 * Post process resources that have been updated by renderer
539 void PostProcessResources();
542 * Helper to reset all Node properties
543 * @param[in] bufferIndex to use
545 void ResetProperties( BufferIndex bufferIndex );
548 * Perform gesture updates.
549 * @param[in] bufferIndex to use
550 * @param[in] lastVSyncTime The last VSync time in milliseconds.
551 * @param[in] nextVSyncTime The estimated time of the next VSync in milliseconds.
552 * @return true, if any properties were updated.
554 bool ProcessGestures( BufferIndex bufferIndex, unsigned int lastVSyncTimeMilliseconds, unsigned int nextVSyncTimeMilliseconds );
557 * Perform animation updates
558 * @param[in] bufferIndex to use
559 * @param[in] elapsedSeconds time since last frame
561 void Animate( BufferIndex bufferIndex, float elapsedSeconds );
564 * Applies constraints to CustomObjects
565 * @param[in] bufferIndex to use
567 void ConstrainCustomObjects( BufferIndex bufferIndex );
570 * Applies constraints to RenderTasks
571 * @param[in] bufferIndex to use
573 void ConstrainRenderTasks( BufferIndex bufferIndex );
576 * Applies constraints to Shaders
577 * @param[in] bufferIndex to use
579 void ConstrainShaders( BufferIndex bufferIndex );
582 * Perform property notification updates
583 * @param[in] bufferIndex to use
585 void ProcessPropertyNotifications( BufferIndex bufferIndex );
588 * Prepare textures for rendering
590 void PrepareTextureSets( BufferIndex bufferIndex );
593 * Pass shader binaries queued here on to event thread.
595 void ForwardCompiledShadersToEventThread();
598 * Update the default camera.
599 * This must be altered to match the root Node for 2D layouting.
600 * @param[in] updateBuffer The buffer to read the root node size from.
602 void UpdateDefaultCamera( int updateBuffer );
605 * Update node shaders, opacity, geometry etc.
606 * @param[in] bufferIndex to use
608 void UpdateNodes( BufferIndex bufferIndex );
612 * @param[in] bufferIndex to use
614 void UpdateRenderers( BufferIndex bufferIndex );
618 // needs to be direct member so that getter for event buffer can be inlined
619 SceneGraphBuffers mSceneGraphBuffers;
626 // Messages for UpdateManager
628 inline void InstallRootMessage( UpdateManager& manager, Layer& root, bool systemLevel )
630 typedef MessageValue2< UpdateManager, Layer*, bool > LocalType;
632 // Reserve some memory inside the message queue
633 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
635 // Construct message in the message queue memory; note that delete should not be called on the return value
636 new (slot) LocalType( &manager, &UpdateManager::InstallRoot, &root, systemLevel );
639 inline void AddNodeMessage( UpdateManager& manager, Node& node )
641 typedef MessageValue1< UpdateManager, OwnerPointer<Node> > LocalType;
643 // Reserve some memory inside the message queue
644 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
646 // Construct message in the message queue memory; note that delete should not be called on the return value
647 new (slot) LocalType( &manager, &UpdateManager::AddNode, &node );
650 inline void ConnectNodeMessage( UpdateManager& manager, const Node& constParent, const Node& constChild )
652 // Update thread can edit the object
653 Node& parent = const_cast< Node& >( constParent );
654 Node& child = const_cast< Node& >( constChild );
656 typedef MessageValue2< UpdateManager, Node*, Node* > LocalType;
658 // Reserve some memory inside the message queue
659 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
661 // Construct message in the message queue memory; note that delete should not be called on the return value
662 new (slot) LocalType( &manager, &UpdateManager::ConnectNode, &parent, &child );
665 inline void DisconnectNodeMessage( UpdateManager& manager, const Node& constNode )
667 // Scene graph thread can modify this object.
668 Node& node = const_cast< Node& >( constNode );
670 typedef MessageValue1< UpdateManager, Node* > LocalType;
672 // Reserve some memory inside the message queue
673 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
675 // Construct message in the message queue memory; note that delete should not be called on the return value
676 new (slot) LocalType( &manager, &UpdateManager::DisconnectNode, &node );
679 inline void DestroyNodeMessage( UpdateManager& manager, const Node& constNode )
681 // Scene graph thread can destroy this object.
682 Node& node = const_cast< Node& >( constNode );
684 typedef MessageValue1< UpdateManager, Node* > LocalType;
686 // Reserve some memory inside the message queue
687 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
689 // Construct message in the message queue memory; note that delete should not be called on the return value
690 new (slot) LocalType( &manager, &UpdateManager::DestroyNode, &node );
693 inline void AttachToNodeMessage( UpdateManager& manager, const Node& constParent, NodeAttachment* attachment )
695 // Scene graph thread can modify this object.
696 Node& parent = const_cast< Node& >( constParent );
698 typedef MessageValue2< UpdateManager, Node*, NodeAttachmentOwner > LocalType;
700 // Reserve some memory inside the message queue
701 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
703 // Construct message in the message queue memory; note that delete should not be called on the return value
704 new (slot) LocalType( &manager, &UpdateManager::AttachToNode, &parent, attachment );
707 inline void AddObjectMessage( UpdateManager& manager, PropertyOwner* object )
709 typedef MessageValue1< UpdateManager, OwnerPointer<PropertyOwner> > LocalType;
711 // Reserve some memory inside the message queue
712 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
714 // Construct message in the message queue memory; note that delete should not be called on the return value
715 new (slot) LocalType( &manager, &UpdateManager::AddObject, object );
718 inline void RemoveObjectMessage( UpdateManager& manager, PropertyOwner* object )
720 typedef MessageValue1< UpdateManager, PropertyOwner* > LocalType;
722 // Reserve some memory inside the message queue
723 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
725 // Construct message in the message queue memory; note that delete should not be called on the return value
726 new (slot) LocalType( &manager, &UpdateManager::RemoveObject, object );
729 inline void AddAnimationMessage( UpdateManager& manager, Animation* animation )
731 typedef MessageValue1< UpdateManager, Animation* > LocalType;
733 // Reserve some memory inside the message queue
734 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
736 // Construct message in the message queue memory; note that delete should not be called on the return value
737 new (slot) LocalType( &manager, &UpdateManager::AddAnimation, animation );
740 inline void StopAnimationMessage( UpdateManager& manager, const Animation& constAnimation )
742 // The scene-graph thread owns this object so it can safely edit it.
743 Animation& animation = const_cast< Animation& >( constAnimation );
745 typedef MessageValue1< UpdateManager, Animation* > LocalType;
747 // Reserve some memory inside the message queue
748 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
750 // Construct message in the message queue memory; note that delete should not be called on the return value
751 new (slot) LocalType( &manager, &UpdateManager::StopAnimation, &animation );
754 inline void RemoveAnimationMessage( UpdateManager& manager, const Animation& constAnimation )
756 // The scene-graph thread owns this object so it can safely edit it.
757 Animation& animation = const_cast< Animation& >( constAnimation );
759 typedef MessageValue1< UpdateManager, Animation* > LocalType;
761 // Reserve some memory inside the message queue
762 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
764 // Construct message in the message queue memory; note that delete should not be called on the return value
765 new (slot) LocalType( &manager, &UpdateManager::RemoveAnimation, &animation );
768 inline void AddPropertyNotificationMessage( UpdateManager& manager, PropertyNotification* propertyNotification )
770 typedef MessageValue1< UpdateManager, PropertyNotification* > LocalType;
772 // Reserve some memory inside the message queue
773 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
775 // Construct message in the message queue memory; note that delete should not be called on the return value
776 new (slot) LocalType( &manager, &UpdateManager::AddPropertyNotification, propertyNotification );
779 inline void RemovePropertyNotificationMessage( UpdateManager& manager, const PropertyNotification& constPropertyNotification )
781 // The scene-graph thread owns this object so it can safely edit it.
782 PropertyNotification& propertyNotification = const_cast< PropertyNotification& >( constPropertyNotification );
784 typedef MessageValue1< UpdateManager, PropertyNotification* > LocalType;
786 // Reserve some memory inside the message queue
787 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
789 // Construct message in the message queue memory; note that delete should not be called on the return value
790 new (slot) LocalType( &manager, &UpdateManager::RemovePropertyNotification, &propertyNotification );
793 inline void PropertyNotificationSetNotifyModeMessage( UpdateManager& manager,
794 const PropertyNotification* constPropertyNotification,
795 PropertyNotification::NotifyMode notifyMode )
797 // The scene-graph thread owns this object so it can safely edit it.
798 PropertyNotification* propertyNotification = const_cast< PropertyNotification* >( constPropertyNotification );
800 typedef MessageValue2< UpdateManager, PropertyNotification*, PropertyNotification::NotifyMode > LocalType;
802 // Reserve some memory inside the message queue
803 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
805 // Construct message in the message queue memory; note that delete should not be called on the return value
806 new (slot) LocalType( &manager, &UpdateManager::PropertyNotificationSetNotify, propertyNotification, notifyMode );
809 // The render thread can safely change the Shader
810 inline void AddShaderMessage( UpdateManager& manager, Shader& shader )
812 typedef MessageValue1< UpdateManager, OwnerPointer< Shader > > LocalType;
814 // Reserve some memory inside the message queue
815 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
817 // Construct message in the message queue memory; note that delete should not be called on the return value
818 new (slot) LocalType( &manager, &UpdateManager::AddShader, &shader );
821 // The render thread can safely change the Shader
822 inline void RemoveShaderMessage( UpdateManager& manager, Shader& shader )
824 typedef MessageValue1< UpdateManager, Shader* > LocalType;
826 // Reserve some memory inside the message queue
827 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
829 // Construct message in the message queue memory; note that delete should not be called on the return value
830 new (slot) LocalType( &manager, &UpdateManager::RemoveShader, &shader );
833 inline void SetShaderProgramMessage( UpdateManager& manager,
835 Internal::ShaderDataPtr shaderData,
836 bool modifiesGeometry )
838 typedef MessageValue3< UpdateManager, Shader*, Internal::ShaderDataPtr, bool > LocalType;
840 // Reserve some memory inside the message queue
841 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
843 // Construct message in the message queue memory; note that delete should not be called on the return value
844 new (slot) LocalType( &manager, &UpdateManager::SetShaderProgram, &shader, shaderData, modifiesGeometry );
847 inline void SetBackgroundColorMessage( UpdateManager& manager, const Vector4& color )
849 typedef MessageValue1< UpdateManager, Vector4 > LocalType;
851 // Reserve some memory inside the message queue
852 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
854 // Construct message in the message queue memory; note that delete should not be called on the return value
855 new (slot) LocalType( &manager, &UpdateManager::SetBackgroundColor, color );
858 inline void SetDefaultSurfaceRectMessage( UpdateManager& manager, const Rect<int>& rect )
860 typedef MessageValue1< UpdateManager, Rect<int> > LocalType;
862 // Reserve some memory inside the message queue
863 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
865 // Construct message in the message queue memory; note that delete should not be called on the return value
866 new (slot) LocalType( &manager, &UpdateManager::SetDefaultSurfaceRect, rect );
869 inline void KeepRenderingMessage( UpdateManager& manager, float durationSeconds )
871 typedef MessageValue1< UpdateManager, float > LocalType;
873 // Reserve some memory inside the message queue
874 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
876 // Construct message in the message queue memory; note that delete should not be called on the return value
877 new (slot) LocalType( &manager, &UpdateManager::KeepRendering, durationSeconds );
881 * Create a message for setting the depth of a layer
882 * @param[in] manager The update manager
883 * @param[in] layers list of layers
884 * @param[in] systemLevel True if the layers are added via the SystemOverlay API
886 inline void SetLayerDepthsMessage( UpdateManager& manager, const std::vector< Layer* >& layers, bool systemLevel )
888 typedef MessageValue2< UpdateManager, std::vector< Layer* >, bool > LocalType;
890 // Reserve some memory inside the message queue
891 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
893 // Construct message in the message queue memory; note that delete should not be called on the return value
894 new (slot) LocalType( &manager, &UpdateManager::SetLayerDepths, layers, systemLevel );
897 inline void AddGestureMessage( UpdateManager& manager, PanGesture* gesture )
899 typedef MessageValue1< UpdateManager, PanGesture* > LocalType;
901 // Reserve some memory inside the message queue
902 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
904 // Construct message in the message queue memory; note that delete should not be called on the return value
905 new (slot) LocalType( &manager, &UpdateManager::AddGesture, gesture );
908 inline void RemoveGestureMessage( UpdateManager& manager, PanGesture* gesture )
910 typedef MessageValue1< UpdateManager, PanGesture* > LocalType;
912 // Reserve some memory inside the message queue
913 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
915 // Construct message in the message queue memory; note that delete should not be called on the return value
916 new (slot) LocalType( &manager, &UpdateManager::RemoveGesture, gesture );
919 template< typename T >
920 inline void AddMessage( UpdateManager& manager, ObjectOwnerContainer<T>& owner, T& object )
922 typedef MessageValue1< ObjectOwnerContainer<T>, OwnerPointer< T > > LocalType;
924 // Reserve some memory inside the message queue
925 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
926 // Construct message in the message queue memory; note that delete should not be called on the return value
927 new (slot) LocalType( &owner, &ObjectOwnerContainer<T>::Add, &object );
930 template< typename T >
931 inline void RemoveMessage( UpdateManager& manager, ObjectOwnerContainer<T>& owner, T& object )
933 typedef MessageValue1< ObjectOwnerContainer<T>, T* > LocalType;
935 // Reserve some memory inside the message queue
936 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
937 // Construct message in the message queue memory; note that delete should not be called on the return value
938 new (slot) LocalType( &owner, &ObjectOwnerContainer<T>::Remove, &object );
941 // The render thread can safely change the Shader
942 inline void AddTextureSetMessage( UpdateManager& manager, TextureSet& textureSet )
944 typedef MessageValue1< UpdateManager, OwnerPointer< TextureSet > > LocalType;
946 // Reserve some memory inside the message queue
947 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
949 // Construct message in the message queue memory; note that delete should not be called on the return value
950 new (slot) LocalType( &manager, &UpdateManager::AddTextureSet, &textureSet );
953 // The render thread can safely change the Shader
954 inline void RemoveTextureSetMessage( UpdateManager& manager, TextureSet& textureSet )
956 typedef MessageValue1< UpdateManager, TextureSet* > LocalType;
958 // Reserve some memory inside the message queue
959 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
961 // Construct message in the message queue memory; note that delete should not be called on the return value
962 new (slot) LocalType( &manager, &UpdateManager::RemoveTextureSet, &textureSet );
965 inline void AddSamplerMessage( UpdateManager& manager, Render::Sampler& sampler )
967 typedef MessageValue1< UpdateManager, Render::Sampler* > LocalType;
969 // Reserve some memory inside the message queue
970 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
972 // Construct message in the message queue memory; note that delete should not be called on the return value
973 new (slot) LocalType( &manager, &UpdateManager::AddSampler, &sampler );
976 inline void RemoveSamplerMessage( UpdateManager& manager, Render::Sampler& sampler )
978 typedef MessageValue1< UpdateManager, Render::Sampler* > LocalType;
980 // Reserve some memory inside the message queue
981 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
983 // Construct message in the message queue memory; note that delete should not be called on the return value
984 new (slot) LocalType( &manager, &UpdateManager::RemoveSampler, &sampler );
987 inline void SetFilterModeMessage( UpdateManager& manager, Render::Sampler& sampler, unsigned int minFilterMode, unsigned int magFilterMode )
989 typedef MessageValue3< UpdateManager, Render::Sampler*, unsigned int, unsigned int > LocalType;
991 // Reserve some memory inside the message queue
992 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
994 // Construct message in the message queue memory; note that delete should not be called on the return value
995 new (slot) LocalType( &manager, &UpdateManager::SetFilterMode, &sampler, minFilterMode, magFilterMode );
998 inline void SetWrapModeMessage( UpdateManager& manager, Render::Sampler& sampler, unsigned int uWrapMode, unsigned int vWrapMode )
1000 typedef MessageValue3< UpdateManager, Render::Sampler*, unsigned int, unsigned int > LocalType;
1002 // Reserve some memory inside the message queue
1003 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1005 // Construct message in the message queue memory; note that delete should not be called on the return value
1006 new (slot) LocalType( &manager, &UpdateManager::SetWrapMode, &sampler, uWrapMode, vWrapMode );
1009 inline void AddPropertyBuffer( UpdateManager& manager, Render::PropertyBuffer& propertyBuffer )
1011 typedef MessageValue1< UpdateManager, Render::PropertyBuffer* > LocalType;
1013 // Reserve some memory inside the message queue
1014 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1016 // Construct message in the message queue memory; note that delete should not be called on the return value
1017 new (slot) LocalType( &manager, &UpdateManager::AddPropertyBuffer, &propertyBuffer );
1020 inline void RemovePropertyBuffer( UpdateManager& manager, Render::PropertyBuffer& propertyBuffer )
1022 typedef MessageValue1< UpdateManager, Render::PropertyBuffer* > LocalType;
1024 // Reserve some memory inside the message queue
1025 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1027 // Construct message in the message queue memory; note that delete should not be called on the return value
1028 new (slot) LocalType( &manager, &UpdateManager::RemovePropertyBuffer, &propertyBuffer );
1031 inline void SetPropertyBufferFormat( UpdateManager& manager, Render::PropertyBuffer& propertyBuffer, Render::PropertyBuffer::Format* format )
1033 typedef MessageValue2< UpdateManager, Render::PropertyBuffer*, Render::PropertyBuffer::Format* > LocalType;
1035 // Reserve some memory inside the message queue
1036 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1038 // Construct message in the message queue memory; note that delete should not be called on the return value
1039 new (slot) LocalType( &manager, &UpdateManager::SetPropertyBufferFormat, &propertyBuffer, format );
1042 inline void SetPropertyBufferData( UpdateManager& manager, Render::PropertyBuffer& propertyBuffer, Vector<char>* data, size_t size )
1044 typedef MessageValue3< UpdateManager, Render::PropertyBuffer*, Vector<char>*, size_t > LocalType;
1046 // Reserve some memory inside the message queue
1047 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1049 // Construct message in the message queue memory; note that delete should not be called on the return value
1050 new (slot) LocalType( &manager, &UpdateManager::SetPropertyBufferData, &propertyBuffer, data, size );
1053 inline void AddGeometry( UpdateManager& manager, Render::Geometry& geometry )
1055 typedef MessageValue1< UpdateManager, Render::Geometry* > LocalType;
1057 // Reserve some memory inside the message queue
1058 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1060 // Construct message in the message queue memory; note that delete should not be called on the return value
1061 new (slot) LocalType( &manager, &UpdateManager::AddGeometry, &geometry );
1064 inline void RemoveGeometry( UpdateManager& manager, Render::Geometry& geometry )
1066 typedef MessageValue1< UpdateManager, Render::Geometry* > LocalType;
1068 // Reserve some memory inside the message queue
1069 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
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::RemoveGeometry, &geometry );
1075 inline void AddVertexBufferMessage( UpdateManager& manager, Render::Geometry& geometry, const Render::PropertyBuffer& vertexBuffer )
1077 typedef MessageValue2< UpdateManager, Render::Geometry*, Render::PropertyBuffer* > LocalType;
1079 // Reserve some memory inside the message queue
1080 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
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::AddVertexBuffer, &geometry, const_cast<Render::PropertyBuffer*>(&vertexBuffer) );
1086 inline void RemoveVertexBufferMessage( UpdateManager& manager, Render::Geometry& geometry, const Render::PropertyBuffer& vertexBuffer )
1088 typedef MessageValue2< UpdateManager, Render::Geometry*, Render::PropertyBuffer* > LocalType;
1090 // Reserve some memory inside the message queue
1091 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1093 // Construct message in the message queue memory; note that delete should not be called on the return value
1094 new (slot) LocalType( &manager, &UpdateManager::RemoveVertexBuffer, &geometry, const_cast<Render::PropertyBuffer*>(&vertexBuffer) );
1097 // Custom message type for SetIndexBuffer() used to move data with Vector::Swap()
1098 template< typename T >
1099 class IndexBufferMessage : public MessageBase
1104 * Constructor which does a Vector::Swap()
1106 IndexBufferMessage( T* manager, Render::Geometry* geometry, Dali::Vector<unsigned short>& indices )
1108 mManager( manager ),
1109 mRenderGeometry( geometry )
1111 mIndices.Swap( indices );
1115 * Virtual destructor
1117 virtual ~IndexBufferMessage()
1122 * @copydoc MessageBase::Process
1124 virtual void Process( BufferIndex /*bufferIndex*/ )
1126 DALI_ASSERT_DEBUG( mManager && "Message does not have an object" );
1127 mManager->SetIndexBuffer( mRenderGeometry, mIndices );
1133 Render::Geometry* mRenderGeometry;
1134 Dali::Vector<unsigned short> mIndices;
1137 inline void SetIndexBufferMessage( UpdateManager& manager, Render::Geometry& geometry, Dali::Vector<unsigned short>& indices )
1139 typedef IndexBufferMessage< UpdateManager > LocalType;
1141 // Reserve some memory inside the message queue
1142 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1144 // Construct message in the message queue memory; note that delete should not be called on the return value
1145 new (slot) LocalType( &manager, &geometry, indices );
1148 inline void SetGeometryTypeMessage( UpdateManager& manager, Render::Geometry& geometry, unsigned int geometryType )
1150 typedef MessageValue2< UpdateManager, Render::Geometry*, unsigned int > LocalType;
1152 // Reserve some memory inside the message queue
1153 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1155 // Construct message in the message queue memory; note that delete should not be called on the return value
1156 new (slot) LocalType( &manager, &UpdateManager::SetGeometryType, &geometry, geometryType );
1159 inline void SetGeometryRequiresDepthTestMessage( UpdateManager& manager, Render::Geometry& geometry, bool requiresDepthTest )
1161 typedef MessageValue2< UpdateManager, Render::Geometry*, bool > LocalType;
1163 // Reserve some memory inside the message queue
1164 unsigned int* 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::SetGeometryRequiresDepthTest, &geometry, requiresDepthTest );
1170 } // namespace SceneGraph
1172 } // namespace Internal
1176 #endif // __DALI_INTERNAL_SCENE_GRAPH_UPDATE_MANAGER_H__