Flutter Engine
The Flutter Engine
Public Types | Public Member Functions | Static Public Member Functions | List of all members
flutter::gpu::ShaderLibrary Class Reference

An immutable collection of shaders loaded from a shader bundle asset. More...

#include <shader_library.h>

Inheritance diagram for flutter::gpu::ShaderLibrary:
flutter::RefCountedDartWrappable< ShaderLibrary > fml::RefCountedThreadSafe< ShaderLibrary > tonic::DartWrappable fml::internal::RefCountedThreadSafeBase

Public Types

using ShaderMap = std::unordered_map< std::string, fml::RefPtr< Shader > >
 
- Public Types inherited from tonic::DartWrappable
enum  DartNativeFields { kPeerIndex , kNumberOfNativeFields }
 

Public Member Functions

fml::RefPtr< ShaderGetShader (const std::string &shader_name, Dart_Handle shader_wrapper) const
 
 ~ShaderLibrary () override
 
- Public Member Functions inherited from flutter::RefCountedDartWrappable< ShaderLibrary >
virtual void RetainDartWrappableReference () const override
 
virtual void ReleaseDartWrappableReference () const override
 
- Public Member Functions inherited from fml::RefCountedThreadSafe< ShaderLibrary >
void Release () const
 
- Public Member Functions inherited from fml::internal::RefCountedThreadSafeBase
void AddRef () const
 
bool HasOneRef () const
 
void AssertHasOneRef () const
 
- Public Member Functions inherited from tonic::DartWrappable
 DartWrappable ()
 
virtual const DartWrapperInfoGetDartWrapperInfo () const =0
 
virtual void RetainDartWrappableReference () const =0
 
virtual void ReleaseDartWrappableReference () const =0
 
Dart_Handle CreateDartWrapper (DartState *dart_state)
 
void AssociateWithDartWrapper (Dart_Handle wrappable)
 
void ClearDartWrapper ()
 
Dart_WeakPersistentHandle dart_wrapper () const
 

Static Public Member Functions

static fml::RefPtr< ShaderLibraryMakeFromAsset (impeller::Context::BackendType backend_type, const std::string &name, std::string &out_error)
 
static fml::RefPtr< ShaderLibraryMakeFromShaders (ShaderMap shaders)
 
static fml::RefPtr< ShaderLibraryMakeFromFlatbuffer (impeller::Context::BackendType backend_type, std::shared_ptr< fml::Mapping > payload)
 
static void SetOverride (fml::RefPtr< ShaderLibrary > override_shader_library)
 Sets a return override for MakeFromAsset for testing purposes. More...
 

Additional Inherited Members

- Protected Member Functions inherited from fml::RefCountedThreadSafe< ShaderLibrary >
 RefCountedThreadSafe ()
 
 ~RefCountedThreadSafe ()
 
- Protected Member Functions inherited from fml::internal::RefCountedThreadSafeBase
 RefCountedThreadSafeBase ()
 
 ~RefCountedThreadSafeBase ()
 
bool Release () const
 
void Adopt ()
 
- Protected Member Functions inherited from tonic::DartWrappable
virtual ~DartWrappable ()
 
- Static Protected Member Functions inherited from tonic::DartWrappable
static Dart_PersistentHandle GetTypeForWrapper (tonic::DartState *dart_state, const tonic::DartWrapperInfo &wrapper_info)
 

Detailed Description

An immutable collection of shaders loaded from a shader bundle asset.

Definition at line 21 of file shader_library.h.

Member Typedef Documentation

◆ ShaderMap

using flutter::gpu::ShaderLibrary::ShaderMap = std::unordered_map<std::string, fml::RefPtr<Shader> >

Definition at line 26 of file shader_library.h.

Constructor & Destructor Documentation

◆ ~ShaderLibrary()

flutter::gpu::ShaderLibrary::~ShaderLibrary ( )
overridedefault

Member Function Documentation

◆ GetShader()

fml::RefPtr< Shader > flutter::gpu::ShaderLibrary::GetShader ( const std::string &  shader_name,
Dart_Handle  shader_wrapper 
) const

Definition at line 325 of file shader_library.cc.

326 {
327 auto it = shaders_.find(shader_name);
328 if (it == shaders_.end()) {
329 return nullptr; // No matching shaders.
330 }
331 auto shader = it->second;
332
333 if (shader->dart_wrapper() == nullptr) {
334 shader->AssociateWithDartWrapper(shader_wrapper);
335 }
336 return shader;
337}

◆ MakeFromAsset()

fml::RefPtr< ShaderLibrary > flutter::gpu::ShaderLibrary::MakeFromAsset ( impeller::Context::BackendType  backend_type,
const std::string &  name,
std::string &  out_error 
)
static

Definition at line 30 of file shader_library.cc.

33 {
34 if (override_shader_library_) {
35 return override_shader_library_;
36 }
37
38 auto dart_state = UIDartState::Current();
39 std::shared_ptr<AssetManager> asset_manager =
40 dart_state->platform_configuration()->client()->GetAssetManager();
41
42 std::unique_ptr<fml::Mapping> data = asset_manager->GetAsMapping(name);
43 if (data == nullptr) {
44 out_error = std::string("Asset '") + name + std::string("' not found.");
45 return nullptr;
46 }
47
48 return MakeFromFlatbuffer(backend_type, std::move(data));
49}
static UIDartState * Current()
static fml::RefPtr< ShaderLibrary > MakeFromFlatbuffer(impeller::Context::BackendType backend_type, std::shared_ptr< fml::Mapping > payload)
DEF_SWITCHES_START aot vmservice shared library name
Definition: switches.h:32
DEF_SWITCHES_START aot vmservice shared library Name of the *so containing AOT compiled Dart assets for launching the service isolate vm snapshot data
Definition: switches.h:41

◆ MakeFromFlatbuffer()

fml::RefPtr< ShaderLibrary > flutter::gpu::ShaderLibrary::MakeFromFlatbuffer ( impeller::Context::BackendType  backend_type,
std::shared_ptr< fml::Mapping payload 
)
static

Definition at line 178 of file shader_library.cc.

180 {
181 if (payload == nullptr || !payload->GetMapping()) {
182 return nullptr;
183 }
184 if (!impeller::fb::shaderbundle::ShaderBundleBufferHasIdentifier(
185 payload->GetMapping())) {
186 return nullptr;
187 }
188 auto* bundle =
189 impeller::fb::shaderbundle::GetShaderBundle(payload->GetMapping());
190 if (!bundle) {
191 return nullptr;
192 }
193
194 ShaderLibrary::ShaderMap shader_map;
195
196 for (const auto* bundled_shader : *bundle->shaders()) {
197 const impeller::fb::shaderbundle::BackendShader* backend_shader =
198 GetShaderBackend(backend_type, bundled_shader);
199 if (!backend_shader) {
200 VALIDATION_LOG << "Failed to unpack shader \""
201 << bundled_shader->name()->c_str() << "\" from bundle.";
202 continue;
203 }
204
205 auto code_mapping = std::make_shared<fml::NonOwnedMapping>(
206 backend_shader->shader()->data(), //
207 backend_shader->shader()->size(), //
208 [payload = payload](auto, auto) {} //
209 );
210
211 std::vector<impeller::DescriptorSetLayout> descriptor_set_layouts;
212
213 std::unordered_map<std::string, Shader::UniformBinding> uniform_structs;
214 if (backend_shader->uniform_structs() != nullptr) {
215 for (const auto& uniform : *backend_shader->uniform_structs()) {
216 std::vector<impeller::ShaderStructMemberMetadata> members;
217 if (uniform->fields() != nullptr) {
218 for (const auto& struct_member : *uniform->fields()) {
219 members.push_back(impeller::ShaderStructMemberMetadata{
220 .type = FromUniformType(struct_member->type()),
221 .name = struct_member->name()->c_str(),
222 .offset = static_cast<size_t>(struct_member->offset_in_bytes()),
223 .size =
224 static_cast<size_t>(struct_member->element_size_in_bytes()),
225 .byte_length =
226 static_cast<size_t>(struct_member->total_size_in_bytes()),
227 .array_elements =
228 struct_member->array_elements() != 0
229 ? std::optional<size_t>(std::nullopt)
230 : static_cast<size_t>(struct_member->array_elements()),
231 });
232 }
233 }
234
235 uniform_structs[uniform->name()->str()] = Shader::UniformBinding{
236 .slot =
238 .name = uniform->name()->c_str(),
239 .ext_res_0 = static_cast<size_t>(uniform->ext_res_0()),
240 .set = static_cast<size_t>(uniform->set()),
241 .binding = static_cast<size_t>(uniform->binding()),
242 },
243 .metadata =
245 .name = uniform->name()->c_str(),
246 .members = members,
247 },
248 .size_in_bytes = static_cast<size_t>(uniform->size_in_bytes()),
249 };
250
251 descriptor_set_layouts.push_back(impeller::DescriptorSetLayout{
252 static_cast<uint32_t>(uniform->binding()),
254 ToShaderStage(backend_shader->stage()),
255 });
256 }
257 }
258
259 std::unordered_map<std::string, impeller::SampledImageSlot>
260 uniform_textures;
261 if (backend_shader->uniform_textures() != nullptr) {
262 for (const auto& uniform : *backend_shader->uniform_textures()) {
263 uniform_textures[uniform->name()->str()] = impeller::SampledImageSlot{
264 .name = uniform->name()->c_str(),
265 .texture_index = static_cast<size_t>(uniform->ext_res_0()),
266 .set = static_cast<size_t>(uniform->set()),
267 .binding = static_cast<size_t>(uniform->binding()),
268 };
269
270 descriptor_set_layouts.push_back(impeller::DescriptorSetLayout{
271 static_cast<uint32_t>(uniform->binding()),
273 ToShaderStage(backend_shader->stage()),
274 });
275 }
276 }
277
278 std::vector<impeller::ShaderStageIOSlot> inputs;
279 std::vector<impeller::ShaderStageBufferLayout> layouts;
280 if (backend_shader->stage() ==
281 impeller::fb::shaderbundle::ShaderStage::kVertex) {
282 auto inputs_fb = backend_shader->inputs();
283
284 inputs.reserve(inputs_fb->size());
285 size_t default_stride = 0;
286 for (const auto& input : *inputs_fb) {
288 slot.name = input->name()->c_str();
289 slot.location = input->location();
290 slot.set = input->set();
291 slot.binding = input->binding();
292 slot.type = FromInputType(input->type());
293 slot.bit_width = input->bit_width();
294 slot.vec_size = input->vec_size();
295 slot.columns = input->columns();
296 slot.offset = input->offset();
297 inputs.emplace_back(slot);
298
299 default_stride +=
300 SizeOfInputType(input->type()) * slot.vec_size * slot.columns;
301 }
303 .stride = default_stride,
304 .binding = 0u,
305 }};
306 }
307
308 auto shader = flutter::gpu::Shader::Make(
309 backend_shader->entrypoint()->str(),
310 ToShaderStage(backend_shader->stage()), std::move(code_mapping),
311 std::move(inputs), std::move(layouts), std::move(uniform_structs),
312 std::move(uniform_textures), std::move(descriptor_set_layouts));
313 shader_map[bundled_shader->name()->str()] = std::move(shader);
314 }
315
316 return fml::MakeRefCounted<flutter::gpu::ShaderLibrary>(
317 std::move(payload), std::move(shader_map));
318}
std::unordered_map< std::string, fml::RefPtr< Shader > > ShaderMap
static fml::RefPtr< Shader > Make(std::string entrypoint, impeller::ShaderStage stage, std::shared_ptr< fml::Mapping > code_mapping, std::vector< impeller::ShaderStageIOSlot > inputs, std::vector< impeller::ShaderStageBufferLayout > layouts, std::unordered_map< std::string, UniformBinding > uniform_structs, std::unordered_map< std::string, impeller::SampledImageSlot > uniform_textures, std::vector< impeller::DescriptorSetLayout > descriptor_set_layouts)
Definition: shader.cc:38
static const impeller::fb::shaderbundle::BackendShader * GetShaderBackend(impeller::Context::BackendType backend_type, const impeller::fb::shaderbundle::Shader *shader)
static impeller::ShaderType FromUniformType(impeller::fb::shaderbundle::UniformDataType uniform_type)
static impeller::ShaderType FromInputType(impeller::fb::shaderbundle::InputDataType input_type)
static impeller::ShaderStage ToShaderStage(impeller::fb::shaderbundle::ShaderStage stage)
static size_t SizeOfInputType(impeller::fb::shaderbundle::InputDataType input_type)
it will be possible to load the file into Perfetto s trace viewer disable asset Prevents usage of any non test fonts unless they were explicitly Loaded via prefetched default font Indicates whether the embedding started a prefetch of the default font manager before creating the engine run In non interactive keep the shell running after the Dart script has completed enable serial On low power devices with low core running concurrent GC tasks on threads can cause them to contend with the UI thread which could potentially lead to jank This option turns off all concurrent GC activities domain network JSON encoded network policy per domain This overrides the DisallowInsecureConnections switch Embedder can specify whether to allow or disallow insecure connections at a domain level old gen heap size
Definition: switches.h:259
DEF_SWITCHES_START aot vmservice shared library Name of the *so containing AOT compiled Dart assets for launching the service isolate vm snapshot The VM snapshot data that will be memory mapped as read only SnapshotAssetPath must be present isolate snapshot The isolate snapshot data that will be memory mapped as read only SnapshotAssetPath must be present cache dir Path to the cache directory This is different from the persistent_cache_path in embedder which is used for Skia shader cache icu native lib Path to the library file that exports the ICU data vm service The hostname IP address on which the Dart VM Service should be served If not set
Definition: switches.h:76
Metadata required to bind a combined texture and sampler.
Definition: shader_types.h:98
const char * name
The name of the uniform slot.
Definition: shader_types.h:100
Metadata required to bind a buffer.
Definition: shader_types.h:81
const char * name
The name of the uniform slot.
Definition: shader_types.h:83
#define VALIDATION_LOG
Definition: validation.h:73

◆ MakeFromShaders()

fml::RefPtr< ShaderLibrary > flutter::gpu::ShaderLibrary::MakeFromShaders ( ShaderMap  shaders)
static

Definition at line 51 of file shader_library.cc.

51 {
52 return fml::MakeRefCounted<flutter::gpu::ShaderLibrary>(nullptr,
53 std::move(shaders));
54}

◆ SetOverride()

void flutter::gpu::ShaderLibrary::SetOverride ( fml::RefPtr< ShaderLibrary override_shader_library)
static

Sets a return override for MakeFromAsset for testing purposes.

Definition at line 320 of file shader_library.cc.

321 {
322 override_shader_library_ = std::move(override_shader_library);
323}

The documentation for this class was generated from the following files: