impeller::ComputePipelineBuilder< ComputeShader_ > Struct Template Reference

An optional (but highly recommended) utility for creating pipelines from reflected shader information. More...

#include <compute_pipeline_builder.h>

Public Types
using	ComputeShader = ComputeShader_

Static Public Member Functions
static std::optional< ComputePipelineDescriptor >	MakeDefaultPipelineDescriptor (const Context &context)
	Create a default pipeline descriptor using the combination reflected shader information. The descriptor can be configured further before a pipeline state object is created using it. More...
static bool	InitializePipelineDescriptorDefaults (const Context &context, ComputePipelineDescriptor &desc)

Detailed Description

template<class ComputeShader_>
struct impeller::ComputePipelineBuilder< ComputeShader_ >

An optional (but highly recommended) utility for creating pipelines from reflected shader information.

Template Parameters

Compute_Shader

The reflected compute shader information. Found in a generated header file called <shader_name>.comp.h.

Definition at line 26 of file compute_pipeline_builder.h.

Member Typedef Documentation

ComputeShader

template<class ComputeShader_ >

using impeller::ComputePipelineBuilder< ComputeShader_ >::ComputeShader = ComputeShader_

Definition at line 28 of file compute_pipeline_builder.h.

Member Function Documentation

InitializePipelineDescriptorDefaults()

template<class ComputeShader_ >

static bool impeller::ComputePipelineBuilder< ComputeShader_ >::InitializePipelineDescriptorDefaults ( const Context &  context, ComputePipelineDescriptor &  desc  )

inlinestatic

Definition at line 50 of file compute_pipeline_builder.h.

                                       {
    // Setup debug instrumentation.
    desc.SetLabel(std::format("{} Pipeline", ComputeShader::kLabel));
 
    // Resolve pipeline entrypoints.
    {
      auto compute_function = context.GetShaderLibrary()->GetFunction(
          ComputeShader::kEntrypointName, ShaderStage::kCompute);
 
      if (!compute_function) {
        VALIDATION_LOG << "Could not resolve compute pipeline entrypoint '"
                       << ComputeShader::kEntrypointName
                       << "' for pipeline named '" << ComputeShader::kLabel
                       << "'.";
        return false;
      }
 
      if (!desc.RegisterDescriptorSetLayouts(
              ComputeShader::kDescriptorSetLayouts)) {
        VALIDATION_LOG << "Could not configure compute descriptor set layout "
                          "for pipeline named '"
                       << ComputeShader::kLabel << "'.";
        return false;
      }
 
      desc.SetStageEntrypoint(std::move(compute_function));
    }
    return true;
  }

References impeller::Context::GetShaderLibrary(), impeller::kCompute, impeller::ComputePipelineDescriptor::RegisterDescriptorSetLayouts(), impeller::ComputePipelineDescriptor::SetLabel(), impeller::ComputePipelineDescriptor::SetStageEntrypoint(), and VALIDATION_LOG.

Referenced by impeller::ComputePipelineBuilder< ComputeShader_ >::MakeDefaultPipelineDescriptor().

MakeDefaultPipelineDescriptor()

template<class ComputeShader_ >

static std::optional<ComputePipelineDescriptor> impeller::ComputePipelineBuilder< ComputeShader_ >::MakeDefaultPipelineDescriptor ( const Context &  context )

inlinestatic

Create a default pipeline descriptor using the combination reflected shader information. The descriptor can be configured further before a pipeline state object is created using it.

Parameters

[in]

context

The context

Returns

If the combination of reflected shader information is compatible and the requisite functions can be found in the context, a pipeline descriptor.

Definition at line 41 of file compute_pipeline_builder.h.

                              {
    ComputePipelineDescriptor desc;
    if (InitializePipelineDescriptorDefaults(context, desc)) {
      return {std::move(desc)};
    }
    return std::nullopt;
  }

References impeller::ComputePipelineBuilder< ComputeShader_ >::InitializePipelineDescriptorDefaults().

---

The documentation for this struct was generated from the following file:

• impeller/renderer/compute_pipeline_builder.h