impeller::RuntimeStage Class Reference

#include <runtime_stage.h>

Public Types
using	Map = std::map< RuntimeStageBackend, std::shared_ptr< RuntimeStage > >

Public Member Functions
	RuntimeStage (const fb::RuntimeStage *runtime_stage, const std::shared_ptr< fml::Mapping > &payload)
	~RuntimeStage ()
	RuntimeStage (RuntimeStage &&)
RuntimeStage &	operator= (RuntimeStage &&)
bool	IsValid () const
RuntimeShaderStage	GetShaderStage () const
const std::vector< RuntimeUniformDescription > &	GetUniforms () const
const std::vector< DescriptorSetLayout > &	GetDescriptorSetLayouts () const
const std::string &	GetEntrypoint () const
const RuntimeUniformDescription *	GetUniform (const std::string &name) const
const std::shared_ptr< fml::Mapping > &	GetCodeMapping () const
bool	IsDirty () const
void	SetClean ()

Static Public Member Functions
static Map	DecodeRuntimeStages (const std::shared_ptr< fml::Mapping > &payload)

Static Public Attributes
static const char *	kVulkanUBOName

Detailed Description

Definition at line 20 of file runtime_stage.h.

Member Typedef Documentation

Map

using impeller::RuntimeStage::Map = std::map<RuntimeStageBackend, std::shared_ptr<RuntimeStage> >

Definition at line 24 of file runtime_stage.h.

Constructor & Destructor Documentation

RuntimeStage() [1/2]

impeller::RuntimeStage::RuntimeStage	(	const fb::RuntimeStage *	runtime_stage,
		const std::shared_ptr< fml::Mapping > &	payload
	)

Definition at line 83 of file runtime_stage.cc.

    : payload_(payload) {
  FML_DCHECK(runtime_stage);
 
  stage_ = ToShaderStage(runtime_stage->stage());
  entrypoint_ = runtime_stage->entrypoint()->str();
 
  auto* uniforms = runtime_stage->uniforms();
 
  // Note: image bindings are screwy and will always have the same offset.
  // track the binding of the UBO to determine where the image bindings go.
  // This is only guaranteed to give us the correct bindings if there is a
  // single sampler2D.
  std::optional<size_t> ubo_id;
  if (uniforms) {
    for (auto i = uniforms->begin(), end = uniforms->end(); i != end; i++) {
      RuntimeUniformDescription desc;
      desc.name = i->name()->str();
      desc.location = i->location();
      desc.binding = i->binding();
      desc.type = ToType(i->type());
      if (desc.type == kStruct) {
        ubo_id = desc.location;
        desc.binding = desc.location;
      }
      desc.dimensions = RuntimeUniformDimensions{
          static_cast<size_t>(i->rows()), static_cast<size_t>(i->columns())};
      desc.bit_width = i->bit_width();
      desc.array_elements = i->array_elements();
      if (i->struct_layout()) {
        for (const auto& byte_type : *i->struct_layout()) {
          desc.struct_layout.push_back(static_cast<uint8_t>(byte_type));
        }
      }
      desc.struct_float_count = i->struct_float_count();
      uniforms_.push_back(std::move(desc));
    }
  }
 
  code_mapping_ = std::make_shared<fml::NonOwnedMapping>(
      runtime_stage->shader()->data(),     //
      runtime_stage->shader()->size(),     //
      [payload = payload_](auto, auto) {}  //
  );
 
  size_t binding = 64;
  if (ubo_id.has_value() && ubo_id.value() == binding) {
    binding++;
  }
  for (auto& uniform : uniforms_) {
    if (uniform.type == kSampledImage) {
      uniform.binding = binding;
      binding++;
      if (ubo_id.has_value() && ubo_id.value() == binding) {
        binding++;
      }
    }
  }
 
  for (const auto& uniform : GetUniforms()) {
    if (uniform.type == kStruct) {
      descriptor_set_layouts_.push_back(DescriptorSetLayout{
          static_cast<uint32_t>(uniform.location),
          DescriptorType::kUniformBuffer,
          ShaderStage::kFragment,
      });
    } else if (uniform.type == kSampledImage) {
      descriptor_set_layouts_.push_back(DescriptorSetLayout{
          static_cast<uint32_t>(uniform.binding),
          DescriptorType::kSampledImage,
          ShaderStage::kFragment,
      });
    }
  }
  is_valid_ = true;
}

References impeller::RuntimeUniformDescription::array_elements, impeller::RuntimeUniformDescription::binding, impeller::RuntimeUniformDescription::bit_width, impeller::RuntimeUniformDescription::dimensions, GetUniforms(), impeller::kFragment, impeller::kSampledImage, impeller::kStruct, impeller::kUniformBuffer, impeller::RuntimeUniformDescription::location, impeller::RuntimeUniformDescription::name, impeller::RuntimeUniformDescription::struct_float_count, impeller::RuntimeUniformDescription::struct_layout, impeller::ToShaderStage(), impeller::ToType(), and impeller::RuntimeUniformDescription::type.

~RuntimeStage()

impeller::RuntimeStage::~RuntimeStage ( )

default

RuntimeStage() [2/2]

impeller::RuntimeStage::RuntimeStage ( RuntimeStage &&  )

default

Member Function Documentation

DecodeRuntimeStages()

RuntimeStage::Map impeller::RuntimeStage::DecodeRuntimeStages ( const std::shared_ptr< fml::Mapping > &  payload )

static

Definition at line 61 of file runtime_stage.cc.

                                              {
  if (payload == nullptr || !payload->GetMapping()) {
    return {};
  }
  if (!fb::RuntimeStagesBufferHasIdentifier(payload->GetMapping())) {
    return {};
  }
 
  auto raw_stages = fb::GetRuntimeStages(payload->GetMapping());
  return {
      {RuntimeStageBackend::kSkSL,
       RuntimeStageIfPresent(raw_stages->sksl(), payload)},
      {RuntimeStageBackend::kMetal,
       RuntimeStageIfPresent(raw_stages->metal(), payload)},
      {RuntimeStageBackend::kOpenGLES,
       RuntimeStageIfPresent(raw_stages->opengles(), payload)},
      {RuntimeStageBackend::kVulkan,
       RuntimeStageIfPresent(raw_stages->vulkan(), payload)},
  };
}

References impeller::kMetal, impeller::kOpenGLES, impeller::kSkSL, and impeller::kVulkan.

Referenced by impeller::PlaygroundTest::OpenAssetAsRuntimeStage(), impeller::GoldenPlaygroundTest::OpenAssetAsRuntimeStage(), and impeller::testing::TEST_P().

GetCodeMapping()

const std::shared_ptr< fml::Mapping > & impeller::RuntimeStage::GetCodeMapping

(

)

const

Definition at line 169 of file runtime_stage.cc.

                                                                    {
  return code_mapping_;
}

Referenced by impeller::RuntimeStagePlayground::RegisterStage().

GetDescriptorSetLayouts()

const std::vector< DescriptorSetLayout > & impeller::RuntimeStage::GetDescriptorSetLayouts

(

)

const

Definition at line 204 of file runtime_stage.cc.

          {
  return descriptor_set_layouts_;
}

GetEntrypoint()

const std::string & impeller::RuntimeStage::GetEntrypoint

(

)

const

Definition at line 188 of file runtime_stage.cc.

                                                   {
  return entrypoint_;
}

Referenced by impeller::RuntimeStagePlayground::RegisterStage().

GetShaderStage()

RuntimeShaderStage impeller::RuntimeStage::GetShaderStage

(

)

const

Definition at line 192 of file runtime_stage.cc.

                                                      {
  return stage_;
}

Referenced by impeller::RuntimeStagePlayground::RegisterStage().

GetUniform()

const RuntimeUniformDescription * impeller::RuntimeStage::GetUniform

(

const std::string &

name

)

const

Definition at line 178 of file runtime_stage.cc.

                                 {
  for (const auto& uniform : uniforms_) {
    if (uniform.name == name) {
      return &uniform;
    }
  }
  return nullptr;
}

GetUniforms()

const std::vector< RuntimeUniformDescription > & impeller::RuntimeStage::GetUniforms

(

)

const

Definition at line 173 of file runtime_stage.cc.

          {
  return uniforms_;
}

Referenced by RuntimeStage().

IsDirty()

bool impeller::RuntimeStage::IsDirty

(

)

const

Definition at line 196 of file runtime_stage.cc.

                                 {
  return is_dirty_;
}

IsValid()

bool impeller::RuntimeStage::IsValid

(

)

const

Definition at line 165 of file runtime_stage.cc.

                                 {
  return is_valid_;
}

operator=()

RuntimeStage & impeller::RuntimeStage::operator= ( RuntimeStage &&  )

default

SetClean()

void impeller::RuntimeStage::SetClean

(

)

Definition at line 200 of file runtime_stage.cc.

                            {
  is_dirty_ = false;
}

Member Data Documentation

kVulkanUBOName

const char * impeller::RuntimeStage::kVulkanUBOName

static

Initial value:

=
    "_RESERVED_IDENTIFIER_FIXUP_gl_DefaultUniformBlock"

The generated name from GLSLang/shaderc for the UBO containing non-opaque uniforms specified in the user-written runtime effect shader.

Vulkan does not allow non-opaque uniforms outside of a UBO.

Definition at line 22 of file runtime_stage.h.

Referenced by impeller::testing::TEST_P().

---

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

• impeller/runtime_stage/runtime_stage.h
• impeller/runtime_stage/runtime_stage.cc