1 #ifndef DALI_INTERNAL_SCENE_GRAPH_RENDER_MANAGER_H
2 #define DALI_INTERNAL_SCENE_GRAPH_RENDER_MANAGER_H
5 * Copyright (c) 2021 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/graphics-api/graphics-controller.h>
23 #include <dali/integration-api/core-enumerations.h>
24 #include <dali/internal/common/shader-saver.h>
25 #include <dali/internal/event/rendering/texture-impl.h>
26 #include <dali/internal/render/renderers/render-vertex-buffer.h>
27 #include <dali/public-api/math/rect.h>
35 } // namespace Integration
57 class RenderInstruction;
58 class RenderInstructionContainer;
63 * RenderManager is responsible for rendering the result of the previous "update", which
64 * is provided in a RenderCommand during UpdateManager::Update().
70 * Construct a new RenderManager.
71 * @param[in] graphicsController The graphics controller for a given rendering backend
72 * @param[in] depthBufferAvailable Whether the depth buffer is available
73 * @param[in] stencilBufferAvailable Whether the stencil buffer is available
75 static RenderManager* New(Graphics::Controller& graphicsController,
76 Integration::DepthBufferAvailable depthBufferAvailable,
77 Integration::StencilBufferAvailable stencilBufferAvailable,
78 Integration::PartialUpdateAvailable partialUpdateAvailable);
81 * Non-virtual destructor; not intended as a base class
86 * Retrieve the RenderQueue. Messages should only be added to this from the update-thread.
87 * @return The render queue.
89 RenderQueue& GetRenderQueue();
92 * Set the upstream interface for compiled shader binaries to be sent back to for eventual
94 * @param[in] upstream The abstract interface to send any received ShaderDatas onwards to..
95 * @note This should be called during core initialisation if shader binaries are to be used.
97 void SetShaderSaver(ShaderSaver& upstream);
99 // The foltlowing methods should be called via RenderQueue messages
102 * Set the frame time delta (time elapsed since the last frame.
103 * @param[in] deltaTime the delta time
105 void SetFrameDeltaTime(float deltaTime);
108 * Add a Renderer to the render manager.
109 * @param[in] renderer The renderer to add.
110 * @post renderer is owned by RenderManager
112 void AddRenderer(OwnerPointer<Render::Renderer>& renderer);
115 * Remove a Renderer from the render manager.
116 * @param[in] renderer The renderer to remove.
117 * @post renderer is destroyed.
119 void RemoveRenderer(Render::Renderer* renderer);
122 * Add a sampler to the render manager.
123 * @param[in] sampler The sampler to add.
124 * @post sampler is owned by RenderManager
126 void AddSampler(OwnerPointer<Render::Sampler>& sampler);
129 * Remove a sampler from the render manager.
130 * @param[in] sampler The sampler to remove.
131 * @post sampler is destroyed.
133 void RemoveSampler(Render::Sampler* sampler);
136 * Set minification and magnification filter modes for a sampler
137 * @param[in] minFilterMode Filter mode to use when the texture is minificated
138 * @param[in] magFilterMode Filter mode to use when the texture is magnified
140 void SetFilterMode(Render::Sampler* sampler, uint32_t minFilterMode, uint32_t magFilterMode);
143 * Set wrapping mode for a sampler
144 * @param[in] rWrapMode Wrap mode in the z direction
145 * @param[in] uWrapMode Wrap mode in the x direction
146 * @param[in] vWrapMode Wrap mode in the y direction
148 void SetWrapMode(Render::Sampler* sampler, uint32_t rWrapMode, uint32_t sWrapMode, uint32_t tWrapMode);
151 * Add a property buffer to the render manager.
152 * @param[in] vertexBuffer The property buffer to add.
153 * @post propertBuffer is owned by RenderManager
155 void AddVertexBuffer(OwnerPointer<Render::VertexBuffer>& vertexBuffer);
158 * Remove a property buffer from the render manager.
159 * @param[in] vertexBuffer The property buffer to remove.
160 * @post vertexBuffer is destroyed.
162 void RemoveVertexBuffer(Render::VertexBuffer* vertexBuffer);
165 * Add a geometry to the render manager.
166 * @param[in] geometry The geometry to add.
167 * @post geometry is owned by RenderManager
169 void AddGeometry(OwnerPointer<Render::Geometry>& geometry);
172 * Remove a geometry from the render manager.
173 * @param[in] geometry The geometry to remove.
174 * @post geometry is destroyed.
176 void RemoveGeometry(Render::Geometry* geometry);
179 * Adds a property buffer to a geometry from the render manager.
180 * @param[in] geometry The geometry
181 * @param[in] vertexBuffer The property buffer to remove.
183 void AttachVertexBuffer(Render::Geometry* geometry, Render::VertexBuffer* vertexBuffer);
186 * Remove a property buffer from a Render::Geometry from the render manager.
187 * @param[in] geometry The geometry
188 * @param[in] vertexBuffer The property buffer to remove.
189 * @post property buffer is destroyed.
191 void RemoveVertexBuffer(Render::Geometry* geometry, Render::VertexBuffer* vertexBuffer);
194 * Sets the format of an existing property buffer
195 * @param[in] vertexBuffer The property buffer.
196 * @param[in] format The new format of the buffer
198 void SetVertexBufferFormat(Render::VertexBuffer* vertexBuffer, OwnerPointer<Render::VertexBuffer::Format>& format);
201 * Sets the data of an existing property buffer
202 * @param[in] vertexBuffer The property buffer.
203 * @param[in] data The new data of the buffer
204 * @param[in] size The new size of the buffer
206 void SetVertexBufferData(Render::VertexBuffer* vertexBuffer, OwnerPointer<Vector<uint8_t>>& data, uint32_t size);
209 * Sets the data for the index buffer of an existing geometry
210 * @param[in] geometry The geometry
211 * @param[in] data A vector containing the indices
213 void SetIndexBuffer(Render::Geometry* geometry, Dali::Vector<uint16_t>& data);
216 * Set the geometry type of an existing render geometry
217 * @param[in] geometry The render geometry
218 * @param[in] geometryType The new geometry type
220 void SetGeometryType(Render::Geometry* geometry, uint32_t geometryType);
223 * Adds a texture to the render manager
224 * @param[in] texture The texture to add
226 void AddTexture(OwnerPointer<Render::Texture>& texture);
229 * Removes a texture from the render manager
230 * @param[in] texture The texture to remove
232 void RemoveTexture(Render::Texture* texture);
235 * Uploads data to an existing texture
236 * @param[in] texture The texture
237 * @param[in] pixelData The pixel data object
238 * @param[in] params The parameters for the upload
240 void UploadTexture(Render::Texture* texture, PixelDataPtr pixelData, const Texture::UploadParams& params);
243 * Generates mipmaps for a given texture
244 * @param[in] texture The texture
246 void GenerateMipmaps(Render::Texture* texture);
249 * Adds a framebuffer to the render manager
250 * @param[in] frameBuffer The framebuffer to add
252 void AddFrameBuffer(OwnerPointer<Render::FrameBuffer>& frameBuffer);
255 * Removes a framebuffer from the render manager
256 * @param[in] frameBuffer The framebuffer to remove
258 void RemoveFrameBuffer(Render::FrameBuffer* frameBuffer);
261 * Attaches a texture as color output to the existing frame buffer
262 * @param[in] frameBuffer The FrameBuffer
263 * @param[in] texture The texture that will be used as output when rendering
264 * @param[in] mipmapLevel The mipmap of the texture to be attached
265 * @param[in] layer Indicates which layer of a cube map or array texture to attach. Unused for 2D textures
267 void AttachColorTextureToFrameBuffer(Render::FrameBuffer* frameBuffer, Render::Texture* texture, uint32_t mipmapLevel, uint32_t layer);
270 * Attaches a texture as depth output to the existing frame buffer
271 * @param[in] frameBuffer The FrameBuffer
272 * @param[in] texture The texture that will be used as output when rendering
273 * @param[in] mipmapLevel The mipmap of the texture to be attached
275 void AttachDepthTextureToFrameBuffer(Render::FrameBuffer* frameBuffer, Render::Texture* texture, uint32_t mipmapLevel);
278 * Attaches a texture as depth/stencil output to the existing frame buffer
279 * @param[in] frameBuffer The FrameBuffer
280 * @param[in] texture The texture that will be used as output when rendering
281 * @param[in] mipmapLevel The mipmap of the texture to be attached
283 void AttachDepthStencilTextureToFrameBuffer(Render::FrameBuffer* frameBuffer, Render::Texture* texture, uint32_t mipmapLevel);
286 * Initializes a Scene to the render manager
287 * @param[in] scene The Scene to initialize
289 void InitializeScene(SceneGraph::Scene* scene);
292 * Uninitializes a Scene to the render manager
293 * @param[in] scene The Scene to uninitialize
295 void UninitializeScene(SceneGraph::Scene* scene);
298 * This is called when the surface of the scene has been replaced.
299 * @param[in] scene The scene.
301 void SurfaceReplaced(SceneGraph::Scene* scene);
304 * Adds a render tracker to the RenderManager. RenderManager takes ownership of the
305 * tracker. The lifetime of the tracker is related to the lifetime of the tracked
306 * object, usually an offscreen render task.
307 * @param[in] renderTracker The render tracker
309 void AddRenderTracker(Render::RenderTracker* renderTracker);
312 * Removes a render tracker from the RenderManager.
313 * @param[in] renderTracker The render tracker to remove.
315 void RemoveRenderTracker(Render::RenderTracker* renderTracker);
317 // This method should be called from Core::PreRender()
320 * This is called before rendering any scene in the next frame. This method should be preceded
321 * by a call up Update.
322 * Multi-threading note: this method should be called from a dedicated rendering thread.
323 * @pre The graphics implementation must be initialized
324 * @param[out] status showing whether update is required to run.
325 * @param[in] forceClear force the Clear on the framebuffer even if nothing is rendered.
326 * @param[in] uploadOnly uploadOnly Upload the resource only without rendering.
328 void PreRender(Integration::RenderStatus& status, bool forceClear, bool uploadOnly);
330 // This method should be called from Core::PreRender()
333 * This is called before rendering any scene in the next frame. This method should be preceded
334 * by a call up Update.
335 * Multi-threading note: this method should be called from a dedicated rendering thread.
336 * @pre The graphics implementation must be initialized
337 * @param[in] scene The scene to be rendered.
338 * @param[out] damagedRects The list of damaged rects for the current render pass.
340 void PreRender(Integration::RenderStatus& status, Integration::Scene& scene, std::vector<Rect<int>>& damagedRects);
342 // This method should be called from Core::RenderScene()
345 * Render a scene in the next frame. This method should be preceded by a call up PreRender.
346 * This method should be called twice. The first pass to render off-screen frame buffers if any,
347 * and the second pass to render the surface.
348 * Multi-threading note: this method should be called from a dedicated rendering thread.
349 * @pre The graphics implementation must be initialized
350 * @param[out] status contains the rendering flags.
351 * @param[in] scene The scene to be rendered.
352 * @param[in] renderToFbo True to render off-screen frame buffers only if any, and False to render the surface only.
354 void RenderScene(Integration::RenderStatus& status, Integration::Scene& scene, bool renderToFbo);
357 * Render a scene in the next frame. This method should be preceded by a call up PreRender.
358 * This method should be called twice. The first pass to render off-screen frame buffers if any,
359 * and the second pass to render the surface.
360 * Multi-threading note: this method should be called from a dedicated rendering thread.
361 * @pre The graphics implementation must be initialized
362 * @param[out] status contains the rendering flags.
363 * @param[in] scene The scene to be rendered.
364 * @param[in] renderToFbo True to render off-screen frame buffers only if any, and False to render the surface only.
365 * @param[in] clippingRect The clipping rect for the rendered scene.
367 void RenderScene(Integration::RenderStatus& status, Integration::Scene& scene, bool renderToFbo, Rect<int>& clippingRect);
369 // This method should be called from Core::PostRender()
372 * This is called after rendering all the scenes in the next frame. This method should be
373 * followed by a call up RenderScene.
374 * Multi-threading note: this method should be called from a dedicated rendering thread.
375 * @pre The graphics implementation must be initialized
376 * @param[in] uploadOnly uploadOnly Upload the resource only without rendering.
378 void PostRender(bool uploadOnly);
382 * Construct a new RenderManager.
387 RenderManager(const RenderManager&);
390 RenderManager& operator=(const RenderManager& rhs);
397 } // namespace SceneGraph
399 } // namespace Internal
403 #endif // DALI_INTERNAL_SCENE_GRAPH_RENDER_MANAGER_H