1 #ifndef DALI_INTERNAL_RENDER_RENDERER_H
2 #define DALI_INTERNAL_RENDER_RENDERER_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/public-api/math/matrix.h>
23 #include <dali/public-api/math/vector4.h>
24 #include <dali/public-api/rendering/texture-set.h>
26 #include <dali/graphics-api/graphics-controller.h>
27 #include <dali/integration-api/debug.h>
28 #include <dali/internal/common/blending-options.h>
29 #include <dali/internal/common/message.h>
30 #include <dali/internal/common/type-abstraction-enums.h>
31 #include <dali/internal/event/common/property-input-impl.h>
32 #include <dali/internal/render/data-providers/render-data-provider.h>
33 #include <dali/internal/render/gl-resources/gl-resource-owner.h>
34 #include <dali/internal/render/renderers/render-geometry.h>
35 #include <dali/internal/update/manager/render-instruction-processor.h>
48 class SceneController;
50 class NodeDataProvider;
52 class RenderInstruction; //for relfection effect
53 } // namespace SceneGraph
60 * Renderers are used to render meshes
61 * These objects are used during RenderManager::Render(), so properties modified during
62 * the Update must either be double-buffered, or set via a message added to the RenderQueue.
64 class Renderer : public GlResourceOwner
68 * @brief Struct to encapsulate stencil parameters required for control of the stencil buffer.
70 struct StencilParameters
72 StencilParameters(RenderMode::Type renderMode, StencilFunction::Type stencilFunction, int stencilFunctionMask, int stencilFunctionReference, int stencilMask, StencilOperation::Type stencilOperationOnFail, 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() override;
100 * @copydoc Dali::Internal::GlResourceOwner::GlCleanup()
102 void GlCleanup() override;
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 (To be removed)
173 * @param[in] graphicsController The graphics controller to use
174 * @param[in] programCache Cache of program objects
175 * @param[in] shaderCache Cache of shaders
177 void Initialize(Context& context, Graphics::Controller& graphicsController, ProgramCache& programCache, Render::ShaderCache& shaderCache);
182 ~Renderer() override;
185 * Set the face-culling mode.
186 * @param[in] mode The face-culling mode.
188 void SetFaceCullingMode(FaceCullingMode::Type mode);
191 * Set the bitmask for blending options
192 * @param[in] bitmask A bitmask of blending options.
194 void SetBlendingBitMask(uint32_t bitmask);
197 * Set the blend color for blending options
198 * @param[in] blendColor The blend color to pass to GL
200 void SetBlendColor(const Vector4& color);
203 * Set the first element index to draw by the indexed draw
204 * @param[in] firstElement index of first element to draw
206 void SetIndexedDrawFirstElement(uint32_t firstElement);
209 * Set the number of elements to draw by the indexed draw
210 * @param[in] elementsCount number of elements to draw
212 void SetIndexedDrawElementsCount(uint32_t elementsCount);
215 * @brief Set whether the Pre-multiplied Alpha Blending is required
217 * @param[in] preMultipled whether alpha is pre-multiplied.
219 void EnablePreMultipliedAlpha(bool preMultipled);
222 * Sets the depth write mode
223 * @param[in] depthWriteMode The depth write mode
225 void SetDepthWriteMode(DepthWriteMode::Type depthWriteMode);
228 * Query the Renderer's depth write mode
229 * @return The renderer depth write mode
231 DepthWriteMode::Type GetDepthWriteMode() const;
234 * Sets the depth test mode
235 * @param[in] depthTestMode The depth test mode
237 void SetDepthTestMode(DepthTestMode::Type depthTestMode);
240 * Query the Renderer's depth test mode
241 * @return The renderer depth test mode
243 DepthTestMode::Type GetDepthTestMode() const;
246 * Sets the depth function
247 * @param[in] depthFunction The depth function
249 void SetDepthFunction(DepthFunction::Type depthFunction);
252 * Query the Renderer's depth function
253 * @return The renderer depth function
255 DepthFunction::Type GetDepthFunction() const;
258 * Sets the render mode
259 * @param[in] renderMode The render mode
261 void SetRenderMode(RenderMode::Type mode);
264 * Gets the render mode
265 * @return The render mode
267 RenderMode::Type GetRenderMode() const;
270 * Sets the stencil function
271 * @param[in] stencilFunction The stencil function
273 void SetStencilFunction(StencilFunction::Type stencilFunction);
276 * Gets the stencil function
277 * @return The stencil function
279 StencilFunction::Type GetStencilFunction() const;
282 * Sets the stencil function mask
283 * @param[in] stencilFunctionMask The stencil function mask
285 void SetStencilFunctionMask(int stencilFunctionMask);
288 * Gets the stencil function mask
289 * @return The stencil function mask
291 int GetStencilFunctionMask() const;
294 * Sets the stencil function reference
295 * @param[in] stencilFunctionReference The stencil function reference
297 void SetStencilFunctionReference(int stencilFunctionReference);
300 * Gets the stencil function reference
301 * @return The stencil function reference
303 int GetStencilFunctionReference() const;
306 * Sets the stencil mask
307 * @param[in] stencilMask The stencil mask
309 void SetStencilMask(int stencilMask);
312 * Gets the stencil mask
313 * @return The stencil mask
315 int GetStencilMask() const;
318 * Sets the stencil operation for when the stencil test fails
319 * @param[in] stencilOperationOnFail The stencil operation
321 void SetStencilOperationOnFail(StencilOperation::Type stencilOperationOnFail);
324 * Gets the stencil operation for when the stencil test fails
325 * @return The stencil operation
327 StencilOperation::Type GetStencilOperationOnFail() const;
330 * Sets the stencil operation for when the depth test fails
331 * @param[in] stencilOperationOnZFail The stencil operation
333 void SetStencilOperationOnZFail(StencilOperation::Type stencilOperationOnZFail);
336 * Gets the stencil operation for when the depth test fails
337 * @return The stencil operation
339 StencilOperation::Type GetStencilOperationOnZFail() const;
342 * Sets the stencil operation for when the depth test passes
343 * @param[in] stencilOperationOnZPass The stencil operation
345 void SetStencilOperationOnZPass(StencilOperation::Type stencilOperationOnZPass);
348 * Gets the stencil operation for when the depth test passes
349 * @return The stencil operation
351 StencilOperation::Type GetStencilOperationOnZPass() const;
354 * Called to upload during RenderManager::Render().
359 * Called to render during RenderManager::Render().
360 * @param[in] context The context used for rendering
361 * @param[in] bufferIndex The index of the previous update buffer.
362 * @param[in] node The node using this renderer
363 * @param[in] modelViewMatrix The model-view matrix.
364 * @param[in] viewMatrix The view matrix.
365 * @param[in] projectionMatrix The projection matrix.
366 * @param[in] size Size of the render item
367 * @param[in] blend If true, blending is enabled
368 * @param[in] boundTextures The textures bound for rendering
369 * @param[in] instruction. for use case like reflection where CullFace needs to be adjusted
372 void Render(Context& context,
373 BufferIndex bufferIndex,
374 const SceneGraph::NodeDataProvider& node,
375 const Matrix& modelMatrix,
376 const Matrix& modelViewMatrix,
377 const Matrix& viewMatrix,
378 const Matrix& projectionMatrix,
381 Vector<Graphics::Texture*>& boundTextures,
382 const Dali::Internal::SceneGraph::RenderInstruction& instruction,
383 uint32_t queueIndex);
386 * Write the renderer's sort attributes to the passed in reference
388 * @param[in] bufferIndex The current update buffer index.
389 * @param[out] sortAttributes
391 void SetSortAttributes(BufferIndex bufferIndex, SceneGraph::RenderInstructionProcessor::SortAttributes& sortAttributes) const;
394 * Sets the flag indicating whether shader changed.
396 * @param[in] value True if shader changed
398 void SetShaderChanged(bool value);
401 * Check if the renderer attributes/uniforms are updated and returns the flag
403 * @param[in] bufferIndex The current update buffer index.
404 * @param[in] node The node using this renderer
406 bool Updated(BufferIndex bufferIndex, const SceneGraph::NodeDataProvider* node);
409 struct UniformIndexMap;
412 Renderer(const Renderer&);
415 Renderer& operator=(const Renderer& rhs);
418 * Sets blending options
419 * @param context to use
420 * @param blend Wheter blending should be enabled or not
422 void SetBlending(Context& context, bool blend);
425 * Set the uniforms from properties according to the uniform map
426 * @param[in] bufferIndex The index of the previous update buffer.
427 * @param[in] node The node using the renderer
428 * @param[in] size The size of the renderer
429 * @param[in] program The shader program on which to set the uniforms.
431 void SetUniforms(BufferIndex bufferIndex, const SceneGraph::NodeDataProvider& node, const Vector3& size, Program& program);
434 * Set the program uniform in the map from the mapped property
435 * @param[in] bufferIndex The index of the previous update buffer.
436 * @param[in] program The shader program
437 * @param[in] map The uniform
439 void SetUniformFromProperty(BufferIndex bufferIndex, Program& program, UniformIndexMap& map);
442 * Bind the textures and setup the samplers
443 * @param[in] context The GL context
444 * @param[in] program The shader program
445 * @param[in] boundTextures The textures bound for rendering
446 * @return False if create or bind failed, true if success.
448 bool BindTextures(Program& program, Graphics::CommandBuffer& commandBuffer, Vector<Graphics::Texture*>& boundTextures);
451 * Prepare a pipeline for this renderer
453 Graphics::UniquePtr<Graphics::Pipeline> PrepareGraphicsPipeline(
455 const Dali::Internal::SceneGraph::RenderInstruction& instruction,
457 Graphics::UniquePtr<Graphics::Pipeline>&& oldPipeline);
460 Graphics::Controller* mGraphicsController;
461 OwnerPointer<SceneGraph::RenderDataProvider> mRenderDataProvider;
464 Render::Geometry* mGeometry;
466 ProgramCache* mProgramCache{};
467 Render::ShaderCache* mShaderCache{};
469 Graphics::UniquePtr<Graphics::Program> mGraphicsProgram{}; ///< The graphics program. (Cached implementation)
470 Graphics::UniquePtr<Graphics::Pipeline> mGraphicsPipeline{}; ///< The graphics pipeline. (Cached implementation)
471 std::vector<Graphics::ShaderState> mShaderStates{};
473 struct UniformIndexMap
475 uint32_t uniformIndex; ///< The index of the cached location in the Program
476 const PropertyInputImpl* propertyValue;
479 using UniformIndexMappings = Dali::Vector<UniformIndexMap>;
481 UniformIndexMappings mUniformIndexMap;
482 Vector<int32_t> mAttributeLocations;
484 uint64_t mUniformsHash;
486 StencilParameters mStencilParameters; ///< Struct containing all stencil related options
487 BlendingOptions mBlendingOptions; ///< Blending options including blend color, blend func and blend equation
489 uint32_t mIndexedDrawFirstElement; ///< Offset of first element to draw
490 uint32_t mIndexedDrawElementsCount; ///< Number of elements to draw
492 DepthFunction::Type mDepthFunction : 4; ///< The depth function
493 FaceCullingMode::Type mFaceCullingMode : 3; ///< The mode of face culling
494 DepthWriteMode::Type mDepthWriteMode : 3; ///< The depth write mode
495 DepthTestMode::Type mDepthTestMode : 3; ///< The depth test mode
496 bool mUpdateAttributeLocations : 1; ///< Indicates attribute locations have changed
497 bool mPremultipledAlphaEnabled : 1; ///< Flag indicating whether the Pre-multiplied Alpha Blending is required
498 bool mShaderChanged : 1; ///< Flag indicating the shader changed and uniform maps have to be updated
501 std::vector<Dali::DevelRenderer::DrawCommand> mDrawCommands; // Devel stuff
503 struct LegacyProgram : Graphics::ExtensionCreateInfo
505 uint32_t programId{0};
508 LegacyProgram mLegacyProgram; ///< The structure to pass the program ID into Graphics::PipelineCreateInfo
511 } // namespace Render
513 } // namespace Internal
517 #endif // DALI_INTERNAL_RENDER_RENDERER_H