1 #ifndef DALI_SCENE_LOADER_MATERIAL_DEFINITION_H
2 #define DALI_SCENE_LOADER_MATERIAL_DEFINITION_H
4 * Copyright (c) 2020 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-scene-loader/public-api/api.h"
22 #include "dali-scene-loader/public-api/environment-definition.h"
23 #include "dali-scene-loader/public-api/index.h"
24 #include "dali-scene-loader/public-api/utils.h"
27 #include "dali/public-api/math/vector4.h"
28 #include "dali/public-api/common/vector-wrapper.h"
37 * @brief Helper enum for encoding and decoding sampler states.
39 struct DALI_SCENE_LOADER_API SamplerFlags
47 FILTER_LINEAR = NthBit(0),
48 FILTER_MIPMAP_NEAREST = NthBit(1),
49 FILTER_MIPMAP_LINEAR = NthBit(2),
53 WRAP_CLAMP = NthBit(0),
54 WRAP_MIRROR = NthBit(1),
56 // Layout - apply shift, then mask
58 FILTER_MIN_MASK = NthBit(FILTER_MIN_BITS) - 1,
61 FILTER_MAG_SHIFT = FILTER_MIN_BITS,
62 FILTER_MAG_MASK = NthBit(FILTER_MAG_BITS) - 1,
65 WRAP_S_SHIFT = FILTER_MAG_SHIFT + FILTER_MAG_BITS,
66 WRAP_S_MASK = NthBit(WRAP_S_BITS) - 1,
69 WRAP_T_SHIFT = WRAP_S_SHIFT + WRAP_S_BITS,
70 WRAP_T_MASK = NthBit(WRAP_T_BITS) - 1,
73 MIPMAP_MASK = FILTER_MIPMAP_LINEAR | FILTER_MIPMAP_NEAREST,
76 DEFAULT = FILTER_LINEAR | (FILTER_LINEAR << FILTER_MAG_SHIFT) | (WRAP_REPEAT << WRAP_S_SHIFT) | (WRAP_REPEAT << WRAP_T_SHIFT), // LINEAR filters, REPEAT wraps
80 * @return SamplerFlags bit pattern calculated from the given Dali Sampler settings.
82 static Type Encode(FilterMode::Type minFilter, FilterMode::Type magFilter,
83 WrapMode::Type wrapS, WrapMode::Type wrapT);
86 * @brief Decodes the minification filter patter of @a flags into the corresponding FilterMode.
88 static FilterMode::Type GetMinFilter(Type flags);
91 * @brief Decodes the magnification filter patter of @a flags into the corresponding FilterMode.
93 static FilterMode::Type GetMagFilter(Type flags);
96 * @brief Decodes the horizontal wrap pattern of @a flags into the corresponding WrapMode.
98 static WrapMode::Type GetWrapS(Type flags);
101 * @brief Decodes the vertical wrap pattern of @a flags into the corresponding WrapMode.
103 static WrapMode::Type GetWrapT(Type flags);
106 * @brief Creates a Sampler with the settings encoded in @a flags.
108 static Sampler MakeSampler(Type flags);
112 * @brief Defines a texture from a combination of an image URI and its sampler definition.
114 struct DALI_SCENE_LOADER_API TextureDefinition
116 std::string mImageUri;
117 SamplerFlags::Type mSamplerFlags;
119 TextureDefinition(const std::string& imageUri = "", SamplerFlags::Type samplerFlags = SamplerFlags::DEFAULT);
123 * @brief Defines a material with a number of texture stages, whether mipmappping
124 * is enabled, and an index of an environment (usually of all environments in a
125 * scene). Textures from the environment are added last when the DALi TextureSet
128 struct DALI_SCENE_LOADER_API MaterialDefinition
130 enum Flags : uint32_t
134 METALLIC = NthBit(1),
135 ROUGHNESS = NthBit(2),
137 EMISSIVE = NthBit(4), // TODO: support
138 OCCLUSION = NthBit(5), // TODO: support
139 SUBSURFACE = NthBit(6), // Note: dli-only
141 // Other binary options
142 TRANSPARENCY = NthBit(20),
143 GLTF_CHANNELS = NthBit(21), // https://github.com/KhronosGroup/glTF/tree/master/specification/2.0#pbrmetallicroughnessmetallicroughnesstexture
145 // Alpha cutoff - reserved from the 24th bit
146 ALPHA_CUTOFF_BITS = 8,
147 ALPHA_CUTOFF_SHIFT = sizeof(uint32_t) * 8 - ALPHA_CUTOFF_BITS,
148 ALPHA_CUTOFF_MASK = (1 << ALPHA_CUTOFF_BITS) - 1,
152 * @brief A(n image based) texture that's used in a material.
157 TextureDefinition mTexture;
160 using Vector = std::vector<std::pair<MaterialDefinition, TextureSet>>;
167 SamplerFlags::Type mSamplerFlags;
170 std::vector<TextureData> mTextures;
173 MaterialDefinition() = default;
175 MaterialDefinition(const MaterialDefinition&) = delete;
176 MaterialDefinition& operator=(const MaterialDefinition&) = delete;
178 MaterialDefinition(MaterialDefinition&&) = default;
179 MaterialDefinition& operator=(MaterialDefinition&&) = default;
182 * @brief Loads (or, in the case of solid color materials, creates) raw pixel data,
183 * which is then returned.
184 * @note This may be called from any thread.
186 RawData LoadRaw(const std::string& imagesPath) const;
189 * @brief Creates Textures from the pixel data in @a raw, gets the
190 * the cube maps from the iEnvironment'th element of @a environments,
191 * then creates a DALi TextureSet and returns it.
192 * @note This must be called from the event thread.
193 * @note The textures are added in the following order: 2D, cube maps.
195 TextureSet Load(const EnvironmentDefinition::Vector& environments, RawData&& raw) const;
198 * @brief Checks if the given mask matches any of the textures defined.
200 bool CheckTextures(uint32_t flags) const;
203 * @return The alpha test reference value.
204 * @note A value of 0.f means no alpha testing.
206 float GetAlphaCutoff() const
208 return ((mFlags >> ALPHA_CUTOFF_SHIFT) & ALPHA_CUTOFF_MASK) / 255.f;
212 * @brief Encodes the alpha test reference @a value in flags.
213 * @note A value of 0.f means no alpha testing.
215 void SetAlphaCutoff(float value)
217 DALI_ASSERT_DEBUG(value >= 0.f && value <= 1.f);
218 mFlags |= static_cast<uint8_t>(std::round(value * 255.f)) << ALPHA_CUTOFF_SHIFT;
222 uint32_t mFlags = 0x0;
224 Index mEnvironmentIdx = 0;
225 Vector4 mColor = Color::WHITE;
226 float mMetallic = 1.f;
227 float mRoughness = 1.f;
228 std::vector<TextureStage> mTextureStages;
234 #endif //DALI_SCENE_LOADER_MATERIAL_DEFINITION_H