dali/internal/update/controllers/render-message-dispatcher.h

   1 #ifndef __DALI_INTERNAL_SCENE_GRAPH_RENDER_MESSAGE_DISPATCHER_H__
   2 #define __DALI_INTERNAL_SCENE_GRAPH_RENDER_MESSAGE_DISPATCHER_H__
   3
   4 /*
   5  * Copyright (c) 2014 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/internal/update/common/scene-graph-buffers.h>
  23 #include <dali/internal/render/gl-resources/gpu-buffer.h>
  24 #include <dali/internal/render/renderers/render-property-buffer.h>
  25
  26 namespace Dali
  27 {
  28
  29 namespace Internal
  30 {
  31 class MessageBase;
  32
  33 namespace Render
  34 {
  35 class Renderer;
  36 }
  37 namespace SceneGraph
  38 {
  39
  40 class RenderManager;
  41 class RenderQueue;
  42 class RenderTracker;
  43 class RenderGeometry;
  44 class PropertyBufferDataProvider;
  45 /**
  46  * A utility class for sending messages to the render-thread.
  47  */
  48 class RenderMessageDispatcher
  49 {
  50 public:
  51
  52   /**
  53    * Constructor
  54    */
  55   RenderMessageDispatcher( RenderManager& renderManager, RenderQueue& renderQueue, const SceneGraphBuffers& buffers );
  56
  57   /**
  58    * Destructor
  59    */
  60   virtual ~RenderMessageDispatcher();
  61
  62   /**
  63    * Add a Renderer.
  64    * @param[in] renderer The renderer to add.
  65    * @post renderer ownership is transferred.
  66    */
  67   void AddRenderer( Render::Renderer& renderer );
  68
  69   /**
  70    * Remove a Renderer.
  71    * @param[in] renderer The renderer to remove.
  72    * @post renderer will be destroyed in the next Render.
  73    */
  74   void RemoveRenderer( Render::Renderer& renderer );
  75
  76   /**
  77    * Add a Geometry
  78    * @param[in] renderGeometry The geometry to add.
  79    * @post RenderGeometry ownership is transferred.
  80    */
  81   void AddGeometry( RenderGeometry& renderGeometry );
  82
  83   /**
  84    * Remove a Geometry.
  85    * @param[in] renderGeometry The geometry to remove.
  86    * @post RenderGeometry will be destroyed in the next Render.
  87    */
  88   void RemoveGeometry( RenderGeometry& renderGeometry );
  89
  90   /**
  91    * Add a PropertyBuffer.
  92    * @param[in] renderGeometry The geometry
  93    * @param[in] propertyBuffer The PropertyBuffer
  94    * @param[in] isIndexBuffer True if the buffer is intended to be used as an index buffer
  95    */
  96   void AddPropertyBuffer( RenderGeometry& renderGeometry, Render::PropertyBuffer* propertyBuffer, bool isIndexBuffer );
  97
  98   /**
  99    * Remove a PropertyBuffer.
 100    * @param[in] renderGeometry The geometry
 101    * @param[in] propertyBuffer The PropertyBuffer
 102    * @post PropertyBuffer will be destroyed in the next Render.
 103    */
 104   void RemovePropertyBuffer( RenderGeometry& renderGeometry, Render::PropertyBuffer* propertyBuffer );
 105
 106   /**
 107    * Set the geometry type of an existing render geometry
 108    * @param[in] geometry The render geometry
 109    * @param[in] geometryType The new geometry type
 110    */
 111   void SetGeometryType( RenderGeometry& geometry, int geometryType );
 112
 113   /**
 114    * Set if an existing geometry requires depth testing
 115    * @param[in] geometry The render geometry
 116    * @param[in] requiresDepthTest True if depth testing is required, false otherwise
 117    */
 118   void SetGeometryRequiresDepthTest( RenderGeometry& geometry, bool requiresDepthTest );
 119
 120   /**
 121    * Add a Render tracker.
 122    * @param[in] renderTracker The render tracker to add.
 123    * @post ownership is transferred
 124    */
 125   void AddRenderTracker( RenderTracker& renderTracker );
 126
 127   /**
 128    * Remove a Render tracker.
 129    * @param[in] renderTracker The render tracker to add.
 130    * @post render tracker will be destroyed in the next Render pass.
 131    */
 132   void RemoveRenderTracker( RenderTracker& renderTracker );
 133
 134 private:
 135
 136   RenderManager& mRenderManager;
 137   RenderQueue& mRenderQueue;
 138
 139   const SceneGraphBuffers& mBuffers;
 140 };
 141
 142 } // namespace SceneGraph
 143
 144 } // namespace Internal
 145
 146 } // namespace Dali
 147
 148 #endif // __DALI_INTERNAL_SCENE_GRAPH_RENDERER_DISPATCHER_H__