dali-scene3d/public-api/loader/material-definition.h

   1 #ifndef DALI_SCENE3D_LOADER_MATERIAL_DEFINITION_H
   2 #define DALI_SCENE3D_LOADER_MATERIAL_DEFINITION_H
   3 /*
   4  * Copyright (c) 2022 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 // INTERNAL INCLUDES
  21 #include "dali-scene3d/public-api/api.h"
  22 #include "dali-scene3d/public-api/loader/environment-definition.h"
  23 #include "dali-scene3d/public-api/loader/index.h"
  24 #include "dali-scene3d/public-api/loader/utils.h"
  25
  26 // EXTERNAL INCLUDES
  27 #include <dali/public-api/images/image-operations.h>
  28 #include <cmath>
  29 #include "dali/public-api/common/vector-wrapper.h"
  30 #include "dali/public-api/math/vector4.h"
  31
  32 namespace Dali
  33 {
  34 namespace Scene3D
  35 {
  36 namespace Loader
  37 {
  38 /**
  39  * @brief Helper enum for encoding and decoding sampler states.
  40  */
  41 struct DALI_SCENE3D_API SamplerFlags
  42 {
  43   using Type = uint8_t;
  44
  45   enum Values : Type
  46   {
  47     // Filter - 3 bits
  48     FILTER_NEAREST        = 0,
  49     FILTER_LINEAR         = NthBit(0),
  50     FILTER_MIPMAP_NEAREST = NthBit(1),
  51     FILTER_MIPMAP_LINEAR  = NthBit(2),
  52
  53     // Wrap - 2 bits
  54     WRAP_REPEAT = 0,
  55     WRAP_CLAMP  = NthBit(0),
  56     WRAP_MIRROR = NthBit(1),
  57
  58     // Layout - apply shift, then mask
  59     FILTER_MIN_BITS = 3,
  60     FILTER_MIN_MASK = NthBit(FILTER_MIN_BITS) - 1,
  61
  62     FILTER_MAG_BITS  = 1,
  63     FILTER_MAG_SHIFT = FILTER_MIN_BITS,
  64     FILTER_MAG_MASK  = NthBit(FILTER_MAG_BITS) - 1,
  65
  66     WRAP_S_BITS  = 2,
  67     WRAP_S_SHIFT = FILTER_MAG_SHIFT + FILTER_MAG_BITS,
  68     WRAP_S_MASK  = NthBit(WRAP_S_BITS) - 1,
  69
  70     WRAP_T_BITS  = 2,
  71     WRAP_T_SHIFT = WRAP_S_SHIFT + WRAP_S_BITS,
  72     WRAP_T_MASK  = NthBit(WRAP_T_BITS) - 1,
  73
  74     // Diagnostics
  75     MIPMAP_MASK = FILTER_MIPMAP_LINEAR | FILTER_MIPMAP_NEAREST,
  76
  77     // Default
  78     DEFAULT = FILTER_LINEAR | (FILTER_LINEAR << FILTER_MAG_SHIFT) | (WRAP_REPEAT << WRAP_S_SHIFT) | (WRAP_REPEAT << WRAP_T_SHIFT), // LINEAR filters, REPEAT wraps
  79   };
  80
  81   /**
  82    * @return SamplerFlags bit pattern calculated from the given Dali Sampler settings.
  83    */
  84   static Type Encode(FilterMode::Type minFilter, FilterMode::Type magFilter, WrapMode::Type wrapS, WrapMode::Type wrapT);
  85
  86   /**
  87    * @brief Decodes the minification filter patter of @a flags into the corresponding FilterMode.
  88    */
  89   static FilterMode::Type GetMinFilter(Type flags);
  90
  91   /**
  92    * @brief Decodes the magnification filter patter of @a flags into the corresponding FilterMode.
  93    */
  94   static FilterMode::Type GetMagFilter(Type flags);
  95
  96   /**
  97    * @brief Decodes the horizontal wrap pattern of @a flags into the corresponding WrapMode.
  98    */
  99   static WrapMode::Type GetWrapS(Type flags);
 100
 101   /**
 102    * @brief Decodes the vertical wrap pattern of @a flags into the corresponding WrapMode.
 103    */
 104   static WrapMode::Type GetWrapT(Type flags);
 105
 106   /**
 107    * @brief Creates a Sampler with the settings encoded in @a flags.
 108    */
 109   static Sampler MakeSampler(Type flags);
 110 };
 111
 112 /**
 113  * @brief Defines a texture from a combination of an image URI and its sampler definition.
 114  */
 115 struct DALI_SCENE3D_API TextureDefinition
 116 {
 117   std::string        mImageUri;
 118   SamplerFlags::Type mSamplerFlags;
 119   ImageDimensions    mMinImageDimensions;
 120   SamplingMode::Type mSamplingMode;
 121
 122   TextureDefinition(const std::string& imageUri = "", SamplerFlags::Type samplerFlags = SamplerFlags::DEFAULT, ImageDimensions minImageDimensions = ImageDimensions(), SamplingMode::Type samplingMode = SamplingMode::BOX_THEN_LINEAR);
 123   TextureDefinition(std::string&& imageUri, SamplerFlags::Type samplerFlags = SamplerFlags::DEFAULT, ImageDimensions minImageDimensions = ImageDimensions(), SamplingMode::Type samplingMode = SamplingMode::BOX_THEN_LINEAR);
 124 };
 125
 126 /**
 127  * @brief Defines a material with a number of texture stages, whether mipmappping
 128  *  is enabled, and an index of an environment (usually of all environments in a
 129  *  scene). Textures from the environment are added last when the DALi TextureSet
 130  *  is being created.
 131  */
 132 struct DALI_SCENE3D_API MaterialDefinition
 133 {
 134   enum Flags : uint32_t
 135   {
 136     // Texture semantics
 137     ALBEDO         = NthBit(0),
 138     METALLIC       = NthBit(1),
 139     ROUGHNESS      = NthBit(2),
 140     NORMAL         = NthBit(3),
 141     EMISSIVE       = NthBit(4),
 142     OCCLUSION      = NthBit(5),
 143     SPECULAR       = NthBit(6),
 144     SPECULAR_COLOR = NthBit(7),
 145     SUBSURFACE     = NthBit(8), // Note: dli-only
 146
 147     // Other binary options
 148     TRANSPARENCY  = NthBit(20),
 149     GLTF_CHANNELS = NthBit(21), // https://github.com/KhronosGroup/glTF/tree/master/specification/2.0#pbrmetallicroughnessmetallicroughnesstexture
 150
 151     // Alpha cutoff - reserved from the 24th bit
 152     ALPHA_CUTOFF_BITS  = 8,
 153     ALPHA_CUTOFF_SHIFT = sizeof(uint32_t) * 8 - ALPHA_CUTOFF_BITS,
 154     ALPHA_CUTOFF_MASK  = (1 << ALPHA_CUTOFF_BITS) - 1,
 155   };
 156
 157   /**
 158    * @brief A(n image based) texture that's used in a material.
 159    */
 160   struct TextureStage
 161   {
 162     uint32_t          mSemantic;
 163     TextureDefinition mTexture;
 164   };
 165
 166   using Vector = std::vector<std::pair<MaterialDefinition, TextureSet>>;
 167
 168   struct RawData
 169   {
 170     struct TextureData
 171     {
 172       PixelData          mPixels;
 173       SamplerFlags::Type mSamplerFlags;
 174     };
 175
 176     std::vector<TextureData> mTextures;
 177   };
 178
 179   MaterialDefinition() = default;
 180
 181   MaterialDefinition(const MaterialDefinition&) = delete;
 182   MaterialDefinition& operator=(const MaterialDefinition&) = delete;
 183
 184   MaterialDefinition(MaterialDefinition&&) = default;
 185   MaterialDefinition& operator=(MaterialDefinition&&) = default;
 186
 187   /**
 188    * @brief Loads (or, in the case of solid color materials, creates) raw pixel data,
 189    *  which is then returned.
 190    * @note This may be called from any thread.
 191    */
 192   RawData LoadRaw(const std::string& imagesPath) const;
 193
 194   /**
 195    * @brief Creates Textures from the pixel data in @a raw, gets the
 196    *  the cube maps from the iEnvironment'th element of @a environments,
 197    *  then creates a DALi TextureSet and returns it.
 198    * @note This must be called from the event thread.
 199    * @note The textures are added in the following order: 2D, cube maps.
 200    */
 201   TextureSet Load(const EnvironmentDefinition::Vector& environments, RawData&& raw) const;
 202
 203   /**
 204    * @brief Checks if the given mask matches any of the textures defined.
 205    */
 206   bool CheckTextures(uint32_t flags) const;
 207
 208   /**
 209    * @return The alpha test reference value.
 210    * @note A value of 0.f means no alpha testing.
 211    */
 212   float GetAlphaCutoff() const
 213   {
 214     return ((mFlags >> ALPHA_CUTOFF_SHIFT) & ALPHA_CUTOFF_MASK) / 255.f;
 215   }
 216
 217   /**
 218    * @brief Encodes the alpha test reference @a value in flags.
 219    * @note A value of 0.f means no alpha testing.
 220    */
 221   void SetAlphaCutoff(float value)
 222   {
 223     DALI_ASSERT_DEBUG(value >= 0.f && value <= 1.f);
 224     mFlags |= static_cast<uint8_t>(std::round(value * 255.f)) << ALPHA_CUTOFF_SHIFT;
 225   }
 226
 227 public: // DATA
 228   uint32_t mFlags = 0x0;
 229
 230   Index   mEnvironmentIdx      = 0;
 231   Vector4 mColor               = Color::WHITE;
 232   float   mMetallic            = 1.f;
 233   float   mRoughness           = 1.f;
 234   Vector4 mBaseColorFactor     = Vector4::ONE;
 235   float   mNormalScale         = 1.f;
 236   float   mOcclusionStrength   = 1.f;
 237   Vector3 mEmissiveFactor      = Vector3::ZERO;
 238   float   mDielectricSpecular  = 0.04f;
 239   float   mSpecularFactor      = 1.0f;
 240   Vector3 mSpecularColorFactor = Vector3::ONE;
 241
 242   // For the glTF, each of albedo, metallicRoughness, normal textures are not essential.
 243   bool mNeedAlbedoTexture            = true;
 244   bool mNeedMetallicRoughnessTexture = true;
 245   bool mNeedNormalTexture            = true;
 246   bool mDoubleSided                  = false;
 247
 248   bool mIsOpaque = true;
 249   bool mIsMask   = false;
 250
 251   std::vector<TextureStage> mTextureStages;
 252 };
 253
 254 } // namespace Loader
 255 } // namespace Scene3D
 256 } // namespace Dali
 257
 258 #endif //DALI_SCENE3D_LOADER_MATERIAL_DEFINITION_H