2 * Copyright (c) 2022 Samsung Electronics Co., Ltd.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 #include "dali-scene3d/public-api/loader/shader-definition-factory.h"
19 #include "dali-scene3d/internal/loader/hash.h"
20 #include "dali-scene3d/public-api/loader/blend-shape-details.h"
21 #include "dali-scene3d/public-api/loader/node-definition.h"
22 #include "dali/devel-api/common/map-wrapper.h"
32 struct ResourceReceiver : IResourceReceiver
34 const ResourceBundle& mResources;
35 const MeshDefinition* mMeshDef = nullptr;
36 const MaterialDefinition* mMaterialDef = nullptr;
38 ResourceReceiver(const ResourceBundle& resources)
39 : mResources(resources)
43 void Register(ResourceType::Value type, Index id) override
47 case ResourceType::Mesh:
48 mMeshDef = &mResources.mMeshes[id].first;
51 case ResourceType::Material:
52 mMaterialDef = &mResources.mMaterials[id].first;
61 void RetrieveBlendShapeComponents(const std::vector<MeshDefinition::BlendShape>& blendShapes, bool& hasPositions, bool& hasNormals, bool& hasTangents)
63 for(const auto& blendShape : blendShapes)
65 hasPositions = hasPositions || blendShape.deltas.IsDefined();
66 hasNormals = hasNormals || blendShape.normals.IsDefined();
67 hasTangents = hasTangents || blendShape.tangents.IsDefined();
71 uint64_t HashNode(const MaterialDefinition& materialDef, const MeshDefinition& meshDef)
75 const bool hasTransparency = MaskMatch(materialDef.mFlags, MaterialDefinition::TRANSPARENCY);
76 hash.Add(hasTransparency);
79 materialDef.CheckTextures(MaterialDefinition::ALBEDO) ||
80 materialDef.CheckTextures(MaterialDefinition::METALLIC | MaterialDefinition::ROUGHNESS) ||
81 materialDef.CheckTextures(MaterialDefinition::NORMAL))
86 if(materialDef.GetAlphaCutoff() > 0.f)
88 hash.Add("ALPH" /*A_TEST*/);
91 if(MaskMatch(materialDef.mFlags, MaterialDefinition::SUBSURFACE))
96 if(MaskMatch(materialDef.mFlags, MaterialDefinition::OCCLUSION))
98 hash.Add("OCCL" /*USION*/);
101 if(MaskMatch(materialDef.mFlags, MaterialDefinition::EMISSIVE))
103 hash.Add("EMIS" /*SIVE*/);
106 if(MaskMatch(materialDef.mFlags, MaterialDefinition::SPECULAR))
111 if(MaskMatch(materialDef.mFlags, MaterialDefinition::SPECULAR_COLOR))
113 hash.Add("SPECCOLTEX");
116 if(MaskMatch(materialDef.mFlags, MaterialDefinition::GLTF_CHANNELS))
118 hash.Add("GLTF" /*_CHANNELS*/);
121 if(meshDef.IsSkinned())
123 hash.Add("SKIN" /*NING*/);
126 if(MaskMatch(meshDef.mFlags, MeshDefinition::FLIP_UVS_VERTICAL))
128 hash.Add("FLIP" /*_V*/);
131 if(meshDef.HasBlendShapes())
133 bool hasPositions = false;
134 bool hasNormals = false;
135 bool hasTangents = false;
136 RetrieveBlendShapeComponents(meshDef.mBlendShapes, hasPositions, hasNormals, hasTangents);
139 hash.Add("MORPHPOS");
144 hash.Add("MORPHNOR");
149 hash.Add("MORPHTAN");
152 if(hasPositions || hasNormals || hasTangents)
156 if(BlendShapes::Version::VERSION_2_0 == meshDef.mBlendShapeVersion)
167 struct ShaderDefinitionFactory::Impl
169 ResourceBundle* mResources; // no ownership
170 std::map<uint64_t, Index> mShaderMap;
173 ShaderDefinitionFactory::ShaderDefinitionFactory()
178 ShaderDefinitionFactory::~ShaderDefinitionFactory() = default;
180 void ShaderDefinitionFactory::SetResources(ResourceBundle& resources)
182 mImpl->mResources = &resources;
183 mImpl->mShaderMap.clear();
186 Index ShaderDefinitionFactory::ProduceShader(NodeDefinition::Renderable& renderable)
188 auto& resources = *mImpl->mResources;
190 ResourceReceiver receiver{resources};
191 renderable.RegisterResources(receiver);
193 if(!(receiver.mMeshDef && receiver.mMaterialDef))
195 renderable.mShaderIdx = INVALID_INDEX;
196 return INVALID_INDEX;
199 auto& shaderMap = mImpl->mShaderMap;
200 uint64_t hash = HashNode(*receiver.mMaterialDef, *receiver.mMeshDef);
201 auto iFind = shaderMap.find(hash);
202 if(iFind != shaderMap.end())
204 renderable.mShaderIdx = iFind->second;
208 ShaderDefinition shaderDef;
209 shaderDef.mUseBuiltInShader = true;
210 shaderDef.mRendererState = RendererState::DEPTH_TEST | RendererState::DEPTH_WRITE;
212 auto& materialDef = *receiver.mMaterialDef;
213 if(!materialDef.mDoubleSided)
215 shaderDef.mRendererState |= RendererState::CULL_BACK;
218 const bool hasTransparency = MaskMatch(materialDef.mFlags, MaterialDefinition::TRANSPARENCY);
221 // TODO: this requires more granularity
222 shaderDef.mRendererState = (shaderDef.mRendererState | RendererState::ALPHA_BLEND) & ~RendererState::DEPTH_WRITE;
225 if(hasTransparency ||
226 !materialDef.CheckTextures(MaterialDefinition::ALBEDO | MaterialDefinition::METALLIC) ||
227 !materialDef.CheckTextures(MaterialDefinition::NORMAL | MaterialDefinition::ROUGHNESS))
230 shaderDef.mDefines.push_back("THREE_TEX");
232 // For the glTF, each of basecolor, metallic_roughness, normal texture is not essential.
233 if(MaskMatch(materialDef.mFlags, MaterialDefinition::ALBEDO))
235 shaderDef.mDefines.push_back("BASECOLOR_TEX");
238 if(materialDef.CheckTextures(MaterialDefinition::METALLIC | MaterialDefinition::ROUGHNESS))
240 shaderDef.mDefines.push_back("METALLIC_ROUGHNESS_TEX");
243 if(MaskMatch(materialDef.mFlags, MaterialDefinition::NORMAL))
245 shaderDef.mDefines.push_back("NORMAL_TEX");
249 if(materialDef.GetAlphaCutoff() > 0.f)
251 shaderDef.mDefines.push_back("ALPHA_TEST");
254 if(MaskMatch(materialDef.mFlags, MaterialDefinition::SUBSURFACE))
256 shaderDef.mDefines.push_back("SSS");
259 if(MaskMatch(materialDef.mFlags, MaterialDefinition::OCCLUSION))
261 shaderDef.mDefines.push_back("OCCLUSION");
264 if(MaskMatch(materialDef.mFlags, MaterialDefinition::EMISSIVE))
266 shaderDef.mDefines.push_back("EMISSIVE");
269 if(MaskMatch(materialDef.mFlags, MaterialDefinition::SPECULAR))
271 shaderDef.mDefines.push_back("MATERIAL_SPECULAR_TEXTURE");
274 if(MaskMatch(materialDef.mFlags, MaterialDefinition::SPECULAR_COLOR))
276 shaderDef.mDefines.push_back("MATERIAL_SPECULAR_COLOR_TEXTURE");
279 if(MaskMatch(materialDef.mFlags, MaterialDefinition::GLTF_CHANNELS))
281 shaderDef.mDefines.push_back("GLTF_CHANNELS");
284 const auto& meshDef = *receiver.mMeshDef;
285 if(meshDef.IsSkinned())
287 shaderDef.mDefines.push_back("SKINNING");
290 if(MaskMatch(meshDef.mFlags, MeshDefinition::FLIP_UVS_VERTICAL))
292 shaderDef.mDefines.push_back("FLIP_V");
295 if(meshDef.HasBlendShapes())
297 bool hasPositions = false;
298 bool hasNormals = false;
299 bool hasTangents = false;
300 RetrieveBlendShapeComponents(meshDef.mBlendShapes, hasPositions, hasNormals, hasTangents);
304 shaderDef.mDefines.push_back("MORPH_POSITION");
309 shaderDef.mDefines.push_back("MORPH_NORMAL");
314 shaderDef.mDefines.push_back("MORPH_TANGENT");
317 if(hasPositions || hasNormals || hasTangents)
319 shaderDef.mDefines.push_back("MORPH");
321 if(BlendShapes::Version::VERSION_2_0 == meshDef.mBlendShapeVersion)
323 shaderDef.mDefines.push_back("MORPH_VERSION_2_0");
328 if(meshDef.mTangentType == Property::VECTOR4)
330 shaderDef.mDefines.push_back("VEC4_TANGENT");
333 shaderDef.mUniforms["uMaxLOD"] = 6.f;
334 shaderDef.mUniforms["uCubeMatrix"] = Matrix::IDENTITY;
336 Index result = resources.mShaders.size();
337 shaderMap[hash] = result;
339 resources.mShaders.emplace_back(std::move(shaderDef), Shader());
341 renderable.mShaderIdx = result;
344 return renderable.mShaderIdx;
347 } // namespace Loader
348 } // namespace Scene3D