dali/internal/update/manager/update-manager.h

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