1 #ifndef DALI_INTERNAL_RENDER_RENDERER_H
2 #define DALI_INTERNAL_RENDER_RENDERER_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/matrix.h>
23 #include <dali/public-api/math/vector4.h>
24 #include <dali/public-api/rendering/texture-set.h>
25 #include <dali/internal/common/blending-options.h>
26 #include <dali/internal/common/message.h>
27 #include <dali/internal/common/type-abstraction-enums.h>
28 #include <dali/internal/event/common/property-input-impl.h>
29 #include <dali/internal/render/data-providers/render-data-provider.h>
30 #include <dali/internal/render/gl-resources/gl-resource-owner.h>
31 #include <dali/internal/render/renderers/render-geometry.h>
32 #include <dali/internal/update/manager/render-instruction-processor.h>
33 #include <dali/integration-api/debug.h>
46 class SceneController;
48 class NodeDataProvider;
50 class RenderInstruction; //for relfection effect
57 * Renderers are used to render meshes
58 * These objects are used during RenderManager::Render(), so properties modified during
59 * the Update must either be double-buffered, or set via a message added to the RenderQueue.
61 class Renderer : public GlResourceOwner
66 * @brief Struct to encapsulate stencil parameters required for control of the stencil buffer.
68 struct StencilParameters
70 StencilParameters( RenderMode::Type renderMode, StencilFunction::Type stencilFunction, int stencilFunctionMask,
71 int stencilFunctionReference, int stencilMask, StencilOperation::Type stencilOperationOnFail,
72 StencilOperation::Type stencilOperationOnZFail, StencilOperation::Type stencilOperationOnZPass )
73 : stencilFunctionMask ( stencilFunctionMask ),
74 stencilFunctionReference ( stencilFunctionReference ),
75 stencilMask ( stencilMask ),
76 renderMode ( renderMode ),
77 stencilFunction ( stencilFunction ),
78 stencilOperationOnFail ( stencilOperationOnFail ),
79 stencilOperationOnZFail ( stencilOperationOnZFail ),
80 stencilOperationOnZPass ( stencilOperationOnZPass )
84 int stencilFunctionMask; ///< The stencil function mask
85 int stencilFunctionReference; ///< The stencil function reference
86 int stencilMask; ///< The stencil mask
87 RenderMode::Type renderMode:4; ///< The render mode
88 StencilFunction::Type stencilFunction:4; ///< The stencil function
89 StencilOperation::Type stencilOperationOnFail:4; ///< The stencil operation for stencil test fail
90 StencilOperation::Type stencilOperationOnZFail:4; ///< The stencil operation for depth test fail
91 StencilOperation::Type stencilOperationOnZPass:4; ///< The stencil operation for depth test pass
95 * @copydoc Dali::Internal::GlResourceOwner::GlContextDestroyed()
97 void GlContextDestroyed();
100 * @copydoc Dali::Internal::GlResourceOwner::GlCleanup()
105 * Create a new renderer instance
106 * @param[in] dataProviders The data providers for the renderer
107 * @param[in] geometry The geometry for the renderer
108 * @param[in] blendingBitmask A bitmask of blending options.
109 * @param[in] blendColor The blend color to pass to GL
110 * @param[in] faceCullingMode The face-culling mode.
111 * @param[in] preMultipliedAlphaEnabled whether alpha is pre-multiplied.
112 * @param[in] depthWriteMode Depth buffer write mode
113 * @param[in] depthTestMode Depth buffer test mode
114 * @param[in] depthFunction Depth function
115 * @param[in] stencilParameters Struct containing all stencil related options
117 static Renderer* New( SceneGraph::RenderDataProvider* dataProviders,
118 Render::Geometry* geometry,
119 uint32_t blendingBitmask,
120 const Vector4& blendColor,
121 FaceCullingMode::Type faceCullingMode,
122 bool preMultipliedAlphaEnabled,
123 DepthWriteMode::Type depthWriteMode,
124 DepthTestMode::Type depthTestMode,
125 DepthFunction::Type depthFunction,
126 StencilParameters& stencilParameters );
130 * @param[in] dataProviders The data providers for the renderer
131 * @param[in] geometry The geometry for the renderer
132 * @param[in] blendingBitmask A bitmask of blending options.
133 * @param[in] blendColor The blend color to pass to GL
134 * @param[in] faceCullingMode The face-culling mode.
135 * @param[in] preMultipliedAlphaEnabled whether alpha is pre-multiplied.
136 * @param[in] depthWriteMode Depth buffer write mode
137 * @param[in] depthTestMode Depth buffer test mode
138 * @param[in] depthFunction Depth function
139 * @param[in] stencilParameters Struct containing all stencil related options
141 Renderer( SceneGraph::RenderDataProvider* dataProviders,
142 Render::Geometry* geometry,
143 uint32_t blendingBitmask,
144 const Vector4& blendColor,
145 FaceCullingMode::Type faceCullingMode,
146 bool preMultipliedAlphaEnabled,
147 DepthWriteMode::Type depthWriteMode,
148 DepthTestMode::Type depthTestMode,
149 DepthFunction::Type depthFunction,
150 StencilParameters& stencilParameters );
153 * Change the geometry used by the renderer
154 * @param[in] geometry The new geometry
156 void SetGeometry( Render::Geometry* geometry );
158 void SetDrawCommands( Dali::DevelRenderer::DrawCommand* pDrawCommands, uint32_t size );
161 * @brief Returns a reference to an array of draw commands
162 * @return Valid array of draw commands (may be empty)
164 const std::vector<Dali::DevelRenderer::DrawCommand>& GetDrawCommands() const
166 return mDrawCommands;
170 * Second-phase construction.
171 * This is called when the renderer is inside render thread
172 * @param[in] context Context used by the renderer
174 void Initialize( Context& context );
182 * Set the face-culling mode.
183 * @param[in] mode The face-culling mode.
185 void SetFaceCullingMode( FaceCullingMode::Type mode );
188 * Set the bitmask for blending options
189 * @param[in] bitmask A bitmask of blending options.
191 void SetBlendingBitMask( uint32_t bitmask );
194 * Set the blend color for blending options
195 * @param[in] blendColor The blend color to pass to GL
197 void SetBlendColor( const Vector4& color );
200 * Set the first element index to draw by the indexed draw
201 * @param[in] firstElement index of first element to draw
203 void SetIndexedDrawFirstElement( uint32_t firstElement );
206 * Set the number of elements to draw by the indexed draw
207 * @param[in] elementsCount number of elements to draw
209 void SetIndexedDrawElementsCount( uint32_t elementsCount );
212 * @brief Set whether the Pre-multiplied Alpha Blending is required
214 * @param[in] preMultipled whether alpha is pre-multiplied.
216 void EnablePreMultipliedAlpha( bool preMultipled );
219 * Sets the depth write mode
220 * @param[in] depthWriteMode The depth write mode
222 void SetDepthWriteMode( DepthWriteMode::Type depthWriteMode );
225 * Query the Renderer's depth write mode
226 * @return The renderer depth write mode
228 DepthWriteMode::Type GetDepthWriteMode() const;
231 * Sets the depth test mode
232 * @param[in] depthTestMode The depth test mode
234 void SetDepthTestMode( DepthTestMode::Type depthTestMode );
237 * Query the Renderer's depth test mode
238 * @return The renderer depth test mode
240 DepthTestMode::Type GetDepthTestMode() const;
243 * Sets the depth function
244 * @param[in] depthFunction The depth function
246 void SetDepthFunction( DepthFunction::Type depthFunction );
249 * Query the Renderer's depth function
250 * @return The renderer depth function
252 DepthFunction::Type GetDepthFunction() const;
255 * Sets the render mode
256 * @param[in] renderMode The render mode
258 void SetRenderMode( RenderMode::Type mode );
261 * Gets the render mode
262 * @return The render mode
264 RenderMode::Type GetRenderMode() const;
267 * Sets the stencil function
268 * @param[in] stencilFunction The stencil function
270 void SetStencilFunction( StencilFunction::Type stencilFunction );
273 * Gets the stencil function
274 * @return The stencil function
276 StencilFunction::Type GetStencilFunction() const;
279 * Sets the stencil function mask
280 * @param[in] stencilFunctionMask The stencil function mask
282 void SetStencilFunctionMask( int stencilFunctionMask );
285 * Gets the stencil function mask
286 * @return The stencil function mask
288 int GetStencilFunctionMask() const;
291 * Sets the stencil function reference
292 * @param[in] stencilFunctionReference The stencil function reference
294 void SetStencilFunctionReference( int stencilFunctionReference );
297 * Gets the stencil function reference
298 * @return The stencil function reference
300 int GetStencilFunctionReference() const;
303 * Sets the stencil mask
304 * @param[in] stencilMask The stencil mask
306 void SetStencilMask( int stencilMask );
309 * Gets the stencil mask
310 * @return The stencil mask
312 int GetStencilMask() const;
315 * Sets the stencil operation for when the stencil test fails
316 * @param[in] stencilOperationOnFail The stencil operation
318 void SetStencilOperationOnFail( StencilOperation::Type stencilOperationOnFail );
321 * Gets the stencil operation for when the stencil test fails
322 * @return The stencil operation
324 StencilOperation::Type GetStencilOperationOnFail() const;
327 * Sets the stencil operation for when the depth test fails
328 * @param[in] stencilOperationOnZFail The stencil operation
330 void SetStencilOperationOnZFail( StencilOperation::Type stencilOperationOnZFail );
333 * Gets the stencil operation for when the depth test fails
334 * @return The stencil operation
336 StencilOperation::Type GetStencilOperationOnZFail() const;
339 * Sets the stencil operation for when the depth test passes
340 * @param[in] stencilOperationOnZPass The stencil operation
342 void SetStencilOperationOnZPass( StencilOperation::Type stencilOperationOnZPass );
345 * Gets the stencil operation for when the depth test passes
346 * @return The stencil operation
348 StencilOperation::Type GetStencilOperationOnZPass() const;
351 * Called to upload during RenderManager::Render().
352 * @param[in] context The context used for uploading
354 void Upload( Context& context );
357 * Called to render during RenderManager::Render().
358 * @param[in] context The context used for rendering
359 * @param[in] bufferIndex The index of the previous update buffer.
360 * @param[in] node The node using this renderer
361 * @param[in] modelViewMatrix The model-view matrix.
362 * @param[in] viewMatrix The view matrix.
363 * @param[in] projectionMatrix The projection matrix.
364 * @param[in] size Size of the render item
365 * @param[in] blend If true, blending is enabled
366 * @param[in] boundTextures The textures bound for rendering
367 * @param[in] instruction. for use case like reflection where CullFace needs to be adjusted
370 void Render( Context& context,
371 BufferIndex bufferIndex,
372 const SceneGraph::NodeDataProvider& node,
373 const Matrix& modelMatrix,
374 const Matrix& modelViewMatrix,
375 const Matrix& viewMatrix,
376 const Matrix& projectionMatrix,
379 Vector<GLuint>& boundTextures,
380 const Dali::Internal::SceneGraph::RenderInstruction& instruction,
381 uint32_t queueIndex );
384 * Write the renderer's sort attributes to the passed in reference
386 * @param[in] bufferIndex The current update buffer index.
387 * @param[out] sortAttributes
389 void SetSortAttributes( BufferIndex bufferIndex, SceneGraph::RenderInstructionProcessor::SortAttributes& sortAttributes ) const;
392 * Sets the flag indicating whether shader changed.
394 * @param[in] value True if shader changed
396 void SetShaderChanged( bool value );
399 * Check if the renderer attributes/uniforms are updated and returns the flag
401 * @param[in] bufferIndex The current update buffer index.
402 * @param[in] node The node using this renderer
404 bool Updated(BufferIndex bufferIndex, const SceneGraph::NodeDataProvider* node);
408 struct UniformIndexMap;
411 Renderer( const Renderer& );
414 Renderer& operator=( const Renderer& rhs );
417 * Sets blending options
418 * @param context to use
419 * @param blend Wheter blending should be enabled or not
421 void SetBlending( Context& context, bool blend );
424 * Set the uniforms from properties according to the uniform map
425 * @param[in] bufferIndex The index of the previous update buffer.
426 * @param[in] node The node using the renderer
427 * @param[in] size The size of the renderer
428 * @param[in] program The shader program on which to set the uniforms.
430 void SetUniforms( BufferIndex bufferIndex, const SceneGraph::NodeDataProvider& node, const Vector3& size, Program& program );
433 * Set the program uniform in the map from the mapped property
434 * @param[in] bufferIndex The index of the previous update buffer.
435 * @param[in] program The shader program
436 * @param[in] map The uniform
438 void SetUniformFromProperty( BufferIndex bufferIndex, Program& program, UniformIndexMap& map );
441 * Bind the textures and setup the samplers
442 * @param[in] context The GL context
443 * @param[in] program The shader program
444 * @param[in] boundTextures The textures bound for rendering
445 * @return False if create or bind failed, true if success.
447 bool BindTextures( Context& context, Program& program, Vector<GLuint>& boundTextures );
451 OwnerPointer< SceneGraph::RenderDataProvider > mRenderDataProvider;
454 Render::Geometry* mGeometry;
456 struct UniformIndexMap
458 uint32_t uniformIndex; ///< The index of the cached location in the Program
459 const PropertyInputImpl* propertyValue;
462 typedef Dali::Vector< UniformIndexMap > UniformIndexMappings;
464 UniformIndexMappings mUniformIndexMap;
465 Vector<GLint> mAttributesLocation;
467 uint64_t mUniformsHash;
469 StencilParameters mStencilParameters; ///< Struct containing all stencil related options
470 BlendingOptions mBlendingOptions; ///< Blending options including blend color, blend func and blend equation
472 uint32_t mIndexedDrawFirstElement; ///< Offset of first element to draw
473 uint32_t mIndexedDrawElementsCount; ///< Number of elements to draw
475 DepthFunction::Type mDepthFunction:4; ///< The depth function
476 FaceCullingMode::Type mFaceCullingMode:3; ///< The mode of face culling
477 DepthWriteMode::Type mDepthWriteMode:3; ///< The depth write mode
478 DepthTestMode::Type mDepthTestMode:3; ///< The depth test mode
479 bool mUpdateAttributesLocation:1; ///< Indicates attribute locations have changed
480 bool mPremultipledAlphaEnabled:1; ///< Flag indicating whether the Pre-multiplied Alpha Blending is required
481 bool mShaderChanged:1; ///< Flag indicating the shader changed and uniform maps have to be updated
485 std::vector<Dali::DevelRenderer::DrawCommand> mDrawCommands; // Devel stuff
488 } // namespace SceneGraph
490 } // namespace Internal
494 #endif // DALI_INTERNAL_RENDER_RENDERER_H