1 #ifndef DALI_RENDERER_H
2 #define DALI_RENDERER_H
5 * Copyright (c) 2020 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/object/handle.h> // Dali::Handle
23 #include <dali/public-api/object/property-index-ranges.h> // DEFAULT_RENDERER_PROPERTY_START_INDEX
24 #include <dali/public-api/rendering/geometry.h> // Dali::Geometry
25 #include <dali/public-api/rendering/texture-set.h> // Dali::TextureSet
30 * @addtogroup dali_core_rendering_effects
34 namespace Internal DALI_INTERNAL
39 namespace FaceCullingMode
42 * @brief Enumeration for face culling mode.
47 NONE, ///< None of the faces should be culled @SINCE_1_1.43
48 FRONT, ///< Cull front face, front faces should never be shown @SINCE_1_1.43
49 BACK, ///< Cull back face, back faces should never be shown @SINCE_1_1.43
50 FRONT_AND_BACK, ///< Cull front and back faces; if the geometry is composed of triangles none of the faces will be shown @SINCE_1_1.43
53 } // namespace FaceCullingMode
58 * @brief Enumeration for blend mode.
63 OFF, ///< Blending is disabled. @SINCE_1_1.43
64 AUTO, ///< Blending is enabled if there is alpha channel. This is the default mode. @SINCE_1_1.43
65 ON ///< Blending is enabled. @SINCE_1_1.43
68 } // namespace BlendMode
70 namespace BlendEquation
73 * @brief Enumeration for blend equation.
78 ADD = 0x8006, ///< The source and destination colors are added to each other. @SINCE_1_1.43
79 SUBTRACT = 0x800A, ///< Subtracts the destination from the source. @SINCE_1_1.43
80 REVERSE_SUBTRACT = 0x800B ///< Subtracts the source from the destination. @SINCE_1_1.43
83 } // namespace BlendEquation
88 * @brief Enumeration for blend factor.
93 ZERO = 0, ///< ZERO @SINCE_1_1.43
94 ONE = 1, ///< ONE @SINCE_1_1.43
95 SRC_COLOR = 0x0300, ///< SRC_COLOR @SINCE_1_1.43
96 ONE_MINUS_SRC_COLOR = 0x0301, ///< ONE_MINUS_SRC_COLOR @SINCE_1_1.43
97 SRC_ALPHA = 0x0302, ///< SRC_ALPHA @SINCE_1_1.43
98 ONE_MINUS_SRC_ALPHA = 0x0303, ///< ONE_MINUS_SRC_ALPHA @SINCE_1_1.43
99 DST_ALPHA = 0x0304, ///< DST_ALPHA @SINCE_1_1.43
100 ONE_MINUS_DST_ALPHA = 0x0305, ///< ONE_MINUS_DST_ALPHA @SINCE_1_1.43
101 DST_COLOR = 0x0306, ///< DST_COLOR @SINCE_1_1.43
102 ONE_MINUS_DST_COLOR = 0x0307, ///< ONE_MINUS_DST_COLOR @SINCE_1_1.43
103 SRC_ALPHA_SATURATE = 0x0308, ///< SRC_ALPHA_SATURATE @SINCE_1_1.43
104 CONSTANT_COLOR = 0x8001, ///< CONSTANT_COLOR @SINCE_1_1.43
105 ONE_MINUS_CONSTANT_COLOR = 0x8002, ///< ONE_MINUS_CONSTANT_COLOR @SINCE_1_1.43
106 CONSTANT_ALPHA = 0x8003, ///< CONSTANT_ALPHA @SINCE_1_1.43
107 ONE_MINUS_CONSTANT_ALPHA = 0x8004 ///< ONE_MINUS_CONSTANT_ALPHA @SINCE_1_1.43
110 } // namespace BlendFactor
112 namespace DepthWriteMode
115 * @brief Enumeration for depth buffer write modes.
120 OFF, ///< Renderer doesn't write to the depth buffer @SINCE_1_1.43
121 AUTO, ///< Renderer only writes to the depth buffer if it's opaque @SINCE_1_1.43
122 ON ///< Renderer writes to the depth buffer @SINCE_1_1.43
125 } // namespace DepthWriteMode
127 namespace DepthTestMode
130 * @brief Enumeration for depth buffer test (read) modes.
135 OFF, ///< Renderer does not read from the depth buffer @SINCE_1_1.43
136 AUTO, ///< Renderer only reads from the depth buffer if in a 3D layer @SINCE_1_1.43
137 ON ///< Renderer reads from the depth buffer based on the DepthFunction @SINCE_1_1.43
140 } // namespace DepthTestMode
142 namespace DepthFunction
145 * @brief Enumeration for depth functions.
150 NEVER, ///< Depth test never passes @SINCE_1_1.43
151 ALWAYS, ///< Depth test always passes @SINCE_1_1.43
152 LESS, ///< Depth test passes if the incoming depth value is less than the stored depth value @SINCE_1_1.43
153 GREATER, ///< Depth test passes if the incoming depth value is greater than the stored depth value @SINCE_1_1.43
154 EQUAL, ///< Depth test passes if the incoming depth value is equal to the stored depth value @SINCE_1_1.43
155 NOT_EQUAL, ///< Depth test passes if the incoming depth value is not equal to the stored depth value @SINCE_1_1.43
156 LESS_EQUAL, ///< Depth test passes if the incoming depth value is less than or equal to the stored depth value @SINCE_1_1.43
157 GREATER_EQUAL ///< Depth test passes if the incoming depth value is greater than or equal to the stored depth value @SINCE_1_1.43
160 } // namespace DepthFunction
165 * @brief Enumeration for the controls of how this renderer uses its stencil properties and writes to the color buffer.
170 NONE, ///< Do not write to either color or stencil buffer (But will potentially render to depth buffer). @SINCE_1_2_5
171 AUTO, ///< Managed by the Actor Clipping API. This is the default. @SINCE_1_2_5
172 COLOR, ///< Ingore stencil properties. Write to the color buffer. @SINCE_1_2_5
173 STENCIL, ///< Use the stencil properties. Do not write to the color buffer. @SINCE_1_2_5
174 COLOR_STENCIL ///< Use the stencil properties AND Write to the color buffer. @SINCE_1_2_5
177 } // namespace RenderMode
179 namespace StencilFunction
182 * @brief Enumeration for the comparison function used on the stencil buffer.
187 NEVER, ///< Always fails @SINCE_1_1.43
188 LESS, ///< Passes if ( reference & mask ) < ( stencil & mask ) @SINCE_1_1.43
189 EQUAL, ///< Passes if ( reference & mask ) = ( stencil & mask ) @SINCE_1_1.43
190 LESS_EQUAL, ///< Passes if ( reference & mask ) <= ( stencil & mask ) @SINCE_1_1.43
191 GREATER, ///< Passes if ( reference & mask ) > ( stencil & mask ) @SINCE_1_1.43
192 NOT_EQUAL, ///< Passes if ( reference & mask ) != ( stencil & mask ) @SINCE_1_1.43
193 GREATER_EQUAL, ///< Passes if ( reference & mask ) >= ( stencil & mask ) @SINCE_1_1.43
194 ALWAYS, ///< Always passes @SINCE_1_1.43
197 } // namespace StencilFunction
199 namespace StencilOperation
202 * @brief Enumeration for specifying the action to take when the stencil (or depth) test fails during stencil test.
207 ZERO, ///< Sets the stencil buffer value to 0 @SINCE_1_1.43
208 KEEP, ///< Keeps the current value @SINCE_1_1.43
209 REPLACE, ///< Sets the stencil buffer value to ref, as specified by glStencilFunc @SINCE_1_1.43
210 INCREMENT, ///< Increments the current stencil buffer value. Clamps to the maximum representable unsigned value @SINCE_1_1.43
211 DECREMENT, ///< Decrements the current stencil buffer value. Clamps to 0 @SINCE_1_1.43
212 INVERT, ///< Bitwise inverts the current stencil buffer value @SINCE_1_1.43
213 INCREMENT_WRAP, ///< Increments the current stencil buffer value. Wraps stencil buffer value to zero when incrementing the maximum representable unsigned value @SINCE_1_1.43
214 DECREMENT_WRAP ///< Decrements the current stencil buffer value. Wraps stencil buffer value to the maximum representable unsigned value when decrementing a stencil buffer value of zero @SINCE_1_1.43
217 } // namespace StencilOperation
220 * @brief Renderer is a handle to an object used to show content by combining a Geometry, a TextureSet and a shader.
224 class DALI_CORE_API Renderer : public Handle
228 * @brief Enumeration for instances of properties belonging to the Renderer class.
234 * @brief Enumeration for instances of properties belonging to the Renderer class.
240 * @brief Name "depthIndex", type INTEGER.
242 * @note The default value is 0.
244 DEPTH_INDEX = DEFAULT_RENDERER_PROPERTY_START_INDEX,
247 * @brief Name "faceCullingMode", type INTEGER.
249 * @note The default value is FaceCullingMode::NONE.
254 * @brief Name "blendMode", type INTEGER.
256 * @note The default value is BlendMode::AUTO.
261 * @brief Name "blendEquationRgb", type INTEGER.
263 * @note The default value is BlendEquation::ADD.
268 * @brief Name "blendEquationAlpha", type INTEGER.
270 * @note The default value is BlendEquation::ADD.
272 BLEND_EQUATION_ALPHA,
275 * @brief Name "blendFactorSrcRgb", type INTEGER.
277 * @note The default value is BlendFactor::SRC_ALPHA.
279 BLEND_FACTOR_SRC_RGB,
282 * @brief Name "blendFactorDestRgb", type INTEGER.
284 * @note The default value is BlendFactor::ONE_MINUS_SRC_ALPHA.
286 BLEND_FACTOR_DEST_RGB,
289 * @brief Name "blendFactorSrcAlpha", type INTEGER.
291 * @note The default value is BlendFactor::ONE.
293 BLEND_FACTOR_SRC_ALPHA,
296 * @brief Name "blendFactorDestAlpha", type INTEGER.
298 * @note The default value is BlendFactor::ONE_MINUS_SRC_ALPHA.
300 BLEND_FACTOR_DEST_ALPHA,
303 * @brief Name "blendColor", type VECTOR4.
305 * @note The default value is Color::TRANSPARENT.
310 * @brief Name "blendPreMultipledAlpha", type BOOLEAN.
312 * @note The default value is false.
314 BLEND_PRE_MULTIPLIED_ALPHA,
317 * @brief Name "indexRangeFirst", type INTEGER.
319 * @note The default value is 0.
324 * @brief Name "indexRangeCount", type INTEGER.
326 * @note The default (0) means that whole range of indices will be used.
331 * @brief Name "depthWriteMode", type INTEGER.
333 * @see DepthWriteMode
334 * @note The default value is DepthWriteMode::AUTO.
339 * @brief Name "depthFunction", type INTEGER.
342 * @note The default value is DepthFunction::LESS.
347 * @brief Name "depthTestMode", type INTEGER.
350 * @note The default value is DepthTestMode::AUTO.
355 * @brief Name "renderMode", type INTEGER.
358 * @note The default value is RenderMode::AUTO.
363 * @brief Name "stencilFunction", type INTEGER.
365 * @see StencilFunction
366 * @note The default value is StencilFunction::ALWAYS.
371 * @brief Name "stencilFunctionMask", type INTEGER.
373 * @note The default value is 0xFF.
375 STENCIL_FUNCTION_MASK,
378 * @brief Name "stencilFunctionReference", type INTEGER.
380 * @note The default value is 0.
382 STENCIL_FUNCTION_REFERENCE,
385 * @brief Name "stencilMask", type INTEGER.
387 * @note The default value is 0xFF.
392 * @brief Name "stencilOperationOnFail", type INTEGER.
394 * @see StencilOperation
395 * @note The default value is StencilOperation::KEEP
397 STENCIL_OPERATION_ON_FAIL,
400 * @brief Name "stencilOperationOnZFail", type INTEGER.
402 * @see StencilOperation
403 * @note The default value is StencilOperation::KEEP.
405 STENCIL_OPERATION_ON_Z_FAIL,
408 * @brief Name "stencilOperationOnZPass", type INTEGER.
410 * @see StencilOperation
411 * @note The default value is StencilOperation::KEEP.
413 STENCIL_OPERATION_ON_Z_PASS,
418 * @brief Creates a new Renderer object.
421 * @param[in] geometry Geometry to be used by this renderer
422 * @param[in] shader Shader to be used by this renderer
423 * @return A handle to the Renderer
425 static Renderer New(Geometry& geometry, Shader& shader);
428 * @brief Default constructor, creates an empty handle
442 * @brief Copy constructor, creates a new handle to the same object.
445 * @param[in] handle Handle to an object
447 Renderer(const Renderer& handle);
450 * @brief Downcasts to a renderer handle.
451 * If not, a renderer the returned renderer handle is left uninitialized.
454 * @param[in] handle Handle to an object
455 * @return Renderer handle or an uninitialized handle
457 static Renderer DownCast(BaseHandle handle);
460 * @brief Assignment operator, changes this handle to point at the same object.
463 * @param[in] handle Handle to an object
464 * @return Reference to the assigned object
466 Renderer& operator=(const Renderer& handle);
469 * @brief Move constructor.
472 * @param[in] rhs A reference to the moved handle
474 Renderer(Renderer&& rhs);
477 * @brief Move assignment operator.
480 * @param[in] rhs A reference to the moved handle
481 * @return A reference to this handle
483 Renderer& operator=(Renderer&& rhs);
486 * @brief Sets the geometry to be used by this renderer.
489 * @param[in] geometry The geometry to be used by this renderer
491 void SetGeometry(Geometry& geometry);
494 * @brief Gets the geometry used by this renderer.
497 * @return The geometry used by the renderer
499 Geometry GetGeometry() const;
502 * @brief Sets effective range of indices to draw from bound index buffer.
505 * @param[in] firstElement The First element to draw
506 * @param[in] elementsCount The number of elements to draw
508 inline void SetIndexRange(int firstElement, int elementsCount)
510 SetProperty(Property::INDEX_RANGE_FIRST, firstElement);
511 SetProperty(Property::INDEX_RANGE_COUNT, elementsCount);
515 * @brief Sets the texture set to be used by this renderer.
518 * @param[in] textureSet The texture set to be used by this renderer
520 void SetTextures(TextureSet& textureSet);
523 * @brief Gets the texture set used by this renderer.
526 * @return The texture set used by the renderer
528 TextureSet GetTextures() const;
531 * @brief Sets the shader used by this renderer.
534 * @param[in] shader The shader to be used by this renderer
536 void SetShader(Shader& shader);
539 * @brief Gets the shader used by this renderer.
542 * @return The shader used by the renderer
544 Shader GetShader() const;
548 * @brief The constructor.
549 * @note Not intended for application developers.
551 * @param[in] pointer A pointer to a newly allocated Renderer
553 explicit DALI_INTERNAL Renderer(Internal::Renderer* pointer);
561 #endif // DALI_RENDERER_H