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

#include <shader.h>

Inheritance diagram for flutter::gpu::Shader:

Classes
struct	TextureBinding

struct	UniformBinding

Public Member Functions
	~Shader () override

std::shared_ptr< const impeller::ShaderFunction >	GetFunctionFromLibrary (impeller::ShaderLibrary &library)

bool	IsRegistered (Context &context)

bool	RegisterSync (Context &context)

std::shared_ptr< impeller::VertexDescriptor >	CreateVertexDescriptor () const

const std::vector< impeller::DescriptorSetLayout > &	GetDescriptorSetLayouts () const

impeller::ShaderStage	GetShaderStage () const

const Shader::UniformBinding *	GetUniformStruct (const std::string &name) const

const Shader::TextureBinding *	GetUniformTexture (const std::string &name) const

Public Member Functions inherited from flutter::RefCountedDartWrappable< Shader >
virtual void	RetainDartWrappableReference () const override

virtual void	ReleaseDartWrappableReference () const override

Public Member Functions inherited from fml::RefCountedThreadSafe< T >
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 DartWrapperInfo &	GetDartWrapperInfo () 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< 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, TextureBinding > uniform_textures, std::vector< impeller::DescriptorSetLayout > descriptor_set_layouts)

Additional Inherited Members
Public Types inherited from tonic::DartWrappable
enum	DartNativeFields { kPeerIndex , kNumberOfNativeFields }

Protected Member Functions inherited from fml::RefCountedThreadSafe< T >
	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 23 of file shader.h.

Constructor & Destructor Documentation

◆ ~Shader()

flutter::gpu::Shader::~Shader ( )

overridedefault

Member Function Documentation

◆ CreateVertexDescriptor()

std::shared_ptr< impeller::VertexDescriptor > flutter::gpu::Shader::CreateVertexDescriptor ( ) const

Definition at line 89 of file shader.cc.

          {
  auto vertex_descriptor = std::make_shared<impeller::VertexDescriptor>();
  vertex_descriptor->SetStageInputs(inputs_, layouts_);
  return vertex_descriptor;
}

Referenced by flutter::gpu::RenderPipeline::BindToPipelineDescriptor().

◆ GetDescriptorSetLayouts()

const std::vector< impeller::DescriptorSetLayout > & flutter::gpu::Shader::GetDescriptorSetLayouts ( ) const

Definition at line 101 of file shader.cc.

                                      {
  return descriptor_set_layouts_;
}

Referenced by flutter::gpu::RenderPipeline::BindToPipelineDescriptor().

◆ GetFunctionFromLibrary()

std::shared_ptr< const impeller::ShaderFunction > flutter::gpu::Shader::GetFunctionFromLibrary ( impeller::ShaderLibrary & library )

Definition at line 59 of file shader.cc.

                                    {
  return library.GetFunction(entrypoint_, stage_);
}

References impeller::ShaderLibrary::GetFunction().

Referenced by flutter::gpu::RenderPipeline::BindToPipelineDescriptor(), and IsRegistered().

◆ GetShaderStage()

impeller::ShaderStage flutter::gpu::Shader::GetShaderStage ( ) const

Definition at line 96 of file shader.cc.

                                                 {
  return stage_;
}

Referenced by BindUniform(), and InternalFlutterGpu_RenderPass_BindTexture().

◆ GetUniformStruct()

const Shader::UniformBinding * flutter::gpu::Shader::GetUniformStruct ( const std::string & name ) const

Definition at line 105 of file shader.cc.

                                 {
  auto uniform = uniform_structs_.find(name);
  if (uniform == uniform_structs_.end()) {
    return nullptr;
  }
  return &uniform->second;
}

References flutter::name.

Referenced by BindUniform(), InternalFlutterGpu_Shader_GetUniformMemberOffset(), and InternalFlutterGpu_Shader_GetUniformStructSize().

◆ GetUniformTexture()

const Shader::TextureBinding * flutter::gpu::Shader::GetUniformTexture ( const std::string & name ) const

Definition at line 114 of file shader.cc.

                                 {
  auto uniform = uniform_textures_.find(name);
  if (uniform == uniform_textures_.end()) {
    return nullptr;
  }
  return &uniform->second;
}

References flutter::name.

Referenced by InternalFlutterGpu_RenderPass_BindTexture().

◆ IsRegistered()

bool flutter::gpu::Shader::IsRegistered ( Context & context )

Definition at line 64 of file shader.cc.

                                          {
  auto& lib = *context.GetContext().GetShaderLibrary();
  return GetFunctionFromLibrary(lib) != nullptr;
}

References flutter::gpu::Context::GetContext(), GetFunctionFromLibrary(), and impeller::Context::GetShaderLibrary().

Referenced by RegisterSync().

◆ Make()

fml::RefPtr< Shader > flutter::gpu::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, TextureBinding >	uniform_textures,
		std::vector< impeller::DescriptorSetLayout >	descriptor_set_layouts
	)

static

Definition at line 38 of file shader.cc.

                                                                   {
  auto shader = fml::MakeRefCounted<Shader>();
  shader->entrypoint_ = std::move(entrypoint);
  shader->stage_ = stage;
  shader->code_mapping_ = std::move(code_mapping);
  shader->inputs_ = std::move(inputs);
  shader->layouts_ = std::move(layouts);
  shader->uniform_structs_ = std::move(uniform_structs);
  shader->uniform_textures_ = std::move(uniform_textures);
  shader->descriptor_set_layouts_ = std::move(descriptor_set_layouts);
  return shader;
}

Referenced by flutter::gpu::ShaderLibrary::MakeFromFlatbuffer().

◆ RegisterSync()

bool flutter::gpu::Shader::RegisterSync ( Context & context )

Definition at line 69 of file shader.cc.

                                          {
  if (IsRegistered(context)) {
    return true;  // Already registered.
  }
 
  auto& lib = *context.GetContext().GetShaderLibrary();
 
  std::promise<bool> promise;
  auto future = promise.get_future();
  lib.RegisterFunction(
      entrypoint_, stage_, code_mapping_,
      fml::MakeCopyable([promise = std::move(promise)](bool result) mutable {
        promise.set_value(result);
      }));
  if (!future.get()) {
    return false;  // Registration failed.
  }
  return true;
}

References flutter::gpu::Context::GetContext(), impeller::Context::GetShaderLibrary(), IsRegistered(), and fml::MakeCopyable().

Referenced by InternalFlutterGpu_RenderPipeline_Initialize().

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

lib/gpu/shader.h
lib/gpu/shader.cc

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members