1 #ifndef DALI_SCENE3D_LOADER_RENDERER_STATE_H
2 #define DALI_SCENE3D_LOADER_RENDERER_STATE_H
4 * Copyright (c) 2022 Samsung Electronics Co., Ltd.
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
21 #include "dali-scene3d/public-api/api.h"
24 #include "dali/public-api/rendering/renderer.h"
33 * @brief Contains values for comparison functions used in depth and stencil testing.
34 * @note Relative order of members must match DepthFunction::Type and StencilFunction::Type.
36 struct DALI_SCENE3D_API Comparison
40 OMIT, // not specified; will not be set.
51 Comparison() = delete;
55 * @brief Determines the blend factor used.
56 * @note Relative order of members must match BlendFactor::Type.
58 struct DALI_SCENE3D_API BlendFactor
62 OMIT, // not specified - will not be updated
64 ONE, // default for source alpha
67 SRC_ALPHA, // default for source RGB
68 ONE_MINUS_SRC_ALPHA, // default for destination RGB and destination alpha
75 ONE_MINUS_CONSTANT_COLOR,
77 ONE_MINUS_CONSTANT_ALPHA,
80 BlendFactor() = delete;
84 * @brief Determines which buffers shall the Renderer write into.
85 * @note Relative order of members must match RenderMode::Type.
87 struct DALI_SCENE3D_API BufferMode
91 OMIT, ///< not specified - will not be updated
92 NONE, ///< Don’t write to either color or stencil buffer (But will potentially render to depth buffer).
93 AUTO, ///< Writes are managed by the Actor Clipping API. This is DALi's default.
94 COLOR, ///< Ignore stencil properties. Write to the color buffer.
95 STENCIL, ///< Use the stencil properties. Do not write to the color buffer.
96 COLOR_STENCIL ///< Use the stencil properties AND Write to the color buffer.
99 BufferMode() = delete;
103 * @brief Contains values and functionality for configuring Renderers.
105 namespace RendererState
107 using Type = uint32_t; // 8 bits reserved for flags, 4 * 4 bit for blend factors, 4 bits for depth function
109 enum DALI_SCENE3D_API Value : Type
121 DEPTH_FUNCTION_SHIFT = 6,
122 DEPTH_FUNCTION_BITS = 4,
123 DEPTH_FUNCTION_MASK = ((1 << DEPTH_FUNCTION_BITS) - 1) << DEPTH_FUNCTION_SHIFT,
125 BLEND_FACTOR_BASE_SHIFT = DEPTH_FUNCTION_SHIFT + DEPTH_FUNCTION_BITS,
126 BLEND_FACTOR_ITEM_BITS = 4,
127 BLEND_FACTOR_ITEMS = 4,
128 BLEND_FACTOR_BITS = BLEND_FACTOR_ITEM_BITS * BLEND_FACTOR_ITEMS,
129 BLEND_FACTOR_MASK = ((1 << BLEND_FACTOR_BITS) - 1) << BLEND_FACTOR_BASE_SHIFT,
130 BLEND_FACTOR_ITEM_MASK = (1 << BLEND_FACTOR_ITEM_BITS) - 1, // after rshifting by BLEND_FACTOR_BASE_SHIFT
132 // Buffer mode is DALi's RenderMode, just to avoid too much conflation.
133 BUFFER_MODE_BITS = 3u,
134 BUFFER_MODE_SHIFT = 32u - BUFFER_MODE_BITS, // from end
135 BUFFER_MODE_MASK = ((1u << BUFFER_MODE_BITS) - 1u) << BUFFER_MODE_SHIFT,
137 DEFAULT = DEPTH_WRITE | DEPTH_TEST | CULL_BACK | (Comparison::LESS_EQUAL << DEPTH_FUNCTION_SHIFT),
141 * @brief Encodes the given blend factors into a RenderMode value, maskable into other options,
142 * passable into ApplyRenderMode().
144 inline DALI_SCENE3D_API constexpr uint32_t FromBlendFactors(BlendFactor::Type srcRgb, BlendFactor::Type destRgb, BlendFactor::Type srcAlpha, BlendFactor::Type destAlpha)
146 return (srcRgb | (destRgb << BLEND_FACTOR_ITEM_BITS) | (srcAlpha << (BLEND_FACTOR_ITEM_BITS * 2)) |
147 (destAlpha << (BLEND_FACTOR_ITEM_BITS * 3)))
148 << BLEND_FACTOR_BASE_SHIFT;
152 * @brief Applies the settings encoded in @a rendererState, to a @a renderer.
153 * @note Depth function is only set if not Comparison::OMIT.
154 * @note Blend factors are only set if not BlendFactor::OMIT.
155 * @note Buffer mode is only set is not BufferMode::OMIT.
157 DALI_SCENE3D_API void Apply(Type rendererState, Renderer& renderer);
159 } // namespace RendererState
161 } // namespace Loader
162 } // namespace Scene3D
165 #endif //DALI_SCENE3D_LOADER_RENDERER_STATE_H