1 #ifndef DALI_INTERNAL_SCENE_GRAPH_UPDATE_MANAGER_H
2 #define DALI_INTERNAL_SCENE_GRAPH_UPDATE_MANAGER_H
5 * Copyright (c) 2018 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/internal/common/message.h>
26 #include <dali/internal/common/type-abstraction-enums.h>
27 #include <dali/internal/common/shader-saver.h>
28 #include <dali/internal/event/common/event-thread-services.h>
29 #include <dali/internal/update/animation/scene-graph-animation.h>
30 #include <dali/internal/update/common/property-resetter.h>
31 #include <dali/internal/update/common/scene-graph-buffers.h>
32 #include <dali/internal/update/common/scene-graph-property-notification.h>
33 #include <dali/internal/update/nodes/node.h>
34 #include <dali/internal/update/nodes/scene-graph-layer.h>
35 #include <dali/internal/update/rendering/scene-graph-renderer.h> // for OwnerPointer< Renderer >
36 #include <dali/internal/update/rendering/scene-graph-texture-set.h> // for OwnerPointer< TextureSet >
37 #include <dali/internal/update/gestures/scene-graph-pan-gesture.h>
38 #include <dali/internal/update/render-tasks/scene-graph-camera.h>
39 #include <dali/internal/render/shaders/scene-graph-shader.h> // for OwnerPointer< Shader >
40 #include <dali/internal/render/renderers/render-property-buffer.h>
41 #include <dali/internal/event/rendering/texture-impl.h>
48 class GlSyncAbstraction;
49 class RenderController;
51 } // namespace Integration
56 class PropertyNotifier;
57 class NotificationManager;
58 class CompleteNotificationInterface;
66 // value types used by messages
67 template <> struct ParameterType< PropertyNotification::NotifyMode >
68 : public BasicType< PropertyNotification::NotifyMode > {};
77 class RenderTaskProcessor;
83 SceneGraph::Node* node;
85 NodeDepthPair( SceneGraph::Node* node, uint32_t sortedDepth )
87 sortedDepth(sortedDepth)
98 void Add( SceneGraph::Node* node, uint32_t sortedDepth )
100 nodeDepths.push_back( NodeDepthPair( node, sortedDepth ) );
103 std::vector<NodeDepthPair> nodeDepths;
108 * UpdateManager maintains a scene graph i.e. a tree of nodes as well as
109 * other scene graph property owning objects.
110 * It controls the Update traversal, in which nodes are repositioned/animated,
111 * and organizes the the culling and rendering of the scene.
112 * It also maintains the lifecycle of nodes and other property owners that are
113 * disconnected from the scene graph.
115 class UpdateManager : public ShaderSaver
120 * Construct a new UpdateManager.
121 * @param[in] notificationManager This should be notified when animations have finished.
122 * @param[in] animationPlaylist The CompleteNotificationInterface that handles the animations
123 * @param[in] propertyNotifier The PropertyNotifier
124 * @param[in] discardQueue Nodes are added here when disconnected from the scene-graph.
125 * @param[in] controller After messages are flushed, we request a render from the RenderController.
126 * @param[in] renderManager This is responsible for rendering the results of each "update".
127 * @param[in] renderQueue Used to queue messages for the next render.
128 * @param[in] renderTaskProcessor Handles RenderTasks and RenderInstrucitons.
130 UpdateManager( NotificationManager& notificationManager,
131 CompleteNotificationInterface& animationPlaylist,
132 PropertyNotifier& propertyNotifier,
133 DiscardQueue& discardQueue,
134 Integration::RenderController& controller,
135 RenderManager& renderManager,
136 RenderQueue& renderQueue,
137 RenderTaskProcessor& renderTaskProcessor );
142 virtual ~UpdateManager();
144 // Node connection methods
147 * Installs a new layer as the root node.
148 * @pre The UpdateManager does not already have an installed root node.
149 * @pre The layer is of derived Node type Layer.
150 * @pre The layer does not have a parent.
151 * @param[in] layer The new root node.
152 * @param[in] systemLevel True if using the system-level overlay.
153 * @post The node is owned by UpdateManager.
155 void InstallRoot( OwnerPointer<Layer>& layer, bool systemLevel );
158 * Add a Node; UpdateManager takes ownership.
159 * @pre The node does not have a parent.
160 * @note even though nodes are pool allocated, they also contain other heap allocated data, thus using OwnerPointer when transferring the data
161 * @param[in] node The node to add.
163 void AddNode( OwnerPointer<Node>& node );
166 * Connect a Node to the scene-graph.
167 * A disconnected Node has has no parent or children, and its properties cannot be animated/constrained.
168 * @pre The node does not already have a parent.
169 * @param[in] parent The new parent node.
171 void ConnectNode( Node* parent, Node* node );
174 * Disconnect a Node from the scene-graph.
175 * A disconnected Node has has no parent or children, and its properties cannot be animated/constrained.
176 * @pre The node has a parent.
177 * @param[in] node The node to disconnect.
179 void DisconnectNode( Node* node );
182 * Destroy a Node owned by UpdateManager.
183 * This is not immediate; Nodes are passed to the RenderQueue to allow GL resources to be deleted.
184 * In the following update, the previously queued Nodes may be deleted.
185 * @pre The node has been disconnected from the scene-graph i.e. has no parent or children.
186 * @param[in] node The node to destroy.
188 void DestroyNode( Node* node );
191 * Add a camera on scene
192 * @param[in] camera The camera to add
194 void AddCamera( OwnerPointer< Camera >& camera );
197 * Remove a camera from scene
198 * @param[in] camera to remove
200 void RemoveCamera( const Camera* camera );
203 * Add a newly created object.
204 * @param[in] object The object to add.
205 * @post The object is owned by UpdateManager.
207 void AddObject( OwnerPointer<PropertyOwner>& object );
211 * @param[in] object The object to remove.
213 void RemoveObject( PropertyOwner* object );
218 * Add a newly created animation.
219 * @param[in] animation The animation to add.
220 * @post The animation is owned by UpdateManager.
222 void AddAnimation( OwnerPointer< SceneGraph::Animation >& animation );
226 * @param[in] animation The animation to stop.
228 void StopAnimation( Animation* animation );
231 * Remove an animation.
232 * @param[in] animation The animation to remove.
234 void RemoveAnimation( Animation* animation );
237 * Query whether any animations are currently running.
238 * @return True if any animations are running.
240 bool IsAnimationRunning() const;
243 * Add a property resetter. UpdateManager takes ownership of the object.
244 * It will be killed by UpdateManager when the associated animator or
245 * constraint has finished; or the property owner of the property is destroyed.
247 void AddPropertyResetter( OwnerPointer<PropertyResetterBase>& propertyResetter );
249 // Property Notification
252 * Add a newly created property notification
253 * @param[in] propertyNotification The notification to add
254 * @post The propertyNotification is owned by UpdateManager.
256 void AddPropertyNotification( OwnerPointer< PropertyNotification >& propertyNotification );
259 * Remove a property notification
260 * @param[in] propertyNotification The notification to remove
262 void RemovePropertyNotification( PropertyNotification* propertyNotification );
265 * Set Notify state for PropertyNotification
266 * @param[in] propertyNotification The notification to remove
267 * @param[in] notifyMode The notification mode.
269 void PropertyNotificationSetNotify( PropertyNotification* propertyNotification, PropertyNotification::NotifyMode notifyMode );
274 * Add a newly created shader.
275 * @param[in] shader The shader to add.
276 * @post The shader is owned by the UpdateManager.
278 void AddShader( OwnerPointer< Shader >& shader );
282 * @pre The shader has been added to the UpdateManager.
283 * @param[in] shader The shader to remove.
284 * @post The shader is destroyed.
286 void RemoveShader( Shader* shader );
289 * Set the shader program for a Shader object
290 * @param[in] shader The shader to modify
291 * @param[in] shaderData Source code, hash over source, and optional compiled binary for the shader program
292 * @param[in] modifiesGeometry True if the vertex shader modifies geometry
294 void SetShaderProgram( Shader* shader, Internal::ShaderDataPtr shaderData, bool modifiesGeometry );
297 * @brief Accept compiled shaders passed back on render thread for saving.
298 * @param[in] shaderData Source code, hash over source, and corresponding compiled binary to be saved.
300 virtual void SaveBinary( Internal::ShaderDataPtr shaderData );
303 * @brief Set the destination for compiled shader binaries to be passed on to.
304 * The dispatcher passed in will be called from the update thread.
305 * @param[in] upstream A sink for ShaderDatas to be passed into.
307 void SetShaderSaver( ShaderSaver& upstream );
312 * Add a new renderer to scene
313 * @param renderer to add
315 void AddRenderer( OwnerPointer< Renderer >& renderer );
318 * Add a renderer from scene
319 * @param renderer to remove
321 void RemoveRenderer( Renderer* renderer );
326 * Set the pan gesture processor.
327 * Pan Gesture processor lives for the lifetime of UpdateManager
328 * @param[in] gesture The gesture processor.
329 * @post The gestureProcessor is owned by the UpdateManager.
331 void SetPanGestureProcessor( PanGesture* gestureProcessor );
336 * Add a newly created TextureSet.
337 * @param[in] textureSet The texture set to add.
338 * @post The TextureSet is owned by the UpdateManager.
340 void AddTextureSet( OwnerPointer< TextureSet >& textureSet );
343 * Remove a TextureSet.
344 * @pre The TextureSet has been added to the UpdateManager.
345 * @param[in] textureSet The TextureSet to remove.
346 * @post The TextureSet is destroyed.
348 void RemoveTextureSet( TextureSet* textureSet );
353 * Get the scene graph side list of RenderTasks.
354 * @param[in] systemLevel True if using the system-level overlay.
355 * @return The list of render tasks
357 RenderTaskList* GetRenderTaskList( bool systemLevel );
359 // Message queue handling
362 * Reserve space for another message in the queue; this must then be initialized by the caller.
363 * The message will be read from the update-thread after the next FlushMessages is called.
364 * @post Calling this method may invalidate any previously returned slots.
365 * @param[in] size The message size with respect to the size of type "char".
366 * @param[in] updateScene A flag, when true denotes that the message will cause the scene-graph node tree to require an update.
367 * @note the default value of updateScene should match that in EventThreadServices::ReserveMessageSlot.
368 * @return A pointer to the first char allocated for the message.
370 unsigned int* ReserveMessageSlot( std::size_t size, bool updateScene = true );
373 * @return the current event-buffer index.
375 BufferIndex GetEventBufferIndex() const
377 // inlined as its called often from event thread
378 return mSceneGraphBuffers.GetEventBufferIndex();
382 * Called by the event-thread to signal that FlushQueue will be called
383 * e.g. when it has finished event processing.
385 void EventProcessingStarted();
388 * Flush the set of messages, which were previously stored with QueueMessage().
389 * Calls to this thread-safe method should be minimized, to avoid thread blocking.
391 * @return True if there are messages to process.
396 * Add a new sampler to RenderManager
397 * @param[in] sampler The sampler to add
398 * @post Sends a message to RenderManager to add the sampler.
399 * The sampler will be owned by RenderManager
401 void AddSampler( OwnerPointer< Render::Sampler >& sampler );
404 * Removes an existing sampler from RenderManager
405 * @param[in] sampler The sampler to remove
406 * @post The sampler will be destroyed in the render thread
408 void RemoveSampler( Render::Sampler* sampler );
411 * Sets the filter modes for an existing sampler
412 * @param[in] sampler The sampler
413 * @param[in] minFilterMode The filter to use under minification
414 * @param[in] magFilterMode The filter to use under magnification
416 void SetFilterMode( Render::Sampler* sampler, unsigned int minFilterMode, unsigned int magFilterMode );
419 * Sets the wrap mode for an existing sampler
420 * @param[in] sampler The sampler
421 * @param[in] rWrapMode Wrapping mode in z direction
422 * @param[in] sWrapMode Wrapping mode in x direction
423 * @param[in] tWrapMode Wrapping mode in y direction
425 void SetWrapMode( Render::Sampler* sampler, unsigned int rWrapMode, unsigned int sWrapMode, unsigned int tWrapMode );
428 * Add a new property buffer to RenderManager
429 * @param[in] propertryBuffer The property buffer to add
430 * @post Sends a message to RenderManager to add the property buffer.
431 * The property buffer will be owned by RenderManager
433 void AddPropertyBuffer( OwnerPointer< Render::PropertyBuffer >& propertryBuffer );
436 * Removes an existing PropertyBuffer from RenderManager
437 * @param[in] propertryBuffer The property buffer to remove
438 * @post The property buffer will be destroyed in the render thread
440 void RemovePropertyBuffer( Render::PropertyBuffer* propertryBuffer );
443 * Sets the format of an existing property buffer
444 * @param[in] propertyBuffer The property buffer.
445 * @param[in] format The new format of the buffer
446 * @post Sends a message to RenderManager to set the new format to the property buffer.
448 void SetPropertyBufferFormat( Render::PropertyBuffer* propertyBuffer, OwnerPointer< Render::PropertyBuffer::Format>& format );
451 * Sets the data of an existing property buffer
452 * @param[in] propertyBuffer The property buffer.
453 * @param[in] data The new data of the buffer
454 * @param[in] size The new size of the buffer
455 * @post Sends a message to RenderManager to set the new data to the property buffer.
457 void SetPropertyBufferData( Render::PropertyBuffer* propertyBuffer, OwnerPointer< Vector<char> >& data, size_t size );
460 * Adds a geometry to the RenderManager
461 * @param[in] geometry The geometry to add
462 * @post Sends a message to RenderManager to add the Geometry
463 * The geometry will be owned by RenderManager
465 void AddGeometry( OwnerPointer< Render::Geometry >& geometry );
468 * Removes an existing Geometry from RenderManager
469 * @param[in] geometry The geometry to remove
470 * @post The geometry will be destroyed in the render thread
472 void RemoveGeometry( Render::Geometry* geometry );
475 * Sets the geometry type of an existing Geometry
476 * @param[in] geometry The geometry
477 * @param[in] geometryType The type of the geometry
479 void SetGeometryType( Render::Geometry* geometry, unsigned int geometryType );
482 * Sets the index buffer to be used by a geometry
483 * @param[in] geometry The geometry
484 * @param[in] indices A vector containing the indices for the geometry
486 void SetIndexBuffer( Render::Geometry* geometry, Dali::Vector<unsigned short>& indices );
489 * Adds a vertex buffer to a geometry
490 * @param[in] geometry The geometry
491 * @param[in] propertyBuffer The property buffer
493 void AttachVertexBuffer( Render::Geometry* geometry, Render::PropertyBuffer* propertyBuffer );
496 * Removes a vertex buffer from a geometry
497 * @param[in] geometry The geometry
498 * @param[in] propertyBuffer The property buffer
500 void RemoveVertexBuffer( Render::Geometry* geometry, Render::PropertyBuffer* propertyBuffer );
503 * Adds a texture to the render manager
504 * @param[in] texture The texture to add
505 * The texture will be owned by RenderManager
507 void AddTexture( OwnerPointer< Render::Texture >& texture );
510 * Removes a texture from the render manager
511 * @param[in] texture The texture to remove
512 * @post The texture will be destroyed in the render thread
514 void RemoveTexture( Render::Texture* texture );
517 * Uploads data to a texture owned by the RenderManager
518 * @param[in] texture The texture
519 * @param[in] pixelData The pixel data object
520 * @param[in] params The parameters for the upload
522 void UploadTexture( Render::Texture* texture, PixelDataPtr pixelData, const Texture::UploadParams& params );
525 * Generates mipmaps for a texture owned by the RenderManager
526 * @param[in] texture The texture
528 void GenerateMipmaps( Render::Texture* texture );
531 * Adds a framebuffer to the render manager
532 * @param[in] frameBuffer The framebuffer to add
533 * The framebuffer will be owned by RenderManager
535 void AddFrameBuffer( Render::FrameBuffer* frameBuffer );
538 * Removes a FrameBuffer from the render manager
539 * @param[in] frameBuffer The FrameBuffer to remove
540 * @post The FrameBuffer will be destroyed in the render thread
542 void RemoveFrameBuffer( Render::FrameBuffer* frameBuffer );
545 * Attach a texture as color output to an existing FrameBuffer
546 * @param[in] frameBuffer The FrameBuffer
547 * @param[in] texture The texture that will be used as output when rendering
548 * @param[in] mipmapLevel The mipmap of the texture to be attached
549 * @param[in] layer Indicates which layer of a cube map or array texture to attach. Unused for 2D textures
551 void AttachColorTextureToFrameBuffer( Render::FrameBuffer* frameBuffer, Render::Texture* texture, unsigned int mipmapLevel, unsigned int face );
556 * Performs an Update traversal on the scene-graph.
557 * @param[in] elapsedSeconds The elapsed time that should be applied to animations.
558 * @param[in] lastVSyncTimeMilliseconds The last time, in milliseconds, that we had a VSync.
559 * @param[in] nextVSyncTimeMilliseconds The estimated time, in milliseconds, of the next VSync.
560 * @param[in] renderToFboEnabled Whether rendering into the Frame Buffer Object is enabled.
561 * @param[in] isRenderingToFbo Whether this frame is being rendered into the Frame Buffer Object.
562 * @return True if further updates are required e.g. during animations.
564 unsigned int Update( float elapsedSeconds,
565 unsigned int lastVSyncTimeMilliseconds,
566 unsigned int nextVSyncTimeMilliseconds,
567 bool renderToFboEnabled,
568 bool isRenderingToFbo );
571 * Set the background color i.e. the glClear color used at the beginning of each frame.
572 * @param[in] color The new background color.
574 void SetBackgroundColor(const Vector4& color);
577 * Set the default surface rect.
578 * @param[in] rect The rect value representing the surface.
580 void SetDefaultSurfaceRect( const Rect<int>& rect );
583 * @copydoc Dali::Stage::KeepRendering()
585 void KeepRendering( float durationSeconds );
588 * Sets the depths of all layers.
589 * @param layers The layers in depth order.
590 * @param[in] systemLevel True if using the system-level overlay.
592 void SetLayerDepths( const std::vector< Layer* >& layers, bool systemLevel );
595 * Set the depth indices of all nodes (in LayerUI's)
596 * @param[in] nodeDepths A vector of nodes and associated depth indices
598 void SetDepthIndices( OwnerPointer< NodeDepths >& nodeDepths );
603 UpdateManager(const UpdateManager&);
606 UpdateManager& operator=(const UpdateManager& rhs);
609 * Helper to check whether the update-thread should keep going.
610 * @param[in] elapsedSeconds The time in seconds since the previous update.
611 * @return True if the update-thread should keep going.
613 unsigned int KeepUpdatingCheck( float elapsedSeconds ) const;
616 * Helper to reset all Node properties
617 * @param[in] bufferIndex to use
619 void ResetProperties( BufferIndex bufferIndex );
622 * Perform gesture updates.
623 * @param[in] bufferIndex to use
624 * @param[in] lastVSyncTime The last VSync time in milliseconds.
625 * @param[in] nextVSyncTime The estimated time of the next VSync in milliseconds.
626 * @return true, if any properties were updated.
628 bool ProcessGestures( BufferIndex bufferIndex, unsigned int lastVSyncTimeMilliseconds, unsigned int nextVSyncTimeMilliseconds );
631 * Perform animation updates
632 * @param[in] bufferIndex to use
633 * @param[in] elapsedSeconds time since last frame
635 void Animate( BufferIndex bufferIndex, float elapsedSeconds );
638 * Applies constraints to CustomObjects
639 * @param[in] bufferIndex to use
641 void ConstrainCustomObjects( BufferIndex bufferIndex );
644 * Applies constraints to RenderTasks
645 * @param[in] bufferIndex to use
647 void ConstrainRenderTasks( BufferIndex bufferIndex );
650 * Applies constraints to Shaders
651 * @param[in] bufferIndex to use
653 void ConstrainShaders( BufferIndex bufferIndex );
656 * Perform property notification updates
657 * @param[in] bufferIndex to use
659 void ProcessPropertyNotifications( BufferIndex bufferIndex );
662 * Pass shader binaries queued here on to event thread.
664 void ForwardCompiledShadersToEventThread();
667 * Update node shaders, opacity, geometry etc.
668 * @param[in] bufferIndex to use
670 void UpdateNodes( BufferIndex bufferIndex );
674 * @param[in] bufferIndex to use
676 void UpdateRenderers( BufferIndex bufferIndex );
680 // needs to be direct member so that getter for event buffer can be inlined
681 SceneGraphBuffers mSceneGraphBuffers;
688 // Messages for UpdateManager
690 inline void InstallRootMessage( UpdateManager& manager, OwnerPointer<Layer>& root, bool systemLevel )
692 // Message has ownership of Layer while in transit from event -> update
693 typedef MessageValue2< UpdateManager, OwnerPointer<Layer>, bool > LocalType;
695 // Reserve some memory inside the message queue
696 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
698 // Construct message in the message queue memory; note that delete should not be called on the return value
699 new (slot) LocalType( &manager, &UpdateManager::InstallRoot, root, systemLevel );
702 inline void AddNodeMessage( UpdateManager& manager, OwnerPointer<Node>& node )
704 // Message has ownership of Node while in transit from event -> update
705 typedef MessageValue1< UpdateManager, OwnerPointer<Node> > LocalType;
707 // Reserve some memory inside the message queue
708 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
710 // Construct message in the message queue memory; note that delete should not be called on the return value
711 new (slot) LocalType( &manager, &UpdateManager::AddNode, node );
714 inline void ConnectNodeMessage( UpdateManager& manager, const Node& constParent, const Node& constChild )
716 // Update thread can edit the object
717 Node& parent = const_cast< Node& >( constParent );
718 Node& child = const_cast< Node& >( constChild );
720 typedef MessageValue2< UpdateManager, Node*, Node* > 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::ConnectNode, &parent, &child );
729 inline void DisconnectNodeMessage( UpdateManager& manager, const Node& constNode )
731 // Scene graph thread can modify this object.
732 Node& node = const_cast< Node& >( constNode );
734 typedef MessageValue1< UpdateManager, Node* > LocalType;
736 // Reserve some memory inside the message queue
737 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
739 // Construct message in the message queue memory; note that delete should not be called on the return value
740 new (slot) LocalType( &manager, &UpdateManager::DisconnectNode, &node );
743 inline void DestroyNodeMessage( UpdateManager& manager, const Node& constNode )
745 // Scene graph thread can destroy this object.
746 Node& node = const_cast< Node& >( constNode );
748 typedef MessageValue1< UpdateManager, Node* > LocalType;
750 // Reserve some memory inside the message queue
751 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
753 // Construct message in the message queue memory; note that delete should not be called on the return value
754 new (slot) LocalType( &manager, &UpdateManager::DestroyNode, &node );
757 inline void AddCameraMessage( UpdateManager& manager, OwnerPointer< Camera >& camera )
759 // Message has ownership of Camera while in transit from event -> update
760 typedef MessageValue1< UpdateManager, OwnerPointer< Camera > > LocalType;
762 // Reserve some memory inside the message queue
763 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
765 // Construct message in the message queue memory; note that delete should not be called on the return value
766 new (slot) LocalType( &manager, &UpdateManager::AddCamera, camera );
769 inline void RemoveCameraMessage( UpdateManager& manager, const Camera* camera )
771 typedef MessageValue1< UpdateManager, const Camera* > LocalType;
773 // Reserve some memory inside the message queue
774 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
776 // Construct message in the message queue memory; note that delete should not be called on the return value
777 new (slot) LocalType( &manager, &UpdateManager::RemoveCamera, camera );
780 inline void AddObjectMessage( UpdateManager& manager, OwnerPointer<PropertyOwner>& object )
782 // Message has ownership of object while in transit from event -> update
783 typedef MessageValue1< UpdateManager, OwnerPointer<PropertyOwner> > LocalType;
785 // Reserve some memory inside the message queue
786 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
788 // Construct message in the message queue memory; note that delete should not be called on the return value
789 new (slot) LocalType( &manager, &UpdateManager::AddObject, object );
792 inline void RemoveObjectMessage( UpdateManager& manager, PropertyOwner* object )
794 typedef MessageValue1< UpdateManager, PropertyOwner* > LocalType;
796 // Reserve some memory inside the message queue
797 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
799 // Construct message in the message queue memory; note that delete should not be called on the return value
800 new (slot) LocalType( &manager, &UpdateManager::RemoveObject, object );
803 inline void AddAnimationMessage( UpdateManager& manager, OwnerPointer< SceneGraph::Animation >& animation )
805 typedef MessageValue1< UpdateManager, OwnerPointer< SceneGraph::Animation > > LocalType;
807 // Reserve some memory inside the message queue
808 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
810 // Construct message in the message queue memory; note that delete should not be called on the return value
811 new (slot) LocalType( &manager, &UpdateManager::AddAnimation, animation );
814 inline void StopAnimationMessage( UpdateManager& manager, const Animation& constAnimation )
816 // The scene-graph thread owns this object so it can safely edit it.
817 Animation& animation = const_cast< Animation& >( constAnimation );
819 typedef MessageValue1< UpdateManager, Animation* > LocalType;
821 // Reserve some memory inside the message queue
822 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
824 // Construct message in the message queue memory; note that delete should not be called on the return value
825 new (slot) LocalType( &manager, &UpdateManager::StopAnimation, &animation );
828 inline void RemoveAnimationMessage( UpdateManager& manager, const Animation& constAnimation )
830 // The scene-graph thread owns this object so it can safely edit it.
831 Animation& animation = const_cast< Animation& >( constAnimation );
833 typedef MessageValue1< UpdateManager, Animation* > LocalType;
835 // Reserve some memory inside the message queue
836 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
838 // Construct message in the message queue memory; note that delete should not be called on the return value
839 new (slot) LocalType( &manager, &UpdateManager::RemoveAnimation, &animation );
842 inline void AddPropertyNotificationMessage( UpdateManager& manager, OwnerPointer< PropertyNotification >& propertyNotification )
844 // Message has ownership of PropertyNotification while in transit from event -> update
845 typedef MessageValue1< UpdateManager, OwnerPointer< PropertyNotification > > LocalType;
847 // Reserve some memory inside the message queue
848 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
850 // Construct message in the message queue memory; note that delete should not be called on the return value
851 new (slot) LocalType( &manager, &UpdateManager::AddPropertyNotification, propertyNotification );
854 inline void RemovePropertyNotificationMessage( UpdateManager& manager, const PropertyNotification& constPropertyNotification )
856 // The scene-graph thread owns this object so it can safely edit it.
857 PropertyNotification& propertyNotification = const_cast< PropertyNotification& >( constPropertyNotification );
859 typedef MessageValue1< UpdateManager, PropertyNotification* > LocalType;
861 // Reserve some memory inside the message queue
862 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
864 // Construct message in the message queue memory; note that delete should not be called on the return value
865 new (slot) LocalType( &manager, &UpdateManager::RemovePropertyNotification, &propertyNotification );
868 inline void PropertyNotificationSetNotifyModeMessage( UpdateManager& manager,
869 const PropertyNotification* constPropertyNotification,
870 PropertyNotification::NotifyMode notifyMode )
872 // The scene-graph thread owns this object so it can safely edit it.
873 PropertyNotification* propertyNotification = const_cast< PropertyNotification* >( constPropertyNotification );
875 typedef MessageValue2< UpdateManager, PropertyNotification*, PropertyNotification::NotifyMode > LocalType;
877 // Reserve some memory inside the message queue
878 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
880 // Construct message in the message queue memory; note that delete should not be called on the return value
881 new (slot) LocalType( &manager, &UpdateManager::PropertyNotificationSetNotify, propertyNotification, notifyMode );
884 // The render thread can safely change the Shader
885 inline void AddShaderMessage( UpdateManager& manager, OwnerPointer< Shader >& shader )
887 typedef MessageValue1< UpdateManager, OwnerPointer< Shader > > LocalType;
889 // Reserve some memory inside the message queue
890 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
892 // Construct message in the message queue memory; note that delete should not be called on the return value
893 new (slot) LocalType( &manager, &UpdateManager::AddShader, shader );
896 // The render thread can safely change the Shader
897 inline void RemoveShaderMessage( UpdateManager& manager, Shader& shader )
899 typedef MessageValue1< UpdateManager, Shader* > 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::RemoveShader, &shader );
908 inline void SetShaderProgramMessage( UpdateManager& manager,
910 Internal::ShaderDataPtr shaderData,
911 bool modifiesGeometry )
913 typedef MessageValue3< UpdateManager, Shader*, Internal::ShaderDataPtr, bool > LocalType;
915 // Reserve some memory inside the message queue
916 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
918 // Construct message in the message queue memory; note that delete should not be called on the return value
919 new (slot) LocalType( &manager, &UpdateManager::SetShaderProgram, &shader, shaderData, modifiesGeometry );
922 inline void SetBackgroundColorMessage( UpdateManager& manager, const Vector4& color )
924 typedef MessageValue1< UpdateManager, Vector4 > LocalType;
926 // Reserve some memory inside the message queue
927 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
929 // Construct message in the message queue memory; note that delete should not be called on the return value
930 new (slot) LocalType( &manager, &UpdateManager::SetBackgroundColor, color );
933 inline void SetDefaultSurfaceRectMessage( UpdateManager& manager, const Rect<int>& rect )
935 typedef MessageValue1< UpdateManager, Rect<int> > LocalType;
937 // Reserve some memory inside the message queue
938 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
940 // Construct message in the message queue memory; note that delete should not be called on the return value
941 new (slot) LocalType( &manager, &UpdateManager::SetDefaultSurfaceRect, rect );
944 inline void KeepRenderingMessage( UpdateManager& manager, float durationSeconds )
946 typedef MessageValue1< UpdateManager, float > LocalType;
948 // Reserve some memory inside the message queue
949 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
951 // Construct message in the message queue memory; note that delete should not be called on the return value
952 new (slot) LocalType( &manager, &UpdateManager::KeepRendering, durationSeconds );
956 * Create a message for setting the depth of a layer
957 * @param[in] manager The update manager
958 * @param[in] layers list of layers
959 * @param[in] systemLevel True if the layers are added via the SystemOverlay API
961 inline void SetLayerDepthsMessage( UpdateManager& manager, const std::vector< Layer* >& layers, bool systemLevel )
963 typedef MessageValue2< UpdateManager, std::vector< Layer* >, bool > LocalType;
965 // Reserve some memory inside the message queue
966 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
968 // Construct message in the message queue memory; note that delete should not be called on the return value
969 new (slot) LocalType( &manager, &UpdateManager::SetLayerDepths, layers, systemLevel );
972 inline void AddRendererMessage( UpdateManager& manager, OwnerPointer< Renderer >& object )
974 typedef MessageValue1< UpdateManager, OwnerPointer< Renderer > > LocalType;
976 // Reserve some memory inside the message queue
977 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
978 // Construct message in the message queue memory; note that delete should not be called on the return value
979 new (slot) LocalType( &manager, &UpdateManager::AddRenderer, object );
982 inline void RemoveRendererMessage( UpdateManager& manager, Renderer& object )
984 typedef MessageValue1< UpdateManager, Renderer* > LocalType;
986 // Reserve some memory inside the message queue
987 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
988 // Construct message in the message queue memory; note that delete should not be called on the return value
989 new (slot) LocalType( &manager, &UpdateManager::RemoveRenderer, &object );
992 // The render thread can safely change the Shader
993 inline void AddTextureSetMessage( UpdateManager& manager, OwnerPointer< TextureSet >& textureSet )
995 typedef MessageValue1< UpdateManager, OwnerPointer< TextureSet > > LocalType;
997 // Reserve some memory inside the message queue
998 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1000 // Construct message in the message queue memory; note that delete should not be called on the return value
1001 new (slot) LocalType( &manager, &UpdateManager::AddTextureSet, textureSet );
1004 // The render thread can safely change the Shader
1005 inline void RemoveTextureSetMessage( UpdateManager& manager, TextureSet& textureSet )
1007 typedef MessageValue1< UpdateManager, TextureSet* > LocalType;
1009 // Reserve some memory inside the message queue
1010 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1012 // Construct message in the message queue memory; note that delete should not be called on the return value
1013 new (slot) LocalType( &manager, &UpdateManager::RemoveTextureSet, &textureSet );
1016 inline void AddSamplerMessage( UpdateManager& manager, OwnerPointer< Render::Sampler >& sampler )
1018 // Message has ownership of Sampler while in transit from event -> update
1019 typedef MessageValue1< UpdateManager, OwnerPointer< Render::Sampler > > LocalType;
1021 // Reserve some memory inside the message queue
1022 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1024 // Construct message in the message queue memory; note that delete should not be called on the return value
1025 new (slot) LocalType( &manager, &UpdateManager::AddSampler, sampler );
1028 inline void RemoveSamplerMessage( UpdateManager& manager, Render::Sampler& sampler )
1030 typedef MessageValue1< UpdateManager, Render::Sampler* > LocalType;
1032 // Reserve some memory inside the message queue
1033 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1035 // Construct message in the message queue memory; note that delete should not be called on the return value
1036 new (slot) LocalType( &manager, &UpdateManager::RemoveSampler, &sampler );
1039 inline void SetFilterModeMessage( UpdateManager& manager, Render::Sampler& sampler, unsigned int minFilterMode, unsigned int magFilterMode )
1041 typedef MessageValue3< UpdateManager, Render::Sampler*, unsigned int, unsigned int > LocalType;
1043 // Reserve some memory inside the message queue
1044 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1046 // Construct message in the message queue memory; note that delete should not be called on the return value
1047 new (slot) LocalType( &manager, &UpdateManager::SetFilterMode, &sampler, minFilterMode, magFilterMode );
1050 inline void SetWrapModeMessage( UpdateManager& manager, Render::Sampler& sampler, unsigned int rWrapMode, unsigned int sWrapMode, unsigned int tWrapMode )
1052 typedef MessageValue4< UpdateManager, Render::Sampler*, unsigned int, unsigned int, unsigned int > LocalType;
1054 // Reserve some memory inside the message queue
1055 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
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::SetWrapMode, &sampler, rWrapMode, sWrapMode, tWrapMode );
1061 inline void AddPropertyBuffer( UpdateManager& manager, OwnerPointer< Render::PropertyBuffer >& propertyBuffer )
1063 // Message has ownership of propertyBuffer while in transit from event -> update
1064 typedef MessageValue1< UpdateManager, OwnerPointer< Render::PropertyBuffer > > LocalType;
1066 // Reserve some memory inside the message queue
1067 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1069 // Construct message in the message queue memory; note that delete should not be called on the return value
1070 new (slot) LocalType( &manager, &UpdateManager::AddPropertyBuffer, propertyBuffer );
1073 inline void RemovePropertyBuffer( UpdateManager& manager, Render::PropertyBuffer& propertyBuffer )
1075 typedef MessageValue1< UpdateManager, Render::PropertyBuffer* > LocalType;
1077 // Reserve some memory inside the message queue
1078 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1080 // Construct message in the message queue memory; note that delete should not be called on the return value
1081 new (slot) LocalType( &manager, &UpdateManager::RemovePropertyBuffer, &propertyBuffer );
1084 inline void SetPropertyBufferFormat( UpdateManager& manager, Render::PropertyBuffer& propertyBuffer, OwnerPointer< Render::PropertyBuffer::Format>& format )
1086 // Message has ownership of PropertyBuffer::Format while in transit from event -> update
1087 typedef MessageValue2< UpdateManager, Render::PropertyBuffer*, OwnerPointer< Render::PropertyBuffer::Format> > LocalType;
1089 // Reserve some memory inside the message queue
1090 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1092 // Construct message in the message queue memory; note that delete should not be called on the return value
1093 new (slot) LocalType( &manager, &UpdateManager::SetPropertyBufferFormat, &propertyBuffer, format );
1096 inline void SetPropertyBufferData( UpdateManager& manager, Render::PropertyBuffer& propertyBuffer, OwnerPointer< Vector<char> >& data, size_t size )
1098 // Message has ownership of PropertyBuffer data while in transit from event -> update
1099 typedef MessageValue3< UpdateManager, Render::PropertyBuffer*, OwnerPointer< Vector<char> >, size_t > LocalType;
1101 // Reserve some memory inside the message queue
1102 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1104 // Construct message in the message queue memory; note that delete should not be called on the return value
1105 new (slot) LocalType( &manager, &UpdateManager::SetPropertyBufferData, &propertyBuffer, data, size );
1108 inline void AddGeometry( UpdateManager& manager, OwnerPointer< Render::Geometry >& geometry )
1110 // Message has ownership of Geometry while in transit from event -> update
1111 typedef MessageValue1< UpdateManager, OwnerPointer< Render::Geometry > > LocalType;
1113 // Reserve some memory inside the message queue
1114 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1116 // Construct message in the message queue memory; note that delete should not be called on the return value
1117 new (slot) LocalType( &manager, &UpdateManager::AddGeometry, geometry );
1120 inline void RemoveGeometry( UpdateManager& manager, Render::Geometry& geometry )
1122 typedef MessageValue1< UpdateManager, Render::Geometry* > LocalType;
1124 // Reserve some memory inside the message queue
1125 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1127 // Construct message in the message queue memory; note that delete should not be called on the return value
1128 new (slot) LocalType( &manager, &UpdateManager::RemoveGeometry, &geometry );
1131 inline void AttachVertexBufferMessage( UpdateManager& manager, Render::Geometry& geometry, const Render::PropertyBuffer& vertexBuffer )
1133 typedef MessageValue2< UpdateManager, Render::Geometry*, Render::PropertyBuffer* > LocalType;
1135 // Reserve some memory inside the message queue
1136 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1138 // Construct message in the message queue memory; note that delete should not be called on the return value
1139 new (slot) LocalType( &manager, &UpdateManager::AttachVertexBuffer, &geometry, const_cast<Render::PropertyBuffer*>(&vertexBuffer) );
1142 inline void RemoveVertexBufferMessage( UpdateManager& manager, Render::Geometry& geometry, const Render::PropertyBuffer& vertexBuffer )
1144 typedef MessageValue2< UpdateManager, Render::Geometry*, Render::PropertyBuffer* > LocalType;
1146 // Reserve some memory inside the message queue
1147 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1149 // Construct message in the message queue memory; note that delete should not be called on the return value
1150 new (slot) LocalType( &manager, &UpdateManager::RemoveVertexBuffer, &geometry, const_cast<Render::PropertyBuffer*>(&vertexBuffer) );
1153 // Custom message type for SetIndexBuffer() used to move data with Vector::Swap()
1154 template< typename T >
1155 class IndexBufferMessage : public MessageBase
1160 * Constructor which does a Vector::Swap()
1162 IndexBufferMessage( T* manager, Render::Geometry* geometry, Dali::Vector<unsigned short>& indices )
1164 mManager( manager ),
1165 mRenderGeometry( geometry )
1167 mIndices.Swap( indices );
1171 * Virtual destructor
1173 virtual ~IndexBufferMessage()
1178 * @copydoc MessageBase::Process
1180 virtual void Process( BufferIndex /*bufferIndex*/ )
1182 DALI_ASSERT_DEBUG( mManager && "Message does not have an object" );
1183 mManager->SetIndexBuffer( mRenderGeometry, mIndices );
1189 Render::Geometry* mRenderGeometry;
1190 Dali::Vector<unsigned short> mIndices;
1193 inline void SetIndexBufferMessage( UpdateManager& manager, Render::Geometry& geometry, Dali::Vector<unsigned short>& indices )
1195 typedef IndexBufferMessage< UpdateManager > LocalType;
1197 // Reserve some memory inside the message queue
1198 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1200 // Construct message in the message queue memory; note that delete should not be called on the return value
1201 new (slot) LocalType( &manager, &geometry, indices );
1204 inline void SetGeometryTypeMessage( UpdateManager& manager, Render::Geometry& geometry, unsigned int geometryType )
1206 typedef MessageValue2< UpdateManager, Render::Geometry*, unsigned int > LocalType;
1208 // Reserve some memory inside the message queue
1209 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1211 // Construct message in the message queue memory; note that delete should not be called on the return value
1212 new (slot) LocalType( &manager, &UpdateManager::SetGeometryType, &geometry, geometryType );
1215 inline void AddTexture( UpdateManager& manager, OwnerPointer< Render::Texture >& texture )
1217 // Message has ownership of Texture while in transit from event -> update
1218 typedef MessageValue1< UpdateManager, OwnerPointer< Render::Texture > > LocalType;
1220 // Reserve some memory inside the message queue
1221 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1223 // Construct message in the message queue memory; note that delete should not be called on the return value
1224 new (slot) LocalType( &manager, &UpdateManager::AddTexture, texture );
1227 inline void RemoveTexture( UpdateManager& manager, Render::Texture& texture )
1229 typedef MessageValue1< UpdateManager, Render::Texture* > LocalType;
1231 // Reserve some memory inside the message queue
1232 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1234 // Construct message in the message queue memory; note that delete should not be called on the return value
1235 new (slot) LocalType( &manager, &UpdateManager::RemoveTexture, &texture );
1238 inline void UploadTextureMessage( UpdateManager& manager, Render::Texture& texture, PixelDataPtr pixelData, const Texture::UploadParams& params )
1240 typedef MessageValue3< UpdateManager, Render::Texture*, PixelDataPtr, Texture::UploadParams > LocalType;
1242 // Reserve some memory inside the message queue
1243 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1245 // Construct message in the message queue memory; note that delete should not be called on the return value
1246 new (slot) LocalType( &manager, &UpdateManager::UploadTexture, &texture, pixelData, params );
1249 inline void GenerateMipmapsMessage( UpdateManager& manager, Render::Texture& texture )
1251 typedef MessageValue1< UpdateManager, Render::Texture* > LocalType;
1253 // Reserve some memory inside the message queue
1254 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1256 // Construct message in the message queue memory; note that delete should not be called on the return value
1257 new (slot) LocalType( &manager, &UpdateManager::GenerateMipmaps, &texture );
1261 inline void AddFrameBuffer( UpdateManager& manager, Render::FrameBuffer& frameBuffer )
1263 typedef MessageValue1< UpdateManager, Render::FrameBuffer* > LocalType;
1265 // Reserve some memory inside the message queue
1266 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1268 // Construct message in the message queue memory; note that delete should not be called on the return value
1269 new (slot) LocalType( &manager, &UpdateManager::AddFrameBuffer, &frameBuffer );
1272 inline void RemoveFrameBuffer( UpdateManager& manager, Render::FrameBuffer& frameBuffer )
1274 typedef MessageValue1< UpdateManager, Render::FrameBuffer* > LocalType;
1276 // Reserve some memory inside the message queue
1277 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1279 // Construct message in the message queue memory; note that delete should not be called on the return value
1280 new (slot) LocalType( &manager, &UpdateManager::RemoveFrameBuffer, &frameBuffer );
1283 inline void AttachColorTextureToFrameBuffer( UpdateManager& manager, Render::FrameBuffer& frameBuffer, Render::Texture* texture, unsigned int mipmapLevel, unsigned int layer )
1285 typedef MessageValue4< UpdateManager, Render::FrameBuffer*, Render::Texture*, unsigned int, unsigned int > LocalType;
1287 // Reserve some memory inside the message queue
1288 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1290 // Construct message in the message queue memory; note that delete should not be called on the return value
1291 new (slot) LocalType( &manager, &UpdateManager::AttachColorTextureToFrameBuffer, &frameBuffer, texture, mipmapLevel, layer );
1294 inline void SetDepthIndicesMessage( UpdateManager& manager, OwnerPointer< NodeDepths >& nodeDepths )
1296 typedef MessageValue1< UpdateManager, OwnerPointer< NodeDepths > > LocalType;
1298 // Reserve some memory inside the message queue
1299 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1301 // Construct message in the message queue memory; note that delete should not be called on the return value
1302 new (slot) LocalType( &manager, &UpdateManager::SetDepthIndices, nodeDepths );
1305 inline void AddResetterMessage( UpdateManager& manager, OwnerPointer<PropertyResetterBase> resetter )
1307 typedef MessageValue1< UpdateManager, OwnerPointer<PropertyResetterBase> > LocalType;
1309 // Reserve some memory inside the message queue
1310 unsigned int* slot = manager.ReserveMessageSlot( sizeof( LocalType ) );
1312 // Construct message in the message queue memory; note that delete should not be called on the return value
1313 new (slot) LocalType( &manager, &UpdateManager::AddPropertyResetter, resetter );
1317 } // namespace SceneGraph
1319 } // namespace Internal
1323 #endif // DALI_INTERNAL_SCENE_GRAPH_UPDATE_MANAGER_H