1 #ifndef DALI_INTERNAL_SCENE_GRAPH_RENDER_MANAGER_H
2 #define DALI_INTERNAL_SCENE_GRAPH_RENDER_MANAGER_H
5 * Copyright (c) 2020 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;
36 class GlContextHelperAbstraction;
62 class RenderInstruction;
63 class RenderInstructionContainer;
65 class PropertyBufferDataProvider;
69 * RenderManager is responsible for rendering the result of the previous "update", which
70 * is provided in a RenderCommand during UpdateManager::Update().
77 * Construct a new RenderManager.
78 * @param[in] glAbstraction The GL abstraction used for rendering.
79 * @param[in] glSyncAbstraction The GL sync abstraction used fence sync creation/deletion.
80 * @param[in] glContextHelperAbstraction The GL context helper abstraction for accessing GL context.
81 * @param[in] depthBufferAvailable Whether the depth buffer is available
82 * @param[in] stencilBufferAvailable Whether the stencil buffer is available
84 static RenderManager* New( Integration::GlAbstraction& glAbstraction,
85 Integration::GlSyncAbstraction& glSyncAbstraction,
86 Integration::GlContextHelperAbstraction& glContextHelperAbstraction,
87 Integration::DepthBufferAvailable depthBufferAvailable,
88 Integration::StencilBufferAvailable stencilBufferAvailable,
89 Integration::PartialUpdateAvailable partialUpdateAvailable );
92 * Non-virtual destructor; not intended as a base class
97 * Retrieve the RenderQueue. Messages should only be added to this from the update-thread.
98 * @return The render queue.
100 RenderQueue& GetRenderQueue();
103 * @copydoc Dali::Integration::Core::ContextCreated()
105 void ContextCreated();
108 * @copydoc Dali::Integration::Core::ContextToBeDestroyed()
110 void ContextDestroyed();
113 * Set the upstream interface for compiled shader binaries to be sent back to for eventual
114 * caching and saving.
115 * @param[in] upstream The abstract interface to send any received ShaderDatas onwards to..
116 * @note This should be called during core initialisation if shader binaries are to be used.
118 void SetShaderSaver( ShaderSaver& upstream );
120 // The following methods should be called via RenderQueue messages
123 * Set the frame time delta (time elapsed since the last frame.
124 * @param[in] deltaTime the delta time
126 void SetFrameDeltaTime( float deltaTime );
129 * Returns the rectangle for the default surface (probably the application window).
130 * @return Rectangle for the surface.
132 void SetDefaultSurfaceRect( const Rect<int>& rect );
135 * Returns the orintation for the default surface (probably the application window).
136 * @return Orientation for the surface.
138 void SetDefaultSurfaceOrientation( int orientation );
141 * Add a Renderer to the render manager.
142 * @param[in] renderer The renderer to add.
143 * @post renderer is owned by RenderManager
145 void AddRenderer( OwnerPointer< Render::Renderer >& renderer );
148 * Remove a Renderer from the render manager.
149 * @param[in] renderer The renderer to remove.
150 * @post renderer is destroyed.
152 void RemoveRenderer( Render::Renderer* renderer );
155 * Add a sampler to the render manager.
156 * @param[in] sampler The sampler to add.
157 * @post sampler is owned by RenderManager
159 void AddSampler( OwnerPointer< Render::Sampler >& sampler );
162 * Remove a sampler from the render manager.
163 * @param[in] sampler The sampler to remove.
164 * @post sampler is destroyed.
166 void RemoveSampler( Render::Sampler* sampler );
169 * Set minification and magnification filter modes for a sampler
170 * @param[in] minFilterMode Filter mode to use when the texture is minificated
171 * @param[in] magFilterMode Filter mode to use when the texture is magnified
173 void SetFilterMode( Render::Sampler* sampler, uint32_t minFilterMode, uint32_t magFilterMode );
176 * Set wrapping mode for a sampler
177 * @param[in] rWrapMode Wrap mode in the z direction
178 * @param[in] uWrapMode Wrap mode in the x direction
179 * @param[in] vWrapMode Wrap mode in the y direction
181 void SetWrapMode( Render::Sampler* sampler, uint32_t rWrapMode, uint32_t sWrapMode, uint32_t tWrapMode );
184 * Add a property buffer to the render manager.
185 * @param[in] propertyBuffer The property buffer to add.
186 * @post propertBuffer is owned by RenderManager
188 void AddPropertyBuffer( OwnerPointer< Render::PropertyBuffer >& propertyBuffer );
191 * Remove a property buffer from the render manager.
192 * @param[in] propertyBuffer The property buffer to remove.
193 * @post propertyBuffer is destroyed.
195 void RemovePropertyBuffer( Render::PropertyBuffer* propertyBuffer );
198 * Add a geometry to the render manager.
199 * @param[in] geometry The geometry to add.
200 * @post geometry is owned by RenderManager
202 void AddGeometry( OwnerPointer< Render::Geometry >& geometry );
205 * Remove a geometry from the render manager.
206 * @param[in] geometry The geometry to remove.
207 * @post geometry is destroyed.
209 void RemoveGeometry( Render::Geometry* geometry );
212 * Adds a property buffer to a geometry from the render manager.
213 * @param[in] geometry The geometry
214 * @param[in] propertyBuffer The property buffer to remove.
216 void AttachVertexBuffer( Render::Geometry* geometry, Render::PropertyBuffer* propertyBuffer );
219 * Remove a property buffer from a Render::Geometry from the render manager.
220 * @param[in] geometry The geometry
221 * @param[in] propertyBuffer The property buffer to remove.
222 * @post property buffer is destroyed.
224 void RemoveVertexBuffer( Render::Geometry* geometry, Render::PropertyBuffer* propertyBuffer );
227 * Sets the format of an existing property buffer
228 * @param[in] propertyBuffer The property buffer.
229 * @param[in] format The new format of the buffer
231 void SetPropertyBufferFormat( Render::PropertyBuffer* propertyBuffer, OwnerPointer< Render::PropertyBuffer::Format>& format );
234 * Sets the data of an existing property buffer
235 * @param[in] propertyBuffer The property buffer.
236 * @param[in] data The new data of the buffer
237 * @param[in] size The new size of the buffer
239 void SetPropertyBufferData( Render::PropertyBuffer* propertyBuffer, OwnerPointer< Vector<uint8_t> >& data, uint32_t size );
242 * Sets the data for the index buffer of an existing geometry
243 * @param[in] geometry The geometry
244 * @param[in] data A vector containing the indices
246 void SetIndexBuffer( Render::Geometry* geometry, Dali::Vector<uint16_t>& data );
249 * Set the geometry type of an existing render geometry
250 * @param[in] geometry The render geometry
251 * @param[in] geometryType The new geometry type
253 void SetGeometryType( Render::Geometry* geometry, uint32_t geometryType );
256 * Adds a texture to the render manager
257 * @param[in] texture The texture to add
259 void AddTexture( OwnerPointer< Render::Texture >& texture );
262 * Removes a texture from the render manager
263 * @param[in] texture The texture to remove
265 void RemoveTexture( Render::Texture* texture );
268 * Uploads data to an existing texture
269 * @param[in] texture The texture
270 * @param[in] pixelData The pixel data object
271 * @param[in] params The parameters for the upload
273 void UploadTexture( Render::Texture* texture, PixelDataPtr pixelData, const Texture::UploadParams& params );
276 * Generates mipmaps for a given texture
277 * @param[in] texture The texture
279 void GenerateMipmaps( Render::Texture* texture );
282 * Adds a framebuffer to the render manager
283 * @param[in] frameBuffer The framebuffer to add
285 void AddFrameBuffer( OwnerPointer< Render::FrameBuffer >& frameBuffer );
288 * Removes a framebuffer from the render manager
289 * @param[in] frameBuffer The framebuffer to remove
291 void RemoveFrameBuffer( Render::FrameBuffer* frameBuffer );
294 * Attaches a texture as color output to the existing frame buffer
295 * @param[in] frameBuffer The FrameBuffer
296 * @param[in] texture The texture that will be used as output when rendering
297 * @param[in] mipmapLevel The mipmap of the texture to be attached
298 * @param[in] layer Indicates which layer of a cube map or array texture to attach. Unused for 2D textures
300 void AttachColorTextureToFrameBuffer( Render::FrameBuffer* frameBuffer, Render::Texture* texture, uint32_t mipmapLevel, uint32_t layer );
303 * Attaches a texture as depth output to the existing frame buffer
304 * @param[in] frameBuffer The FrameBuffer
305 * @param[in] texture The texture that will be used as output when rendering
306 * @param[in] mipmapLevel The mipmap of the texture to be attached
308 void AttachDepthTextureToFrameBuffer( Render::FrameBuffer* frameBuffer, Render::Texture* texture, uint32_t mipmapLevel );
311 * Attaches a texture as depth/stencil output to the existing frame buffer
312 * @param[in] frameBuffer The FrameBuffer
313 * @param[in] texture The texture that will be used as output when rendering
314 * @param[in] mipmapLevel The mipmap of the texture to be attached
316 void AttachDepthStencilTextureToFrameBuffer( Render::FrameBuffer* frameBuffer, Render::Texture* texture, uint32_t mipmapLevel );
319 * Initializes a Scene to the render manager
320 * @param[in] scene The Scene to initialize
322 void InitializeScene( SceneGraph::Scene* scene );
325 * Uninitializes a Scene to the render manager
326 * @param[in] scene The Scene to uninitialize
328 void UninitializeScene( SceneGraph::Scene* scene );
331 * This is called when the surface of the scene has been replaced.
332 * @param[in] scene The scene.
334 void SurfaceReplaced( SceneGraph::Scene* scene );
337 * Adds a render tracker to the RenderManager. RenderManager takes ownership of the
338 * tracker. The lifetime of the tracker is related to the lifetime of the tracked
339 * object, usually an offscreen render task.
340 * @param[in] renderTracker The render tracker
342 void AddRenderTracker( Render::RenderTracker* renderTracker );
345 * Removes a render tracker from the RenderManager.
346 * @param[in] renderTracker The render tracker to remove.
348 void RemoveRenderTracker( Render::RenderTracker* renderTracker );
351 * returns the Program controller for sending program messages
352 * @return the ProgramController
354 ProgramCache* GetProgramCache();
356 // This method should be called from Core::PreRender()
359 * This is called before rendering any scene in the next frame. This method should be preceded
360 * by a call up Update.
361 * Multi-threading note: this method should be called from a dedicated rendering thread.
362 * @pre The GL context must have been created, and made current.
363 * @param[out] status showing whether update is required to run.
364 * @param[in] forceClear force the Clear on the framebuffer even if nothing is rendered.
365 * @param[in] uploadOnly uploadOnly Upload the resource only without rendering.
367 void PreRender( Integration::RenderStatus& status, bool forceClear, bool uploadOnly );
369 // This method should be called from Core::PreRender()
372 * This is called before rendering any scene in the next frame. This method should be preceded
373 * by a call up Update.
374 * Multi-threading note: this method should be called from a dedicated rendering thread.
375 * @pre The GL context must have been created, and made current.
376 * @param[in] scene The scene to be rendered.
377 * @param[out] damagedRects The list of damaged rects for the current render pass.
379 void PreRender( Integration::Scene& scene, std::vector<Rect<int>>& damagedRects );
381 // This method should be called from Core::RenderScene()
384 * Render a scene in the next frame. This method should be preceded by a call up PreRender.
385 * This method should be called twice. The first pass to render off-screen frame buffers if any,
386 * and the second pass to render the surface.
387 * Multi-threading note: this method should be called from a dedicated rendering thread.
388 * @pre The GL context must have been created, and made current.
389 * @param[out] status contains the rendering flags.
390 * @param[in] scene The scene to be rendered.
391 * @param[in] renderToFbo True to render off-screen frame buffers only if any, and False to render the surface only.
393 void RenderScene( Integration::RenderStatus& status, Integration::Scene& scene, bool renderToFbo );
396 * Render a scene in the next frame. This method should be preceded by a call up PreRender.
397 * This method should be called twice. The first pass to render off-screen frame buffers if any,
398 * and the second pass to render the surface.
399 * Multi-threading note: this method should be called from a dedicated rendering thread.
400 * @pre The GL context must have been created, and made current.
401 * @param[out] status contains the rendering flags.
402 * @param[in] scene The scene to be rendered.
403 * @param[in] renderToFbo True to render off-screen frame buffers only if any, and False to render the surface only.
404 * @param[in] clippingRect The clipping rect for the rendered scene.
406 void RenderScene( Integration::RenderStatus& status, Integration::Scene& scene, bool renderToFbo, Rect<int>& clippingRect );
408 // This method should be called from Core::PostRender()
411 * This is called after rendering all the scenes in the next frame. This method should be
412 * followed by a call up RenderScene.
413 * Multi-threading note: this method should be called from a dedicated rendering thread.
414 * @pre The GL context must have been created, and made current.
415 * @param[in] uploadOnly uploadOnly Upload the resource only without rendering.
417 void PostRender( bool uploadOnly );
425 * Construct a new RenderManager.
430 RenderManager( const RenderManager& );
433 RenderManager& operator=( const RenderManager& rhs );
442 } // namespace SceneGraph
444 } // namespace Internal
448 #endif // DALI_INTERNAL_SCENE_GRAPH_RENDER_MANAGER_H