1 #ifndef DALI_INTERNAL_SCENE_GRAPH_RENDER_MANAGER_H
2 #define DALI_INTERNAL_SCENE_GRAPH_RENDER_MANAGER_H
5 * Copyright (c) 2019 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
22 #include <dali/public-api/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>
35 class GlSyncAbstraction;
60 class RenderInstruction;
61 class RenderInstructionContainer;
63 class PropertyBufferDataProvider;
66 * RenderManager is responsible for rendering the result of the previous "update", which
67 * is provided in a RenderCommand during UpdateManager::Update().
74 * Construct a new RenderManager.
75 * @param[in] glAbstraction The GL abstraction used for rendering.
76 * @param[in] glSyncAbstraction The GL sync abstraction used fence sync creation/deletion.
77 * @param[in] depthBufferAvailable Whether the depth buffer is available
78 * @param[in] stencilBufferAvailable Whether the stencil buffer is available
80 static RenderManager* New( Integration::GlAbstraction& glAbstraction,
81 Integration::GlSyncAbstraction& glSyncAbstraction,
82 Integration::DepthBufferAvailable depthBufferAvailable,
83 Integration::StencilBufferAvailable stencilBufferAvailable );
86 * Non-virtual destructor; not intended as a base class
91 * Retrieve the RenderQueue. Messages should only be added to this from the update-thread.
92 * @return The render queue.
94 RenderQueue& GetRenderQueue();
97 * @copydoc Dali::Integration::Core::ContextCreated()
99 void ContextCreated();
102 * @copydoc Dali::Integration::Core::ContextToBeDestroyed()
104 void ContextDestroyed();
107 * Set the upstream interface for compiled shader binaries to be sent back to for eventual
108 * caching and saving.
109 * @param[in] upstream The abstract interface to send any received ShaderDatas onwards to..
110 * @note This should be called during core initialisation if shader binaries are to be used.
112 void SetShaderSaver( ShaderSaver& upstream );
115 * Retrieve the render instructions; these should be set during each "update" traversal.
116 * @return The render instruction container.
118 RenderInstructionContainer& GetRenderInstructionContainer();
120 // The following methods should be called via RenderQueue messages
123 * Set the background color i.e. the glClear color used at the beginning of each frame.
124 * @param[in] color The new background color.
126 void SetBackgroundColor( const Vector4& color );
129 * Set the frame time delta (time elapsed since the last frame.
130 * @param[in] deltaTime the delta time
132 void SetFrameDeltaTime( float deltaTime );
135 * Returns the rectangle for the default surface (probably the application window).
136 * @return Rectangle for the surface.
138 void SetDefaultSurfaceRect( const Rect<int>& rect );
141 * Returns the orintation for the default surface (probably the application window).
142 * @return Orientation for the surface.
144 void SetDefaultSurfaceOrientation( int orientation );
147 * Add a Renderer to the render manager.
148 * @param[in] renderer The renderer to add.
149 * @post renderer is owned by RenderManager
151 void AddRenderer( OwnerPointer< Render::Renderer >& renderer );
154 * Remove a Renderer from the render manager.
155 * @param[in] renderer The renderer to remove.
156 * @post renderer is destroyed.
158 void RemoveRenderer( Render::Renderer* renderer );
161 * Add a sampler to the render manager.
162 * @param[in] sampler The sampler to add.
163 * @post sampler is owned by RenderManager
165 void AddSampler( OwnerPointer< Render::Sampler >& sampler );
168 * Remove a sampler from the render manager.
169 * @param[in] sampler The sampler to remove.
170 * @post sampler is destroyed.
172 void RemoveSampler( Render::Sampler* sampler );
175 * Set minification and magnification filter modes for a sampler
176 * @param[in] minFilterMode Filter mode to use when the texture is minificated
177 * @param[in] magFilterMode Filter mode to use when the texture is magnified
179 void SetFilterMode( Render::Sampler* sampler, uint32_t minFilterMode, uint32_t magFilterMode );
182 * Set wrapping mode for a sampler
183 * @param[in] rWrapMode Wrap mode in the z direction
184 * @param[in] uWrapMode Wrap mode in the x direction
185 * @param[in] vWrapMode Wrap mode in the y direction
187 void SetWrapMode( Render::Sampler* sampler, uint32_t rWrapMode, uint32_t sWrapMode, uint32_t tWrapMode );
190 * Add a property buffer to the render manager.
191 * @param[in] propertyBuffer The property buffer to add.
192 * @post propertBuffer is owned by RenderManager
194 void AddPropertyBuffer( OwnerPointer< Render::PropertyBuffer >& propertyBuffer );
197 * Remove a property buffer from the render manager.
198 * @param[in] propertyBuffer The property buffer to remove.
199 * @post propertyBuffer is destroyed.
201 void RemovePropertyBuffer( Render::PropertyBuffer* propertyBuffer );
204 * Add a geometry to the render manager.
205 * @param[in] geometry The geometry to add.
206 * @post geometry is owned by RenderManager
208 void AddGeometry( OwnerPointer< Render::Geometry >& geometry );
211 * Remove a geometry from the render manager.
212 * @param[in] geometry The geometry to remove.
213 * @post geometry is destroyed.
215 void RemoveGeometry( Render::Geometry* geometry );
218 * Adds a property buffer to a geometry from the render manager.
219 * @param[in] geometry The geometry
220 * @param[in] propertyBuffer The property buffer to remove.
222 void AttachVertexBuffer( Render::Geometry* geometry, Render::PropertyBuffer* propertyBuffer );
225 * Remove a property buffer from a Render::Geometry from the render manager.
226 * @param[in] geometry The geometry
227 * @param[in] propertyBuffer The property buffer to remove.
228 * @post property buffer is destroyed.
230 void RemoveVertexBuffer( Render::Geometry* geometry, Render::PropertyBuffer* propertyBuffer );
233 * Sets the format of an existing property buffer
234 * @param[in] propertyBuffer The property buffer.
235 * @param[in] format The new format of the buffer
237 void SetPropertyBufferFormat( Render::PropertyBuffer* propertyBuffer, OwnerPointer< Render::PropertyBuffer::Format>& format );
240 * Sets the data of an existing property buffer
241 * @param[in] propertyBuffer The property buffer.
242 * @param[in] data The new data of the buffer
243 * @param[in] size The new size of the buffer
245 void SetPropertyBufferData( Render::PropertyBuffer* propertyBuffer, OwnerPointer< Vector<uint8_t> >& data, uint32_t size );
248 * Sets the data for the index buffer of an existing geometry
249 * @param[in] geometry The geometry
250 * @param[in] data A vector containing the indices
252 void SetIndexBuffer( Render::Geometry* geometry, Dali::Vector<uint16_t>& data );
255 * Set the geometry type of an existing render geometry
256 * @param[in] geometry The render geometry
257 * @param[in] geometryType The new geometry type
259 void SetGeometryType( Render::Geometry* geometry, uint32_t geometryType );
262 * Adds a texture to the render manager
263 * @param[in] texture The texture to add
265 void AddTexture( OwnerPointer< Render::Texture >& texture );
268 * Removes a texture from the render manager
269 * @param[in] texture The texture to remove
271 void RemoveTexture( Render::Texture* texture );
274 * Uploads data to an existing texture
275 * @param[in] texture The texture
276 * @param[in] pixelData The pixel data object
277 * @param[in] params The parameters for the upload
279 void UploadTexture( Render::Texture* texture, PixelDataPtr pixelData, const Texture::UploadParams& params );
282 * Generates mipmaps for a given texture
283 * @param[in] texture The texture
285 void GenerateMipmaps( Render::Texture* texture );
288 * Adds a framebuffer to the render manager
289 * @param[in] frameBuffer The framebuffer to add
291 void AddFrameBuffer( OwnerPointer< Render::FrameBuffer >& frameBuffer );
294 * Removes a framebuffer from the render manager
295 * @param[in] frameBuffer The framebuffer to remove
297 void RemoveFrameBuffer( Render::FrameBuffer* frameBuffer );
300 * Attach a texture as color output to an existing FrameBuffer
301 * @param[in] frameBuffer The FrameBuffer
302 * @param[in] texture The texture that will be used as output when rendering
303 * @param[in] mipmapLevel The mipmap of the texture to be attached
304 * @param[in] layer Indicates which layer of a cube map or array texture to attach. Unused for 2D textures
306 void AttachColorTextureToFrameBuffer( Render::FrameBuffer* frameBuffer, Render::Texture* texture, uint32_t mipmapLevel, uint32_t layer );
309 * Adds a render tracker to the RenderManager. RenderManager takes ownership of the
310 * tracker. The lifetime of the tracker is related to the lifetime of the tracked
311 * object, usually an offscreen render task.
312 * @param[in] renderTracker The render tracker
314 void AddRenderTracker( Render::RenderTracker* renderTracker );
317 * Removes a render tracker from the RenderManager.
318 * @param[in] renderTracker The render tracker to remove.
320 void RemoveRenderTracker( Render::RenderTracker* renderTracker );
323 * returns the Program controller for sending program messages
324 * @return the ProgramController
326 ProgramCache* GetProgramCache();
328 // This method should be called from Core::Render()
331 * Renders the results of the previous "update" traversal.
332 * @param[out] status contains the rendering flags.
333 * @param[in] forceClear force the Clear on the framebuffer even if nothing is rendered.
335 void Render( Integration::RenderStatus& status, bool forceClear );
340 * Helper to process a single RenderInstruction.
341 * @param[in] instruction A description of the rendering operation.
343 void DoRender( RenderInstruction& instruction );
348 * Construct a new RenderManager.
353 RenderManager( const RenderManager& );
356 RenderManager& operator=( const RenderManager& rhs );
365 } // namespace SceneGraph
367 } // namespace Internal
371 #endif // DALI_INTERNAL_SCENE_GRAPH_RENDER_MANAGER_H