1 #ifndef DALI_SCENE3D_LOADER_MATERIAL_DEFINITION_H
2 #define DALI_SCENE3D_LOADER_MATERIAL_DEFINITION_H
4 * Copyright (c) 2023 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/public-api/common/vector-wrapper.h>
22 #include <dali/public-api/images/image-operations.h>
23 #include <dali/public-api/math/vector4.h>
27 #include <dali-scene3d/public-api/api.h>
28 #include <dali-scene3d/public-api/loader/environment-definition.h>
29 #include <dali-scene3d/public-api/loader/index.h>
30 #include <dali-scene3d/public-api/loader/utils.h>
31 #include <dali-scene3d/public-api/model-components/material.h>
33 namespace Dali::Scene3D::Loader
36 * @brief Helper enum for encoding and decoding sampler states.
38 struct DALI_SCENE3D_API SamplerFlags
46 FILTER_LINEAR = NthBit(0),
47 FILTER_MIPMAP_NEAREST = NthBit(1),
48 FILTER_MIPMAP_LINEAR = NthBit(2),
52 WRAP_CLAMP = NthBit(0),
53 WRAP_MIRROR = NthBit(1),
55 // Layout - apply shift, then mask
57 FILTER_MIN_MASK = NthBit(FILTER_MIN_BITS) - 1,
60 FILTER_MAG_SHIFT = FILTER_MIN_BITS,
61 FILTER_MAG_MASK = NthBit(FILTER_MAG_BITS) - 1,
64 WRAP_S_SHIFT = FILTER_MAG_SHIFT + FILTER_MAG_BITS,
65 WRAP_S_MASK = NthBit(WRAP_S_BITS) - 1,
68 WRAP_T_SHIFT = WRAP_S_SHIFT + WRAP_S_BITS,
69 WRAP_T_MASK = NthBit(WRAP_T_BITS) - 1,
72 MIPMAP_MASK = FILTER_MIPMAP_LINEAR | FILTER_MIPMAP_NEAREST,
75 DEFAULT = FILTER_LINEAR | (FILTER_LINEAR << FILTER_MAG_SHIFT) | (WRAP_REPEAT << WRAP_S_SHIFT) | (WRAP_REPEAT << WRAP_T_SHIFT), // LINEAR filters, REPEAT wraps
79 * @return SamplerFlags bit pattern calculated from the given Dali Sampler settings.
81 static Type Encode(FilterMode::Type minFilter, FilterMode::Type magFilter, WrapMode::Type wrapS, WrapMode::Type wrapT);
84 * @brief Decodes the minification filter patter of @a flags into the corresponding FilterMode.
86 static FilterMode::Type GetMinFilter(Type flags);
89 * @brief Decodes the magnification filter patter of @a flags into the corresponding FilterMode.
91 static FilterMode::Type GetMagFilter(Type flags);
94 * @brief Decodes the horizontal wrap pattern of @a flags into the corresponding WrapMode.
96 static WrapMode::Type GetWrapS(Type flags);
99 * @brief Decodes the vertical wrap pattern of @a flags into the corresponding WrapMode.
101 static WrapMode::Type GetWrapT(Type flags);
104 * @brief Creates a Sampler with the settings encoded in @a flags.
106 static Sampler MakeSampler(Type flags);
110 * @brief Defines a texture from a combination of an image URI and its sampler definition.
112 struct DALI_SCENE3D_API TextureDefinition
114 std::string mImageUri; // When the texture is loaded from embedded resources, this URI is used as a data stream.
115 std::string mDirectoryPath;
116 SamplerFlags::Type mSamplerFlags;
117 ImageDimensions mMinImageDimensions;
118 SamplingMode::Type mSamplingMode;
119 std::vector<uint8_t> mTextureBuffer;
121 TextureDefinition(const std::string& imageUri = "", SamplerFlags::Type samplerFlags = SamplerFlags::DEFAULT, ImageDimensions minImageDimensions = ImageDimensions(), SamplingMode::Type samplingMode = SamplingMode::BOX_THEN_LINEAR);
122 TextureDefinition(std::string&& imageUri, SamplerFlags::Type samplerFlags = SamplerFlags::DEFAULT, ImageDimensions minImageDimensions = ImageDimensions(), SamplingMode::Type samplingMode = SamplingMode::BOX_THEN_LINEAR);
123 TextureDefinition(std::vector<uint8_t>&& textureBuffer, SamplerFlags::Type samplerFlags = SamplerFlags::DEFAULT, ImageDimensions minImageDimensions = ImageDimensions(), SamplingMode::Type samplingMode = SamplingMode::BOX_THEN_LINEAR);
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
132 struct DALI_SCENE3D_API MaterialDefinition
134 enum Flags : uint32_t
138 METALLIC = NthBit(1),
139 ROUGHNESS = NthBit(2),
141 EMISSIVE = NthBit(4),
142 OCCLUSION = NthBit(5),
143 SPECULAR = NthBit(6),
144 SPECULAR_COLOR = NthBit(7),
145 SUBSURFACE = NthBit(8), // Note: dli-only
147 // Other binary options
148 TRANSPARENCY = NthBit(20),
149 GLTF_CHANNELS = NthBit(21), // https://github.com/KhronosGroup/glTF/tree/master/specification/2.0#pbrmetallicroughnessmetallicroughnesstexture
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,
158 * @brief A(n image based) texture that's used in a material.
163 TextureDefinition mTexture;
166 using Vector = std::vector<std::pair<MaterialDefinition, TextureSet>>;
173 SamplerFlags::Type mSamplerFlags;
176 std::vector<TextureData> mTextures;
179 MaterialDefinition() = default;
181 MaterialDefinition(const MaterialDefinition&) = delete;
182 MaterialDefinition& operator=(const MaterialDefinition&) = delete;
184 MaterialDefinition(MaterialDefinition&&) = default;
185 MaterialDefinition& operator=(MaterialDefinition&&) = default;
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.
192 RawData LoadRaw(const std::string& imagesPath);
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.
201 TextureSet Load(const EnvironmentDefinition::Vector& environments, RawData&& raw) const;
204 * @brief Checks if the given mask matches any of the textures defined.
206 bool CheckTextures(uint32_t flags) const;
209 * @return The alpha test reference value.
210 * @note A value of 0.f means no alpha testing.
212 float GetAlphaCutoff() const
214 return ((mFlags >> ALPHA_CUTOFF_SHIFT) & ALPHA_CUTOFF_MASK) / 255.f;
218 * @brief Encodes the alpha test reference @a value in flags.
219 * @note A value of 0.f means no alpha testing.
221 void SetAlphaCutoff(float value)
223 DALI_ASSERT_DEBUG(value >= 0.f && value <= 1.f);
224 mFlags |= static_cast<uint8_t>(std::round(value * 255.f)) << ALPHA_CUTOFF_SHIFT;
228 std::shared_ptr<RawData> mRawData;
229 uint32_t mFlags = 0x0;
231 Index mEnvironmentIdx = 0;
232 Vector4 mColor = Color::WHITE;
233 float mMetallic = 1.f;
234 float mRoughness = 1.f;
235 Vector4 mBaseColorFactor = Vector4::ONE;
236 float mNormalScale = 1.f;
237 float mOcclusionStrength = 1.f;
238 Vector3 mEmissiveFactor = Vector3::ZERO;
240 float mDielectricSpecular = 0.04f;
241 float mSpecularFactor = 1.0f;
242 Vector3 mSpecularColorFactor = Vector3::ONE;
244 // For the glTF, each of albedo, metallicRoughness, normal textures are not essential.
245 bool mNeedAlbedoTexture = true;
246 bool mNeedMetallicRoughnessTexture = true;
247 bool mNeedNormalTexture = true;
248 bool mDoubleSided = false;
250 Scene3D::Material::AlphaModeType mAlphaModeType = Scene3D::Material::AlphaModeType::OPAQUE;
251 bool mIsOpaque = true;
252 bool mIsMask = false;
254 bool mShadowAvailable = false;
256 std::vector<TextureStage> mTextureStages;
260 } // namespace Dali::Scene3D::Loader
262 #endif //DALI_SCENE3D_LOADER_MATERIAL_DEFINITION_H