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;
36 class GlContextHelperAbstraction;
61 class RenderInstruction;
62 class RenderInstructionContainer;
64 class PropertyBufferDataProvider;
67 * RenderManager is responsible for rendering the result of the previous "update", which
68 * is provided in a RenderCommand during UpdateManager::Update().
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
82 static RenderManager* New( Integration::GlAbstraction& glAbstraction,
83 Integration::GlSyncAbstraction& glSyncAbstraction,
84 Integration::GlContextHelperAbstraction& glContextHelperAbstraction,
85 Integration::DepthBufferAvailable depthBufferAvailable,
86 Integration::StencilBufferAvailable stencilBufferAvailable,
87 Integration::PartialUpdateAvailable partialUpdateAvailable );
90 * Non-virtual destructor; not intended as a base class
95 * Retrieve the RenderQueue. Messages should only be added to this from the update-thread.
96 * @return The render queue.
98 RenderQueue& GetRenderQueue();
101 * @copydoc Dali::Integration::Core::ContextCreated()
103 void ContextCreated();
106 * @copydoc Dali::Integration::Core::ContextToBeDestroyed()
108 void ContextDestroyed();
111 * Set the upstream interface for compiled shader binaries to be sent back to for eventual
112 * caching and saving.
113 * @param[in] upstream The abstract interface to send any received ShaderDatas onwards to..
114 * @note This should be called during core initialisation if shader binaries are to be used.
116 void SetShaderSaver( ShaderSaver& upstream );
119 * Retrieve the render instructions; these should be set during each "update" traversal.
120 * @return The render instruction container.
122 RenderInstructionContainer& GetRenderInstructionContainer();
124 // The following methods should be called via RenderQueue messages
127 * Set the background color i.e. the glClear color used at the beginning of each frame.
128 * @param[in] color The new background color.
130 void SetBackgroundColor( const Vector4& color );
133 * Set the frame time delta (time elapsed since the last frame.
134 * @param[in] deltaTime the delta time
136 void SetFrameDeltaTime( float deltaTime );
139 * Returns the rectangle for the default surface (probably the application window).
140 * @return Rectangle for the surface.
142 void SetDefaultSurfaceRect( const Rect<int>& rect );
145 * Returns the orintation for the default surface (probably the application window).
146 * @return Orientation for the surface.
148 void SetDefaultSurfaceOrientation( int orientation );
151 * Add a Renderer to the render manager.
152 * @param[in] renderer The renderer to add.
153 * @post renderer is owned by RenderManager
155 void AddRenderer( OwnerPointer< Render::Renderer >& renderer );
158 * Remove a Renderer from the render manager.
159 * @param[in] renderer The renderer to remove.
160 * @post renderer is destroyed.
162 void RemoveRenderer( Render::Renderer* renderer );
165 * Add a sampler to the render manager.
166 * @param[in] sampler The sampler to add.
167 * @post sampler is owned by RenderManager
169 void AddSampler( OwnerPointer< Render::Sampler >& sampler );
172 * Remove a sampler from the render manager.
173 * @param[in] sampler The sampler to remove.
174 * @post sampler is destroyed.
176 void RemoveSampler( Render::Sampler* sampler );
179 * Set minification and magnification filter modes for a sampler
180 * @param[in] minFilterMode Filter mode to use when the texture is minificated
181 * @param[in] magFilterMode Filter mode to use when the texture is magnified
183 void SetFilterMode( Render::Sampler* sampler, uint32_t minFilterMode, uint32_t magFilterMode );
186 * Set wrapping mode for a sampler
187 * @param[in] rWrapMode Wrap mode in the z direction
188 * @param[in] uWrapMode Wrap mode in the x direction
189 * @param[in] vWrapMode Wrap mode in the y direction
191 void SetWrapMode( Render::Sampler* sampler, uint32_t rWrapMode, uint32_t sWrapMode, uint32_t tWrapMode );
194 * Add a property buffer to the render manager.
195 * @param[in] propertyBuffer The property buffer to add.
196 * @post propertBuffer is owned by RenderManager
198 void AddPropertyBuffer( OwnerPointer< Render::PropertyBuffer >& propertyBuffer );
201 * Remove a property buffer from the render manager.
202 * @param[in] propertyBuffer The property buffer to remove.
203 * @post propertyBuffer is destroyed.
205 void RemovePropertyBuffer( Render::PropertyBuffer* propertyBuffer );
208 * Add a geometry to the render manager.
209 * @param[in] geometry The geometry to add.
210 * @post geometry is owned by RenderManager
212 void AddGeometry( OwnerPointer< Render::Geometry >& geometry );
215 * Remove a geometry from the render manager.
216 * @param[in] geometry The geometry to remove.
217 * @post geometry is destroyed.
219 void RemoveGeometry( Render::Geometry* geometry );
222 * Adds a property buffer to a geometry from the render manager.
223 * @param[in] geometry The geometry
224 * @param[in] propertyBuffer The property buffer to remove.
226 void AttachVertexBuffer( Render::Geometry* geometry, Render::PropertyBuffer* propertyBuffer );
229 * Remove a property buffer from a Render::Geometry from the render manager.
230 * @param[in] geometry The geometry
231 * @param[in] propertyBuffer The property buffer to remove.
232 * @post property buffer is destroyed.
234 void RemoveVertexBuffer( Render::Geometry* geometry, Render::PropertyBuffer* propertyBuffer );
237 * Sets the format of an existing property buffer
238 * @param[in] propertyBuffer The property buffer.
239 * @param[in] format The new format of the buffer
241 void SetPropertyBufferFormat( Render::PropertyBuffer* propertyBuffer, OwnerPointer< Render::PropertyBuffer::Format>& format );
244 * Sets the data of an existing property buffer
245 * @param[in] propertyBuffer The property buffer.
246 * @param[in] data The new data of the buffer
247 * @param[in] size The new size of the buffer
249 void SetPropertyBufferData( Render::PropertyBuffer* propertyBuffer, OwnerPointer< Vector<uint8_t> >& data, uint32_t size );
252 * Sets the data for the index buffer of an existing geometry
253 * @param[in] geometry The geometry
254 * @param[in] data A vector containing the indices
256 void SetIndexBuffer( Render::Geometry* geometry, Dali::Vector<uint16_t>& data );
259 * Set the geometry type of an existing render geometry
260 * @param[in] geometry The render geometry
261 * @param[in] geometryType The new geometry type
263 void SetGeometryType( Render::Geometry* geometry, uint32_t geometryType );
266 * Adds a texture to the render manager
267 * @param[in] texture The texture to add
269 void AddTexture( OwnerPointer< Render::Texture >& texture );
272 * Removes a texture from the render manager
273 * @param[in] texture The texture to remove
275 void RemoveTexture( Render::Texture* texture );
278 * Uploads data to an existing texture
279 * @param[in] texture The texture
280 * @param[in] pixelData The pixel data object
281 * @param[in] params The parameters for the upload
283 void UploadTexture( Render::Texture* texture, PixelDataPtr pixelData, const Texture::UploadParams& params );
286 * Generates mipmaps for a given texture
287 * @param[in] texture The texture
289 void GenerateMipmaps( Render::Texture* texture );
292 * Adds a framebuffer to the render manager
293 * @param[in] frameBuffer The framebuffer to add
295 void AddFrameBuffer( OwnerPointer< Render::FrameBuffer >& frameBuffer );
298 * Removes a framebuffer from the render manager
299 * @param[in] frameBuffer The framebuffer to remove
301 void RemoveFrameBuffer( Render::FrameBuffer* frameBuffer );
304 * Attach a texture as color output to an existing FrameBuffer
305 * @param[in] frameBuffer The FrameBuffer
306 * @param[in] texture The texture that will be used as output when rendering
307 * @param[in] mipmapLevel The mipmap of the texture to be attached
308 * @param[in] layer Indicates which layer of a cube map or array texture to attach. Unused for 2D textures
310 void AttachColorTextureToFrameBuffer( Render::FrameBuffer* frameBuffer, Render::Texture* texture, uint32_t mipmapLevel, uint32_t layer );
313 * Adds a render tracker to the RenderManager. RenderManager takes ownership of the
314 * tracker. The lifetime of the tracker is related to the lifetime of the tracked
315 * object, usually an offscreen render task.
316 * @param[in] renderTracker The render tracker
318 void AddRenderTracker( Render::RenderTracker* renderTracker );
321 * Removes a render tracker from the RenderManager.
322 * @param[in] renderTracker The render tracker to remove.
324 void RemoveRenderTracker( Render::RenderTracker* renderTracker );
327 * returns the Program controller for sending program messages
328 * @return the ProgramController
330 ProgramCache* GetProgramCache();
332 // This method should be called from Core::Render()
335 * Renders the results of the previous "update" traversal.
336 * @param[out] status contains the rendering flags.
337 * @param[in] forceClear Force the Clear on the framebuffer even if nothing is rendered.
338 * @param[in] uploadOnly Upload the resource only without rendering.
340 void Render( Integration::RenderStatus& status, bool forceClear, bool uploadOnly );
345 * Helper to process a single RenderInstruction.
346 * @param[in] instruction A description of the rendering operation.
348 void DoRender( RenderInstruction& instruction );
353 * Construct a new RenderManager.
358 RenderManager( const RenderManager& );
361 RenderManager& operator=( const RenderManager& rhs );
370 } // namespace SceneGraph
372 } // namespace Internal
376 #endif // DALI_INTERNAL_SCENE_GRAPH_RENDER_MANAGER_H