Compute passes encode compute shader into the underlying command buffer. More...

#include <compute_pass.h>

Inheritance diagram for impeller::ComputePass:

Public Member Functions
virtual	~ComputePass ()

virtual bool	IsValid () const =0

void	SetLabel (const std::string &label)

void	SetGridSize (const ISize &size)

void	SetThreadGroupSize (const ISize &size)

HostBuffer &	GetTransientsBuffer ()

bool	AddCommand (ComputeCommand command)
	Record a command for subsequent encoding to the underlying command buffer. No work is encoded into the command buffer at this time. More...

bool	EncodeCommands () const
	Encode the recorded commands to the underlying command buffer. More...

Protected Member Functions
	ComputePass (std::weak_ptr< const Context > context)

virtual void	OnSetLabel (const std::string &label)=0

virtual bool	OnEncodeCommands (const Context &context, const ISize &grid_size, const ISize &thread_group_size) const =0

Protected Attributes
const std::weak_ptr< const Context >	context_

std::vector< ComputeCommand >	commands_

Detailed Description

Compute passes encode compute shader into the underlying command buffer.

See also: CommandBuffer

Definition at line 25 of file compute_pass.h.

Constructor & Destructor Documentation

◆ ~ComputePass()

impeller::ComputePass::~ComputePass ( )

virtualdefault

◆ ComputePass()

impeller::ComputePass::ComputePass ( std::weak_ptr< const Context > context )

explicitprotected

Definition at line 14 of file compute_pass.cc.

15 : context_(std::move(context)), transients_buffer_(HostBuffer::Create()) {}

Member Function Documentation

◆ AddCommand()

bool impeller::ComputePass::AddCommand ( ComputeCommand command )

Record a command for subsequent encoding to the underlying command buffer. No work is encoded into the command buffer at this time.

Parameters

[in] command The command

Returns: If the command was valid for subsequent commitment.

Definition at line 39 of file compute_pass.cc.

                                                    {
   if (!command) {
     VALIDATION_LOG
         << "Attempted to add an invalid command to the compute pass.";
     return false;
   }
  
   commands_.emplace_back(std::move(command));
   return true;
 }

References commands_, and VALIDATION_LOG.

◆ EncodeCommands()

bool impeller::ComputePass::EncodeCommands ( ) const

Encode the recorded commands to the underlying command buffer.

Parameters

transients_allocator The transients allocator.

Returns: If the commands were encoded to the underlying command buffer.

Definition at line 50 of file compute_pass.cc.

                                        {
   if (grid_size_.IsEmpty() || thread_group_size_.IsEmpty()) {
     FML_DLOG(WARNING) << "Attempted to encode a compute pass with an empty "
                          "grid or thread group size.";
     return false;
   }
   auto context = context_.lock();
   // The context could have been collected in the meantime.
   if (!context) {
     return false;
   }
   return OnEncodeCommands(*context, grid_size_, thread_group_size_);
 }

References context_, impeller::TSize< T >::IsEmpty(), and OnEncodeCommands().

◆ GetTransientsBuffer()

HostBuffer & impeller::ComputePass::GetTransientsBuffer ( )

Definition at line 19 of file compute_pass.cc.

                                              {
   return *transients_buffer_;
 }

◆ IsValid()

virtual bool impeller::ComputePass::IsValid ( ) const

pure virtual

◆ OnEncodeCommands()

virtual bool impeller::ComputePass::OnEncodeCommands	(	const Context &	context,
		const ISize &	grid_size,
		const ISize &	thread_group_size
	)		const

protectedpure virtual

Referenced by EncodeCommands().

◆ OnSetLabel()

virtual void impeller::ComputePass::OnSetLabel ( const std::string & label )

protectedpure virtual

Referenced by SetLabel().

◆ SetGridSize()

void impeller::ComputePass::SetGridSize ( const ISize & size )

Definition at line 31 of file compute_pass.cc.

                                                {
   grid_size_ = size;
 }

◆ SetLabel()

void impeller::ComputePass::SetLabel ( const std::string & label )

Definition at line 23 of file compute_pass.cc.

                                                  {
   if (label.empty()) {
     return;
   }
   transients_buffer_->SetLabel(SPrintF("%s Transients", label.c_str()));
   OnSetLabel(label);
 }

References OnSetLabel(), and impeller::SPrintF().

◆ SetThreadGroupSize()

void impeller::ComputePass::SetThreadGroupSize ( const ISize & size )

Definition at line 35 of file compute_pass.cc.

                                                       {
   thread_group_size_ = size;
 }

Member Data Documentation

◆ commands_

std::vector<ComputeCommand> impeller::ComputePass::commands_

protected

Definition at line 62 of file compute_pass.h.

Referenced by AddCommand().

◆ context_

const std::weak_ptr<const Context> impeller::ComputePass::context_