1 #ifndef __DALI_INTERNAL_SCENE_GRAPH_RENDER_MANAGER_H__
2 #define __DALI_INTERNAL_SCENE_GRAPH_RENDER_MANAGER_H__
5 * Copyright (c) 2015 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/internal/common/shader-saver.h>
24 #include <dali/internal/update/resources/resource-manager-declarations.h>
25 #include <dali/internal/render/common/texture-uploaded-dispatcher.h>
26 #include <dali/internal/render/gl-resources/gpu-buffer.h>
27 #include <dali/internal/render/renderers/render-property-buffer.h>
28 #include <dali/internal/event/rendering/texture-impl.h>
36 class GlSyncAbstraction;
62 class RenderInstruction;
63 class RenderInstructionContainer;
65 class PropertyBufferDataProvider;
66 class GeometryBatcher;
69 * RenderManager is responsible for rendering the result of the previous "update", which
70 * is provided in a RenderCommand during UpdateManager::Update().
72 class RenderManager : public TextureUploadedDispatcher
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] geometryBatcher The geometry batcher instance
81 * @param[out] resourcePostProcessQueue A queue for sending rendered texture ids to the update-thread.*
83 static RenderManager* New( Integration::GlAbstraction& glAbstraction,
84 Integration::GlSyncAbstraction& glSyncAbstraction,
85 SceneGraph::GeometryBatcher& geometryBatcher,
86 LockedResourceQueue& resourcePostProcessQueue );
89 * Non-virtual destructor; not intended as a base class
94 * Retrieve the RenderQueue. Messages should only be added to this from the update-thread.
95 * @return The render queue.
97 RenderQueue& GetRenderQueue();
100 * Retrieve the texture cache. Messages should only be sent to this from the update thread,
101 * accessor methods should only be used from the render thread.
102 * @return The texture cache
104 TextureCache& GetTextureCache();
107 * @copydoc Dali::Integration::Core::ContextCreated()
109 void ContextCreated();
112 * @copydoc Dali::Integration::Core::ContextToBeDestroyed()
114 void ContextDestroyed();
117 * Dispatch requests onto the postProcessResourcesQueue
118 * @param[in] resource The Id of the resource to dispatch
120 virtual void DispatchTextureUploaded( ResourceId resource );
123 * Set the upstream interface for compiled shader binaries to be sent back to for eventual
124 * caching and saving.
125 * @param[in] upstream The abstract interface to send any received ShaderDatas onwards to..
126 * @note This should be called during core initialisation if shader binaries are to be used.
128 void SetShaderSaver( ShaderSaver& upstream );
131 * Retrieve the render instructions; these should be set during each "update" traversal.
132 * @return The render instruction container.
134 RenderInstructionContainer& GetRenderInstructionContainer();
136 // The following methods should be called via RenderQueue messages
139 * Set the background color i.e. the glClear color used at the beginning of each frame.
140 * @param[in] color The new background color.
142 void SetBackgroundColor( const Vector4& color );
145 * Set the frame time delta (time elapsed since the last frame.
146 * @param[in] deltaTime the delta time
148 void SetFrameDeltaTime( float deltaTime );
151 * Returns the rectangle for the default surface (probably the application window).
152 * @return Rectangle for the surface.
154 void SetDefaultSurfaceRect( const Rect<int>& rect );
157 * Add a Renderer to the render manager.
158 * @param[in] renderer The renderer to add.
159 * @post renderer is owned by RenderManager
161 void AddRenderer( Render::Renderer* renderer );
164 * Remove a Renderer from the render manager.
165 * @param[in] renderer The renderer to remove.
166 * @post renderer is destroyed.
168 void RemoveRenderer( Render::Renderer* renderer );
171 * Add a sampler to the render manager.
172 * @param[in] sampler The sampler to add.
173 * @post sampler is owned by RenderManager
175 void AddSampler( Render::Sampler* sampler );
178 * Remove a sampler from the render manager.
179 * @param[in] sampler The sampler to remove.
180 * @post sampler is destroyed.
182 void RemoveSampler( Render::Sampler* sampler );
185 * Set minification and magnification filter modes for a sampler
186 * @param[in] minFilterMode Filter mode to use when the texture is minificated
187 * @param[in] magFilterMode Filter mode to use when the texture is magnified
189 void SetFilterMode( Render::Sampler* sampler, unsigned int minFilterMode, unsigned int magFilterMode );
192 * Set wrapping mode for a sampler
193 * @param[in] rWrapMode Wrap mode in the z direction
194 * @param[in] uWrapMode Wrap mode in the x direction
195 * @param[in] vWrapMode Wrap mode in the y direction
197 void SetWrapMode( Render::Sampler* sampler, unsigned int rWrapMode, unsigned int sWrapMode, unsigned int tWrapMode );
200 * Add a property buffer to the render manager.
201 * @param[in] propertyBuffer The property buffer to add.
202 * @post propertBuffer is owned by RenderManager
204 void AddPropertyBuffer( Render::PropertyBuffer* propertyBuffer );
207 * Remove a property buffer from the render manager.
208 * @param[in] propertyBuffer The property buffer to remove.
209 * @post propertyBuffer is destroyed.
211 void RemovePropertyBuffer( Render::PropertyBuffer* propertyBuffer );
214 * Add a geometry to the render manager.
215 * @param[in] geometry The geometry to add.
216 * @post geometry is owned by RenderManager
218 void AddGeometry( Render::Geometry* geometry );
221 * Remove a geometry from the render manager.
222 * @param[in] geometry The geometry to remove.
223 * @post geometry is destroyed.
225 void RemoveGeometry( Render::Geometry* geometry );
228 * Adds a property buffer to a geometry from the render manager.
229 * @param[in] geometry The geometry
230 * @param[in] propertyBuffer The property buffer to remove.
232 void AddVertexBuffer( Render::Geometry* geometry, Render::PropertyBuffer* propertyBuffer );
235 * Remove a property buffer from a Render::Geometry from the render manager.
236 * @param[in] geometry The geometry
237 * @param[in] propertyBuffer The property buffer to remove.
238 * @post property buffer is destroyed.
240 void RemoveVertexBuffer( Render::Geometry* geometry, Render::PropertyBuffer* propertyBuffer );
243 * Sets the format of an existing property buffer
244 * @param[in] propertyBuffer The property buffer.
245 * @param[in] format The new format of the buffer
247 void SetPropertyBufferFormat( Render::PropertyBuffer* propertyBuffer, Render::PropertyBuffer::Format* format );
250 * Sets the data of an existing property buffer
251 * @param[in] propertyBuffer The property buffer.
252 * @param[in] data The new data of the buffer
253 * @param[in] size The new size of the buffer
255 void SetPropertyBufferData( Render::PropertyBuffer* propertyBuffer, Dali::Vector<char>* data, size_t size );
258 * Sets the data for the index buffer of an existing geometry
259 * @param[in] geometry The geometry
260 * @param[in] data A vector containing the indices
262 void SetIndexBuffer( Render::Geometry* geometry, Dali::Vector<unsigned short>& data );
265 * Set the geometry type of an existing render geometry
266 * @param[in] geometry The render geometry
267 * @param[in] geometryType The new geometry type
269 void SetGeometryType( Render::Geometry* geometry, unsigned int geometryType );
272 * Adds a texture to the render manager
273 * @param[in] texture The texture to add
275 void AddTexture( Render::NewTexture* texture );
278 * Removes a texture from the render manager
279 * @param[in] texture The texture to remove
281 void RemoveTexture( Render::NewTexture* texture );
284 * Uploads data to an existing texture
285 * @param[in] texture The texture
286 * @param[in] pixelData The pixel data object
287 * @param[in] params The parameters for the upload
289 void UploadTexture( Render::NewTexture* texture, PixelDataPtr pixelData, const NewTexture::UploadParams& params );
292 * Generates mipmaps for a given texture
293 * @param[in] texture The texture
295 void GenerateMipmaps( Render::NewTexture* texture );
298 * Adds a framebuffer to the render manager
299 * @param[in] frameBuffer The framebuffer to add
301 void AddFrameBuffer( Render::FrameBuffer* frameBuffer );
304 * Removes a framebuffer from the render manager
305 * @param[in] frameBuffer The framebuffer to remove
307 void RemoveFrameBuffer( Render::FrameBuffer* frameBuffer );
310 * Attach a texture as color output to an existing FrameBuffer
311 * @param[in] frameBuffer The FrameBuffer
312 * @param[in] texture The texture that will be used as output when rendering
313 * @param[in] mipmapLevel The mipmap of the texture to be attached
314 * @param[in] layer Indicates which layer of a cube map or array texture to attach. Unused for 2D textures
316 void AttachColorTextureToFrameBuffer( Render::FrameBuffer* frameBuffer, Render::NewTexture* texture, unsigned int mipmapLevel, unsigned int layer );
319 * Adds a render tracker to the RenderManager. RenderManager takes ownership of the
320 * tracker. The lifetime of the tracker is related to the lifetime of the tracked
321 * object, usually an offscreen render task.
322 * @param[in] renderTracker The render tracker
324 void AddRenderTracker( Render::RenderTracker* renderTracker );
327 * Removes a render tracker from the RenderManager.
328 * @param[in] renderTracker The render tracker to remove.
330 void RemoveRenderTracker( Render::RenderTracker* renderTracker );
333 * Set the default shader that is to be used in absence of custom shader
334 * @param[in] shader that is the default one
336 void SetDefaultShader( Shader* shader );
339 * returns the Program controller for sending program messages
340 * @return the ProgramController
342 ProgramCache* GetProgramCache();
344 // This method should be called from Core::Render()
347 * Renders the results of the previous "update" traversal.
348 * @param[out] status contains the flag that indicates if render instructions exist
349 * @return true if a further update is required
351 bool Render( Integration::RenderStatus& status );
356 * Helper to process a single RenderInstruction.
357 * @param[in] instruction A description of the rendering operation.
358 * @param[in] defaultShader default shader to use.
360 void DoRender( RenderInstruction& instruction, Shader& defaultShader );
365 * Construct a new RenderManager.
370 RenderManager( const RenderManager& );
373 RenderManager& operator=( const RenderManager& rhs );
382 } // namespace SceneGraph
384 } // namespace Internal
388 #endif // __DALI_INTERNAL_SCENE_GRAPH_RENDER_MANAGER_H__