dali/internal/render/common/render-manager.h

   1 #ifndef DALI_INTERNAL_SCENE_GRAPH_RENDER_MANAGER_H
   2 #define DALI_INTERNAL_SCENE_GRAPH_RENDER_MANAGER_H
   3
   4 /*
   5  * Copyright (c) 2019 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/math/rect.h>
  23 #include <dali/integration-api/core-enumerations.h>
  24 #include <dali/internal/common/shader-saver.h>
  25 #include <dali/internal/render/gl-resources/gpu-buffer.h>
  26 #include <dali/internal/render/renderers/render-property-buffer.h>
  27 #include <dali/internal/event/rendering/texture-impl.h>
  28
  29 namespace Dali
  30 {
  31
  32 namespace Integration
  33 {
  34 class GlAbstraction;
  35 class GlSyncAbstraction;
  36 class GlContextHelperAbstraction;
  37 class RenderStatus;
  38 }
  39
  40 struct Vector4;
  41
  42 namespace Internal
  43 {
  44 class Context;
  45 class ProgramCache;
  46 class ShaderSaver;
  47
  48 namespace Render
  49 {
  50 class FrameBuffer;
  51 class Renderer;
  52 struct Sampler;
  53 class RenderTracker;
  54 class Geometry;
  55 class Texture;
  56 }
  57
  58 namespace SceneGraph
  59 {
  60 class RenderQueue;
  61 class RenderInstruction;
  62 class RenderInstructionContainer;
  63 class Shader;
  64 class PropertyBufferDataProvider;
  65
  66 /**
  67  * RenderManager is responsible for rendering the result of the previous "update", which
  68  * is provided in a RenderCommand during UpdateManager::Update().
  69  */
  70 class RenderManager
  71 {
  72 public:
  73
  74   /**
  75    * Construct a new RenderManager.
  76    * @param[in]  glAbstraction              The GL abstraction used for rendering.
  77    * @param[in]  glSyncAbstraction          The GL sync abstraction used fence sync creation/deletion.
  78    * @param[in]  glContextHelperAbstraction The GL context helper abstraction for accessing GL context.
  79    * @param[in]  depthBufferAvailable       Whether the depth buffer is available
  80    * @param[in]  stencilBufferAvailable     Whether the stencil buffer is available
  81    */
  82   static RenderManager* New( Integration::GlAbstraction& glAbstraction,
  83                              Integration::GlSyncAbstraction& glSyncAbstraction,
  84                              Integration::GlContextHelperAbstraction& glContextHelperAbstraction,
  85                              Integration::DepthBufferAvailable depthBufferAvailable,
  86                              Integration::StencilBufferAvailable stencilBufferAvailable );
  87
  88   /**
  89    * Non-virtual destructor; not intended as a base class
  90    */
  91   ~RenderManager();
  92
  93   /**
  94    * Retrieve the RenderQueue. Messages should only be added to this from the update-thread.
  95    * @return The render queue.
  96    */
  97   RenderQueue& GetRenderQueue();
  98
  99   /**
 100    * @copydoc Dali::Integration::Core::ContextCreated()
 101    */
 102   void ContextCreated();
 103
 104   /**
 105    * @copydoc Dali::Integration::Core::ContextToBeDestroyed()
 106    */
 107   void ContextDestroyed();
 108
 109   /**
 110    * Set the upstream interface for compiled shader binaries to be sent back to for eventual
 111    * caching and saving.
 112    * @param[in] upstream The abstract interface to send any received ShaderDatas onwards to..
 113    * @note This should be called during core initialisation if shader binaries are to be used.
 114    */
 115   void SetShaderSaver( ShaderSaver& upstream );
 116
 117   /**
 118    * Retrieve the render instructions; these should be set during each "update" traversal.
 119    * @return The render instruction container.
 120    */
 121   RenderInstructionContainer& GetRenderInstructionContainer();
 122
 123   // The following methods should be called via RenderQueue messages
 124
 125   /**
 126    * Set the background color i.e. the glClear color used at the beginning of each frame.
 127    * @param[in] color The new background color.
 128    */
 129   void SetBackgroundColor( const Vector4& color );
 130
 131   /*
 132    * Set the frame time delta (time elapsed since the last frame.
 133    * @param[in] deltaTime the delta time
 134    */
 135   void SetFrameDeltaTime( float deltaTime );
 136
 137   /**
 138    * Returns the rectangle for the default surface (probably the application window).
 139    * @return Rectangle for the surface.
 140    */
 141   void SetDefaultSurfaceRect( const Rect<int>& rect );
 142
 143   /**
 144    * Add a Renderer to the render manager.
 145    * @param[in] renderer The renderer to add.
 146    * @post renderer is owned by RenderManager
 147    */
 148   void AddRenderer( OwnerPointer< Render::Renderer >& renderer );
 149
 150   /**
 151    * Remove a Renderer from the render manager.
 152    * @param[in] renderer The renderer to remove.
 153    * @post renderer is destroyed.
 154    */
 155   void RemoveRenderer( Render::Renderer* renderer );
 156
 157   /**
 158    * Add a sampler to the render manager.
 159    * @param[in] sampler The sampler to add.
 160    * @post sampler is owned by RenderManager
 161    */
 162   void AddSampler( OwnerPointer< Render::Sampler >& sampler );
 163
 164   /**
 165    * Remove a sampler from the render manager.
 166    * @param[in] sampler The sampler to remove.
 167    * @post sampler is destroyed.
 168    */
 169   void RemoveSampler( Render::Sampler* sampler );
 170
 171   /**
 172    * Set minification and magnification filter modes for a sampler
 173    * @param[in] minFilterMode Filter mode to use when the texture is minificated
 174    * @param[in] magFilterMode Filter mode to use when the texture is magnified
 175    */
 176   void SetFilterMode( Render::Sampler* sampler, uint32_t minFilterMode, uint32_t magFilterMode );
 177
 178   /**
 179    * Set wrapping mode for a sampler
 180    * @param[in] rWrapMode Wrap mode in the z direction
 181    * @param[in] uWrapMode Wrap mode in the x direction
 182    * @param[in] vWrapMode Wrap mode in the y direction
 183    */
 184   void SetWrapMode( Render::Sampler* sampler, uint32_t rWrapMode, uint32_t sWrapMode, uint32_t tWrapMode );
 185
 186   /**
 187    * Add a property buffer to the render manager.
 188    * @param[in] propertyBuffer The property buffer to add.
 189    * @post propertBuffer is owned by RenderManager
 190    */
 191   void AddPropertyBuffer( OwnerPointer< Render::PropertyBuffer >& propertyBuffer );
 192
 193   /**
 194    * Remove a property buffer from the render manager.
 195    * @param[in] propertyBuffer The property buffer to remove.
 196    * @post propertyBuffer is destroyed.
 197    */
 198   void RemovePropertyBuffer( Render::PropertyBuffer* propertyBuffer );
 199
 200   /**
 201    * Add a geometry to the render manager.
 202    * @param[in] geometry The geometry to add.
 203    * @post geometry is owned by RenderManager
 204    */
 205   void AddGeometry( OwnerPointer< Render::Geometry >& geometry );
 206
 207   /**
 208    * Remove a geometry from the render manager.
 209    * @param[in] geometry The geometry to remove.
 210    * @post geometry is destroyed.
 211    */
 212   void RemoveGeometry( Render::Geometry* geometry );
 213
 214   /**
 215    * Adds a property buffer to a geometry from the render manager.
 216    * @param[in] geometry The geometry
 217    * @param[in] propertyBuffer The property buffer to remove.
 218    */
 219   void AttachVertexBuffer( Render::Geometry* geometry, Render::PropertyBuffer* propertyBuffer );
 220
 221   /**
 222    * Remove a property buffer from a Render::Geometry from the render manager.
 223    * @param[in] geometry The geometry
 224    * @param[in] propertyBuffer The property buffer to remove.
 225    * @post property buffer is destroyed.
 226    */
 227   void RemoveVertexBuffer( Render::Geometry* geometry, Render::PropertyBuffer* propertyBuffer );
 228
 229   /**
 230    * Sets the format of an existing property buffer
 231    * @param[in] propertyBuffer The property buffer.
 232    * @param[in] format The new format of the buffer
 233    */
 234   void SetPropertyBufferFormat( Render::PropertyBuffer* propertyBuffer, OwnerPointer< Render::PropertyBuffer::Format>& format );
 235
 236   /**
 237    * Sets the data of an existing property buffer
 238    * @param[in] propertyBuffer The property buffer.
 239    * @param[in] data The new data of the buffer
 240    * @param[in] size The new size of the buffer
 241    */
 242   void SetPropertyBufferData( Render::PropertyBuffer* propertyBuffer, OwnerPointer< Vector<uint8_t> >& data, uint32_t size );
 243
 244   /**
 245    * Sets the data for the index buffer of an existing geometry
 246    * @param[in] geometry The geometry
 247    * @param[in] data A vector containing the indices
 248    */
 249   void SetIndexBuffer( Render::Geometry* geometry, Dali::Vector<uint16_t>& data );
 250
 251   /**
 252    * Set the geometry type of an existing render geometry
 253    * @param[in] geometry The render geometry
 254    * @param[in] geometryType The new geometry type
 255    */
 256   void SetGeometryType( Render::Geometry* geometry, uint32_t geometryType );
 257
 258   /**
 259    * Adds a texture to the render manager
 260    * @param[in] texture The texture to add
 261    */
 262   void AddTexture( OwnerPointer< Render::Texture >& texture );
 263
 264   /**
 265    * Removes a texture from the render manager
 266    * @param[in] texture The texture to remove
 267    */
 268   void RemoveTexture( Render::Texture* texture );
 269
 270   /**
 271    * Uploads data to an existing texture
 272    * @param[in] texture The texture
 273    * @param[in] pixelData The pixel data object
 274    * @param[in] params The parameters for the upload
 275    */
 276   void UploadTexture( Render::Texture* texture, PixelDataPtr pixelData, const Texture::UploadParams& params );
 277
 278   /**
 279    * Generates mipmaps for a given texture
 280    * @param[in] texture The texture
 281    */
 282   void GenerateMipmaps( Render::Texture* texture );
 283
 284   /**
 285    * Adds a framebuffer to the render manager
 286    * @param[in] frameBuffer The framebuffer to add
 287    */
 288   void AddFrameBuffer( OwnerPointer< Render::FrameBuffer >& frameBuffer );
 289
 290   /**
 291    * Removes a framebuffer from the render manager
 292    * @param[in] frameBuffer The framebuffer to remove
 293    */
 294   void RemoveFrameBuffer( Render::FrameBuffer* frameBuffer );
 295
 296   /**
 297    * Attach a texture as color output to an existing FrameBuffer
 298    * @param[in] frameBuffer The FrameBuffer
 299    * @param[in] texture The texture that will be used as output when rendering
 300    * @param[in] mipmapLevel The mipmap of the texture to be attached
 301    * @param[in] layer Indicates which layer of a cube map or array texture to attach. Unused for 2D textures
 302    */
 303   void AttachColorTextureToFrameBuffer( Render::FrameBuffer* frameBuffer, Render::Texture* texture, uint32_t mipmapLevel, uint32_t layer );
 304
 305   /**
 306    * Adds a render tracker to the RenderManager. RenderManager takes ownership of the
 307    * tracker. The lifetime of the tracker is related to the lifetime of the tracked
 308    * object, usually an offscreen render task.
 309    * @param[in] renderTracker The render tracker
 310    */
 311   void AddRenderTracker( Render::RenderTracker* renderTracker );
 312
 313   /**
 314    * Removes a render tracker from the RenderManager.
 315    * @param[in] renderTracker The render tracker to remove.
 316    */
 317   void RemoveRenderTracker( Render::RenderTracker* renderTracker );
 318
 319   /**
 320    * returns the Program controller for sending program messages
 321    * @return the ProgramController
 322    */
 323   ProgramCache* GetProgramCache();
 324
 325   // This method should be called from Core::Render()
 326
 327   /**
 328    * Renders the results of the previous "update" traversal.
 329    * @param[out] status contains the rendering flags.
 330    * @param[in] forceClear force the Clear on the framebuffer even if nothing is rendered.
 331    */
 332   void Render( Integration::RenderStatus& status, bool forceClear );
 333
 334 private:
 335
 336   /**
 337    * Helper to process a single RenderInstruction.
 338    * @param[in] instruction A description of the rendering operation.
 339    */
 340   void DoRender( RenderInstruction& instruction );
 341
 342 private:
 343
 344   /**
 345    * Construct a new RenderManager.
 346    */
 347   RenderManager();
 348
 349   // Undefined
 350   RenderManager( const RenderManager& );
 351
 352   // Undefined
 353   RenderManager& operator=( const RenderManager& rhs );
 354
 355 private:
 356
 357   struct Impl;
 358   Impl* mImpl;
 359
 360 };
 361
 362 } // namespace SceneGraph
 363
 364 } // namespace Internal
 365
 366 } // namespace Dali
 367
 368 #endif // DALI_INTERNAL_SCENE_GRAPH_RENDER_MANAGER_H