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