2 * Copyright (c) 2023 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.
19 #include <dali/internal/render/shaders/program.h>
26 #include <dali/devel-api/common/hash.h>
27 #include <dali/graphics-api/graphics-controller.h>
28 #include <dali/graphics-api/graphics-program.h>
29 #include <dali/graphics-api/graphics-reflection.h>
30 #include <dali/integration-api/debug.h>
31 #include <dali/internal/common/shader-data.h>
32 #include <dali/internal/render/common/performance-monitor.h>
33 #include <dali/internal/render/shaders/program-cache.h>
34 #include <dali/public-api/common/constants.h>
35 #include <dali/public-api/common/dali-common.h>
36 #include <dali/public-api/common/dali-vector.h>
45 const unsigned int NUMBER_OF_DEFAULT_UNIFORMS = static_cast<unsigned int>(Program::DefaultUniformIndex::COUNT);
48 * List of all default uniforms used for quicker lookup
50 size_t DEFAULT_UNIFORM_HASHTABLE[NUMBER_OF_DEFAULT_UNIFORMS] =
52 CalculateHash(std::string("uModelMatrix")),
53 CalculateHash(std::string("uMvpMatrix")),
54 CalculateHash(std::string("uViewMatrix")),
55 CalculateHash(std::string("uModelView")),
56 CalculateHash(std::string("uNormalMatrix")),
57 CalculateHash(std::string("uProjection")),
58 CalculateHash(std::string("uSize")),
59 CalculateHash(std::string("uColor")),
60 CalculateHash(std::string("uActorColor"))};
63 * Helper function to calculate the correct alignment of data for uniform buffers
64 * @param dataSize size of uniform buffer
65 * @return aligned offset of data
67 inline uint32_t GetUniformBufferDataAlignment(uint32_t dataSize)
69 return ((dataSize / 256u) + ((dataSize % 256u) ? 1u : 0u)) * 256u;
76 Program* Program::New(ProgramCache& cache, Internal::ShaderDataPtr shaderData, Graphics::Controller& gfxController)
78 size_t shaderHash = shaderData->GetHashValue();
80 Program* program = cache.GetProgram(shaderHash);
82 if(nullptr == program)
84 // program not found so create it
85 program = new Program(cache, shaderData, gfxController);
86 cache.AddProgram(shaderHash, program);
92 Program::Program(ProgramCache& cache, Internal::ShaderDataPtr shaderData, Graphics::Controller& controller)
94 mProjectionMatrix(nullptr),
97 mGfxController(controller),
98 mProgramData(shaderData)
102 Program::~Program() = default;
104 void Program::BuildReflection(const Graphics::Reflection& graphicsReflection)
106 mReflectionDefaultUniforms.clear();
107 mReflectionDefaultUniforms.resize(NUMBER_OF_DEFAULT_UNIFORMS);
109 auto uniformBlockCount = graphicsReflection.GetUniformBlockCount();
111 // add uniform block fields
112 for(auto i = 0u; i < uniformBlockCount; ++i)
114 Graphics::UniformBlockInfo uboInfo;
115 graphicsReflection.GetUniformBlock(i, uboInfo);
117 // for each member store data
118 for(const auto& item : uboInfo.members)
120 // Add a hash for the whole name.
122 // If the name represents an array of basic types, it won't contain an index
123 // operator "[",NN,"]".
125 // If the name represents an element in an array of structs, it will contain an
126 // index operator, but should be hashed in full.
127 auto hashValue = CalculateHash(item.name);
128 mReflection.emplace_back(ReflectionUniformInfo{hashValue, false, item});
130 // update buffer index
131 mReflection.back().uniformInfo.bufferIndex = i;
133 // Update default uniforms
134 for(auto j = 0u; j < NUMBER_OF_DEFAULT_UNIFORMS; ++j)
136 if(hashValue == DEFAULT_UNIFORM_HASHTABLE[j])
138 mReflectionDefaultUniforms[j] = mReflection.back();
146 auto samplers = graphicsReflection.GetSamplers(); // Only holds first element of arrays without [].
147 for(const auto& sampler : samplers)
149 mReflection.emplace_back(ReflectionUniformInfo{CalculateHash(sampler.name), false, sampler});
152 // check for potential collisions
153 std::map<size_t, bool> hashTest;
154 bool hasCollisions(false);
155 for(auto&& item : mReflection)
157 if(hashTest.find(item.hashValue) == hashTest.end())
159 hashTest[item.hashValue] = false;
163 hashTest[item.hashValue] = true;
164 hasCollisions = true;
168 // update collision flag for further use
171 for(auto&& item : mReflection)
173 item.hasCollision = hashTest[item.hashValue];
177 // Calculate size of memory for uniform blocks
178 mUniformBlockRequirements.totalSizeRequired = 0;
179 mUniformBlockRequirements.blockCount = graphicsReflection.GetUniformBlockCount();
180 for(auto i = 0u; i < mUniformBlockRequirements.blockCount; ++i)
182 auto blockSize = GetUniformBufferDataAlignment(graphicsReflection.GetUniformBlockSize(i));
183 mUniformBlockRequirements.totalSizeRequired += blockSize;
187 void Program::SetGraphicsProgram(Graphics::UniquePtr<Graphics::Program>&& program)
189 mGfxProgram = std::move(program);
190 BuildReflection(mGfxController.GetProgramReflection(*mGfxProgram.get()));
193 bool Program::GetUniform(const std::string_view& name, Hash hashedName, Hash hashedNameNoArray, Graphics::UniformInfo& out) const
195 if(mReflection.empty())
199 DALI_ASSERT_DEBUG(hashedName != 0 && "GetUniform() hash is not set");
201 // If name contains a "]", but has nothing after, it's an element in an array,
202 // The reflection doesn't contain such elements, it only contains the name without square brackets
203 // Use the hash without array subscript.
205 // If the name contains a "]" anywhere but the end, it's a structure element. The reflection
206 // does contain such elements, so use normal hash.
207 Hash hash = hashedName;
208 std::string_view match = name;
210 if(!name.empty() && name.back() == ']')
212 hash = hashedNameNoArray;
213 auto pos = name.rfind("[");
214 match = name.substr(0, pos - 1); // Remove subscript
217 for(const ReflectionUniformInfo& item : mReflection)
219 if(item.hashValue == hash)
221 if(!item.hasCollision || item.uniformInfo.name == match)
223 out = item.uniformInfo;
235 const Graphics::UniformInfo* Program::GetDefaultUniform(DefaultUniformIndex defaultUniformIndex) const
237 if(mReflectionDefaultUniforms.empty())
242 const auto value = &mReflectionDefaultUniforms[static_cast<uint32_t>(defaultUniformIndex)];
243 return &value->uniformInfo;
246 } // namespace Internal