dali-scene3d/public-api/loader/renderer-state.h

   1 #ifndef DALI_SCENE3D_LOADER_RENDERER_STATE_H
   2 #define DALI_SCENE3D_LOADER_RENDERER_STATE_H
   3 /*
   4  * Copyright (c) 2023 Samsung Electronics Co., Ltd.
   5  *
   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
   9  *
  10  * http://www.apache.org/licenses/LICENSE-2.0
  11  *
  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.
  17  *
  18  */
  19
  20 // EXTERNAL INCLUDES
  21 #include <dali/public-api/rendering/renderer.h>
  22
  23 // INTERAL INCLUDES
  24 #include <dali-scene3d/public-api/api.h>
  25
  26 namespace Dali::Scene3D::Loader
  27 {
  28 /*
  29  * @brief Contains values for comparison functions used in depth and stencil testing.
  30  * @note Relative order of members must match DepthFunction::Type and StencilFunction::Type.
  31  */
  32 struct DALI_SCENE3D_API Comparison
  33 {
  34   enum Type
  35   {
  36     OMIT, // not specified; will not be set.
  37     NEVER,
  38     ALWAYS,
  39     LESS,
  40     GREATER,
  41     EQUAL,
  42     NOT_EQUAL,
  43     LESS_EQUAL,
  44     GREATER_EQUAL
  45   };
  46
  47   Comparison() = delete;
  48 };
  49
  50 /*
  51  * @brief Determines the blend factor used.
  52  * @note Relative order of members must match BlendFactor::Type.
  53  */
  54 struct DALI_SCENE3D_API BlendFactor
  55 {
  56   enum Type
  57   {
  58     OMIT, // not specified - will not be updated
  59     ZERO,
  60     ONE, // default for source alpha
  61     SRC_COLOR,
  62     ONE_MINUS_SRC_COLOR,
  63     SRC_ALPHA,           // default for source RGB
  64     ONE_MINUS_SRC_ALPHA, // default for destination RGB and destination alpha
  65     DST_ALPHA,
  66     ONE_MINUS_DST_ALPHA,
  67     DST_COLOR,
  68     ONE_MINUS_DST_COLOR,
  69     SRC_ALPHA_SATURATE,
  70     CONSTANT_COLOR,
  71     ONE_MINUS_CONSTANT_COLOR,
  72     CONSTANT_ALPHA,
  73     ONE_MINUS_CONSTANT_ALPHA,
  74   };
  75
  76   BlendFactor() = delete;
  77 };
  78
  79 /*
  80  * @brief Determines which buffers shall the Renderer write into.
  81  * @note Relative order of members must match RenderMode::Type.
  82  */
  83 struct DALI_SCENE3D_API BufferMode
  84 {
  85   enum Type
  86   {
  87     OMIT,         ///< not specified - will not be updated
  88     NONE,         ///< Don’t write to either color or stencil buffer (But will potentially render to depth buffer).
  89     AUTO,         ///< Writes are managed by the Actor Clipping API. This is DALi's default.
  90     COLOR,        ///< Ignore stencil properties.  Write to the color buffer.
  91     STENCIL,      ///< Use the stencil properties. Do not write to the color buffer.
  92     COLOR_STENCIL ///< Use the stencil properties AND Write to the color buffer.
  93   };
  94
  95   BufferMode() = delete;
  96 };
  97
  98 /*
  99  * @brief Contains values and functionality for configuring Renderers.
 100  */
 101 namespace RendererState
 102 {
 103 using Type = uint32_t; // 8 bits reserved for flags, 4 * 4 bit for blend factors, 4 bits for depth function
 104
 105 enum DALI_SCENE3D_API Value : Type
 106 {
 107   NONE = 0x0,
 108
 109   DEPTH_WRITE = 0x01,
 110   DEPTH_TEST  = 0x02,
 111
 112   CULL_FRONT = 0x04,
 113   CULL_BACK  = 0x08,
 114
 115   ALPHA_BLEND = 0x10,
 116
 117   DEPTH_FUNCTION_SHIFT = 6,
 118   DEPTH_FUNCTION_BITS  = 4,
 119   DEPTH_FUNCTION_MASK  = ((1 << DEPTH_FUNCTION_BITS) - 1) << DEPTH_FUNCTION_SHIFT,
 120
 121   BLEND_FACTOR_BASE_SHIFT = DEPTH_FUNCTION_SHIFT + DEPTH_FUNCTION_BITS,
 122   BLEND_FACTOR_ITEM_BITS  = 4,
 123   BLEND_FACTOR_ITEMS      = 4,
 124   BLEND_FACTOR_BITS       = BLEND_FACTOR_ITEM_BITS * BLEND_FACTOR_ITEMS,
 125   BLEND_FACTOR_MASK       = ((1 << BLEND_FACTOR_BITS) - 1) << BLEND_FACTOR_BASE_SHIFT,
 126   BLEND_FACTOR_ITEM_MASK  = (1 << BLEND_FACTOR_ITEM_BITS) - 1, // after rshifting by BLEND_FACTOR_BASE_SHIFT
 127
 128   // Buffer mode is DALi's RenderMode, just to avoid too much conflation.
 129   BUFFER_MODE_BITS  = 3u,
 130   BUFFER_MODE_SHIFT = 32u - BUFFER_MODE_BITS, // from end
 131   BUFFER_MODE_MASK  = ((1u << BUFFER_MODE_BITS) - 1u) << BUFFER_MODE_SHIFT,
 132
 133   DEFAULT = DEPTH_WRITE | DEPTH_TEST | CULL_BACK | (Comparison::LESS_EQUAL << DEPTH_FUNCTION_SHIFT),
 134 };
 135
 136 /*
 137  * @brief Encodes the given blend factors into a RenderMode value, maskable into other options,
 138  *  passable into ApplyRenderMode().
 139  */
 140 inline DALI_SCENE3D_API constexpr uint32_t FromBlendFactors(BlendFactor::Type srcRgb, BlendFactor::Type destRgb, BlendFactor::Type srcAlpha, BlendFactor::Type destAlpha)
 141 {
 142   return (srcRgb | (destRgb << BLEND_FACTOR_ITEM_BITS) | (srcAlpha << (BLEND_FACTOR_ITEM_BITS * 2)) |
 143           (destAlpha << (BLEND_FACTOR_ITEM_BITS * 3)))
 144          << BLEND_FACTOR_BASE_SHIFT;
 145 }
 146
 147 /*
 148  * @brief Applies the settings encoded in @a rendererState, to a @a renderer.
 149  * @note Depth function is only set if not Comparison::OMIT.
 150  * @note Blend factors are only set if not BlendFactor::OMIT.
 151  * @note Buffer mode is only set is not BufferMode::OMIT.
 152  */
 153 DALI_SCENE3D_API void Apply(Type rendererState, Renderer& renderer);
 154
 155 } // namespace RendererState
 156
 157 } // namespace Dali::Scene3D::Loader
 158
 159 #endif //DALI_SCENE3D_LOADER_RENDERER_STATE_H