dali-scene3d/public-api/loader/shader-option.h

   1 #ifndef DALI_SCENE3D_LOADER_SHADER_OPTION_H_
   2 #define DALI_SCENE3D_LOADER_SHADER_OPTION_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 INCLUDER
  21 #include <dali/public-api/common/vector-wrapper.h>
  22 #include <memory>
  23 #include <string>
  24 #include <string_view>
  25
  26 // INTERNAL INCLUDES
  27 #include <dali-scene3d/public-api/api.h>
  28
  29 namespace Dali::Scene3D::Loader
  30 {
  31 class DALI_SCENE3D_API ShaderOption
  32 {
  33 public:
  34   enum class Type
  35   {
  36     GLTF_CHANNELS = 0,          // 00001
  37     THREE_TEXTURE,              // 00002
  38     BASE_COLOR_TEXTURE,         // 00004
  39     METALLIC_ROUGHNESS_TEXTURE, // 00008
  40     NORMAL_TEXTURE,             // 00010
  41     OCCLUSION,                  // 00020
  42     EMISSIVE,                   // 00040
  43     ALPHA_TEST,                 // 00080
  44     SUBSURFACE,                 // 00100
  45     SPECULAR,                   // 00200
  46     SPECULAR_COLOR,             // 00400
  47     SKINNING,                   // 00800
  48     FLIP_UVS_VERTICAL,          // 01000
  49     COLOR_ATTRIBUTE,            // 02000
  50     VEC4_TANGENT,               // 04000
  51     MORPH_POSITION,             // 08000
  52     MORPH_NORMAL,               // 10000
  53     MORPH_TANGENT,              // 20000
  54     MORPH_VERSION_2_0           // 40000
  55   };
  56
  57   struct MacroDefinition
  58   {
  59     std::string macro;
  60     std::string definition;
  61   };
  62
  63   ShaderOption() = default;
  64   ShaderOption(const ShaderOption& rhs);
  65   ShaderOption& operator=(const ShaderOption& rhs);
  66
  67   using HashType = uint64_t;
  68
  69 public:
  70   /**
  71    * @brief Sets transparency option.
  72    * @SINCE_2_2.33
  73    */
  74   void SetTransparency();
  75
  76   /**
  77    * @brief Adds new shader definition option.
  78    *
  79    * If the option is already added, nothin is changed.
  80    * @SINCE_2_2.33
  81    * @param[in] shaderOptionType Option to be added,
  82    */
  83   void AddOption(Type shaderOptionType);
  84
  85   /**
  86    * @brief Adds macro definitions for joints based on the number of joint sets.
  87    * @SINCE_2_2.52
  88    */
  89   void AddJointMacros(size_t numberOfJointSets);
  90
  91   /**
  92    * @brief Enables empty preprocessor definitions to be defined to a value.
  93    * @SINCE_2_2.52
  94    */
  95   void AddMacroDefinition(std::string macro, std::string definition);
  96
  97   /**
  98    * @brief Retrieves current shader option hash
  99    *
 100    * @SINCE_2_2.33
 101    * @return Hash value of currently added options.
 102    */
 103   HashType GetOptionHash() const;
 104
 105   /**
 106    * @brief Retrieves a list of define keywords.
 107    *
 108    * @SINCE_2_2.33
 109    * @param[out] defines A list of define keywords those are used in this option.
 110    */
 111   void GetDefines(std::vector<std::string>& defines) const;
 112
 113   /**
 114    * @brief Retrieves a single shader define keyword of input type.
 115    *
 116    * @SINCE_2_2.33
 117    * @param[in] shaderOptionType Shader definition option type to know its keyword.
 118    * @return string keyword of shader define.
 119    */
 120   static std::string_view GetDefineKeyword(Type shaderOptionType);
 121
 122   /**
 123    * @brief Get any macro definitions.
 124    * @SINCE_2_2.52
 125    */
 126   const std::vector<MacroDefinition>& GetMacroDefinitions() const;
 127
 128 private:
 129   HashType mOptionHash{0u};
 130
 131   std::vector<MacroDefinition> mMacros;
 132 };
 133
 134 } // namespace Dali::Scene3D::Loader
 135
 136 #endif // DALI_SCENE3D_LOADER_SHADER_OPTION_H_