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,
  37     THREE_TEXTURE,
  38     BASE_COLOR_TEXTURE,
  39     METALLIC_ROUGHNESS_TEXTURE,
  40     NORMAL_TEXTURE,
  41     OCCLUSION,
  42     EMISSIVE,
  43     ALPHA_TEST,
  44     SUBSURFACE,
  45     SPECULAR,
  46     SPECULAR_COLOR,
  47     SKINNING,
  48     FLIP_UVS_VERTICAL,
  49     COLOR_ATTRIBUTE,
  50     VEC4_TANGENT,
  51     MORPH_POSITION,
  52     MORPH_NORMAL,
  53     MORPH_TANGENT,
  54     MORPH_VERSION_2_0
  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 public:
  68   /**
  69    * @brief Sets transparency option.
  70    */
  71   void SetTransparency();
  72
  73   /**
  74    * @brief Adds new shader definition option.
  75    * If the option is already added, nothin is changed.
  76    *
  77    * @param[in] shaderOptionType Option to be added,
  78    */
  79   void AddOption(Type shaderOptionType);
  80
  81   /**
  82    * Adds macro definitions for joints based on the number of joint sets.
  83    */
  84   void AddJointMacros(size_t numberOfJointSets);
  85
  86   /**
  87    * Enables empty preprocessor definitions to be defined to a value
  88    */
  89   void AddMacroDefinition(std::string macro, std::string definition);
  90
  91   /**
  92    * @brief Retrieves current shader option hash
  93    *
  94    * @return Hash value of currently added options.
  95    */
  96   uint64_t GetOptionHash() const;
  97
  98   /**
  99    * @brief Retrieves a list of define keywords.
 100    *
 101    * @param[out] defines A list of define keywords those are used in this option.
 102    */
 103   void GetDefines(std::vector<std::string>& defines) const;
 104
 105   /**
 106    * @brief Retrieves a single shader define keyword of input type.
 107    *
 108    * @param[in] shaderOptionType Shader definition option type to know its keyword.
 109    * @return string keyword of shader define.
 110    */
 111   static std::string_view GetDefineKeyword(Type shaderOptionType);
 112
 113   /**
 114    * Get any macro definitions
 115    */
 116   const std::vector<MacroDefinition>& GetMacroDefinitions() const;
 117
 118 private:
 119   uint64_t mOptionHash{0u};
 120
 121   std::vector<MacroDefinition> mMacros;
 122 };
 123
 124 } // namespace Dali::Scene3D::Loader
 125
 126 #endif // DALI_SCENE3D_LOADER_SHADER_OPTION_H_