impeller::ComputePassMTL Class Reference

#include <compute_pass_mtl.h>

Inheritance diagram for impeller::ComputePassMTL:

Public Member Functions
	~ComputePassMTL () override
Public Member Functions inherited from impeller::ComputePass
virtual	~ComputePass ()
void	SetLabel (const std::string &label)
const Context &	GetContext () const
Public Member Functions inherited from impeller::ResourceBinder
virtual	~ResourceBinder ()=default

Private Member Functions
bool	IsValid () const override
fml::Status	Compute (const ISize &grid_size) override
void	SetCommandLabel (std::string_view label) override
void	OnSetLabel (const std::string &label) override
void	SetPipeline (const std::shared_ptr< Pipeline< ComputePipelineDescriptor > > &pipeline) override
bool	BindResource (ShaderStage stage, DescriptorType type, const ShaderUniformSlot &slot, const ShaderMetadata &metadata, BufferView view) override
bool	BindResource (ShaderStage stage, DescriptorType type, const SampledImageSlot &slot, const ShaderMetadata &metadata, std::shared_ptr< const Texture > texture, const std::unique_ptr< const Sampler > &sampler) override
bool	EncodeCommands () const override
	Encode the recorded commands to the underlying command buffer.
void	AddBufferMemoryBarrier () override
	Ensures all previously encoded compute command's buffer writes are visible to any subsequent compute commands.
void	AddTextureMemoryBarrier () override
	Ensures all previously encoded compute command's texture writes are visible to any subsequent compute commands.

Friends
class	CommandBufferMTL

Additional Inherited Members
Protected Member Functions inherited from impeller::ComputePass
	ComputePass (std::shared_ptr< const Context > context)
Protected Attributes inherited from impeller::ComputePass
const std::shared_ptr< const Context >	context_

Detailed Description

Definition at line 17 of file compute_pass_mtl.h.

Constructor & Destructor Documentation

~ComputePassMTL()

impeller::ComputePassMTL::~ComputePassMTL ( )

overridedefault

Member Function Documentation

AddBufferMemoryBarrier()

void impeller::ComputePassMTL::AddBufferMemoryBarrier ( )

overrideprivatevirtual

Ensures all previously encoded compute command's buffer writes are visible to any subsequent compute commands.

On Vulkan, it does not matter if the compute command is in a different command buffer, only that it is executed later in queue order.

Implements impeller::ComputePass.

Definition at line 72 of file compute_pass_mtl.mm.

                                            {
  [encoder_ memoryBarrierWithScope:MTLBarrierScopeBuffers];
}

AddTextureMemoryBarrier()

void impeller::ComputePassMTL::AddTextureMemoryBarrier ( )

overrideprivatevirtual

Ensures all previously encoded compute command's texture writes are visible to any subsequent compute commands.

On Vulkan, it does not matter if the compute command is in a different command buffer, only that it is executed later in queue order.

Implements impeller::ComputePass.

Definition at line 77 of file compute_pass_mtl.mm.

                                             {
  [encoder_ memoryBarrierWithScope:MTLBarrierScopeTextures];
}

BindResource() [1/2]

bool impeller::ComputePassMTL::BindResource ( ShaderStage  stage, DescriptorType  type, const SampledImageSlot &  slot, const ShaderMetadata &  metadata, std::shared_ptr< const Texture >  texture, const std::unique_ptr< const Sampler > &  sampler  )

overrideprivatevirtual

Implements impeller::ResourceBinder.

Definition at line 107 of file compute_pass_mtl.mm.

                                                 {
  if (!sampler || !texture->IsValid()) {
    return false;
  }
 
  pass_bindings_cache_.SetTexture(slot.texture_index,
                                  TextureMTL::Cast(*texture).GetMTLTexture());
  pass_bindings_cache_.SetSampler(
      slot.texture_index, SamplerMTL::Cast(*sampler).GetMTLSamplerState());
  return true;
}

BindResource() [2/2]

bool impeller::ComputePassMTL::BindResource ( ShaderStage  stage, DescriptorType  type, const ShaderUniformSlot &  slot, const ShaderMetadata &  metadata, BufferView  view  )

overrideprivatevirtual

Implements impeller::ResourceBinder.

Definition at line 82 of file compute_pass_mtl.mm.

                                                   {
  if (!view.buffer) {
    return false;
  }
 
  const std::shared_ptr<const DeviceBuffer>& device_buffer = view.buffer;
  if (!device_buffer) {
    return false;
  }
 
  id<MTLBuffer> buffer = DeviceBufferMTL::Cast(*device_buffer).GetMTLBuffer();
  // The Metal call is a void return and we don't want to make it on nil.
  if (!buffer) {
    return false;
  }
 
  pass_bindings_cache_.SetBuffer(slot.ext_res_0, view.range.offset, buffer);
  return true;
}

Compute()

fml::Status impeller::ComputePassMTL::Compute ( const ISize &  grid_size )

overrideprivatevirtual

Implements impeller::ComputePass.

Definition at line 125 of file compute_pass_mtl.mm.

                                                        {
  if (grid_size.IsEmpty()) {
    return fml::Status(fml::StatusCode::kUnknown,
                       "Invalid grid size for compute command.");
  }
  // TODO(dnfield): use feature detection to support non-uniform threadgroup
  // sizes.
  // https://github.com/flutter/flutter/issues/110619
  auto width = grid_size.width;
  auto height = grid_size.height;
 
  auto max_total_threads_per_threadgroup = static_cast<int64_t>(
      pass_bindings_cache_.GetPipeline().maxTotalThreadsPerThreadgroup);
 
  // Special case for linear processing.
  if (height == 1) {
    int64_t thread_groups = std::max(
        static_cast<int64_t>(
            std::ceil(width * 1.0 / max_total_threads_per_threadgroup * 1.0)),
        1LL);
    [encoder_
         dispatchThreadgroups:MTLSizeMake(thread_groups, 1, 1)
        threadsPerThreadgroup:MTLSizeMake(max_total_threads_per_threadgroup, 1,
                                          1)];
  } else {
    while (width * height > max_total_threads_per_threadgroup) {
      width = std::max(1LL, width / 2);
      height = std::max(1LL, height / 2);
    }
 
    auto size = MTLSizeMake(width, height, 1);
    [encoder_ dispatchThreadgroups:size threadsPerThreadgroup:size];
  }
 
#ifdef IMPELLER_DEBUG
  if (has_label_) {
    [encoder_ popDebugGroup];
  }
  has_label_ = false;
#endif  // IMPELLER_DEBUG
  return fml::Status();
}

EncodeCommands()

bool impeller::ComputePassMTL::EncodeCommands ( ) const

overrideprivatevirtual

Encode the recorded commands to the underlying command buffer.

Returns

If the commands were encoded to the underlying command buffer.

Implements impeller::ComputePass.

Definition at line 168 of file compute_pass_mtl.mm.

                                          {
  [encoder_ endEncoding];
  return true;
}

IsValid()

bool impeller::ComputePassMTL::IsValid ( ) const

overrideprivatevirtual

Implements impeller::ComputePass.

Definition at line 46 of file compute_pass_mtl.mm.

                                   {
  return is_valid_;
}

OnSetLabel()

void impeller::ComputePassMTL::OnSetLabel ( const std::string &  label )

overrideprivatevirtual

Implements impeller::ComputePass.

Definition at line 50 of file compute_pass_mtl.mm.

                                                      {
#ifdef IMPELLER_DEBUG
  if (label.empty()) {
    return;
  }
  [encoder_ setLabel:@(label.c_str())];
#endif  // IMPELLER_DEBUG
}

SetCommandLabel()

void impeller::ComputePassMTL::SetCommandLabel ( std::string_view  label )

overrideprivatevirtual

Implements impeller::ComputePass.

Definition at line 59 of file compute_pass_mtl.mm.

                                                         {
  has_label_ = true;
  [encoder_ pushDebugGroup:@(label.data())];
}

SetPipeline()

void impeller::ComputePassMTL::SetPipeline ( const std::shared_ptr< Pipeline< ComputePipelineDescriptor > > &  pipeline )

overrideprivatevirtual

Implements impeller::ComputePass.

Definition at line 65 of file compute_pass_mtl.mm.

                                                                        {
  pass_bindings_cache_.SetComputePipelineState(
      ComputePipelineMTL::Cast(*pipeline).GetMTLComputePipelineState());
}

Friends And Related Symbol Documentation

CommandBufferMTL

friend class CommandBufferMTL

friend

Definition at line 23 of file compute_pass_mtl.h.

---

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

• impeller/renderer/backend/metal/compute_pass_mtl.h
• impeller/renderer/backend/metal/compute_pass_mtl.mm