impeller::CommandBufferMTL Class Reference

#include <command_buffer_mtl.h>

Inheritance diagram for impeller::CommandBufferMTL:

Public Member Functions
	~CommandBufferMTL () override
Public Member Functions inherited from impeller::CommandBuffer
virtual	~CommandBuffer ()
void	WaitUntilScheduled ()
	Force execution of pending GPU commands.
std::shared_ptr< RenderPass >	CreateRenderPass (const RenderTarget &render_target)
	Create a render pass to record render commands into.
std::shared_ptr< BlitPass >	CreateBlitPass ()
	Create a blit pass to record blit commands into.
std::shared_ptr< ComputePass >	CreateComputePass ()
	Create a compute pass to record compute commands into.

Private Member Functions
void	SetLabel (const std::string &label) const override
bool	IsValid () const override
bool	OnSubmitCommands (CompletionCallback callback) override
void	OnWaitUntilScheduled () override
std::shared_ptr< RenderPass >	OnCreateRenderPass (RenderTarget target) override
std::shared_ptr< BlitPass >	OnCreateBlitPass () override
std::shared_ptr< ComputePass >	OnCreateComputePass () override

Friends
class	ContextMTL

Additional Inherited Members
Public Types inherited from impeller::CommandBuffer
enum class	Status { kPending , kError , kCompleted }
using	CompletionCallback = std::function< void(Status)>
Protected Member Functions inherited from impeller::CommandBuffer
	CommandBuffer (std::weak_ptr< const Context > context)
Protected Attributes inherited from impeller::CommandBuffer
std::weak_ptr< const Context >	context_

Detailed Description

Definition at line 16 of file command_buffer_mtl.h.

Constructor & Destructor Documentation

~CommandBufferMTL()

impeller::CommandBufferMTL::~CommandBufferMTL ( )

overridedefault

Member Function Documentation

IsValid()

bool impeller::CommandBufferMTL::IsValid ( ) const

overrideprivatevirtual

Implements impeller::CommandBuffer.

Definition at line 136 of file command_buffer_mtl.mm.

                                     {
  return buffer_ != nil;
}

OnCreateBlitPass()

std::shared_ptr< BlitPass > impeller::CommandBufferMTL::OnCreateBlitPass ( )

overrideprivatevirtual

Implements impeller::CommandBuffer.

Definition at line 206 of file command_buffer_mtl.mm.

                                                           {
  if (!buffer_) {
    return nullptr;
  }
 
  auto pass = std::shared_ptr<BlitPassMTL>(new BlitPassMTL(buffer_));
  if (!pass->IsValid()) {
    return nullptr;
  }
 
  return pass;
}

OnCreateComputePass()

std::shared_ptr< ComputePass > impeller::CommandBufferMTL::OnCreateComputePass ( )

overrideprivatevirtual

Implements impeller::CommandBuffer.

Definition at line 219 of file command_buffer_mtl.mm.

                                                                 {
  if (!buffer_) {
    return nullptr;
  }
  auto context = context_.lock();
  if (!context) {
    return nullptr;
  }
 
  auto pass =
      std::shared_ptr<ComputePassMTL>(new ComputePassMTL(context, buffer_));
  if (!pass->IsValid()) {
    return nullptr;
  }
 
  return pass;
}

OnCreateRenderPass()

std::shared_ptr< RenderPass > impeller::CommandBufferMTL::OnCreateRenderPass ( RenderTarget  target )

overrideprivatevirtual

Implements impeller::CommandBuffer.

Definition at line 187 of file command_buffer_mtl.mm.

                         {
  if (!buffer_) {
    return nullptr;
  }
 
  auto context = context_.lock();
  if (!context) {
    return nullptr;
  }
  auto pass = std::shared_ptr<RenderPassMTL>(
      new RenderPassMTL(context, target, buffer_));
  if (!pass->IsValid()) {
    return nullptr;
  }
 
  return pass;
}

OnSubmitCommands()

bool impeller::CommandBufferMTL::OnSubmitCommands ( CompletionCallback  callback )

overrideprivatevirtual

Implements impeller::CommandBuffer.

Definition at line 160 of file command_buffer_mtl.mm.

                                                                   {
  auto context = context_.lock();
  if (!context) {
    return false;
  }
#ifdef IMPELLER_DEBUG
  ContextMTL::Cast(*context).GetGPUTracer()->RecordCmdBuffer(buffer_);
#endif  // IMPELLER_DEBUG
  if (callback) {
    [buffer_
        addCompletedHandler:^(id<MTLCommandBuffer> buffer) {
          [[maybe_unused]] auto result =
              LogMTLCommandBufferErrorIfPresent(buffer);
          FML_DCHECK(result)
              << "Must not have errors during command buffer submission.";
          callback(ToCommitResult(buffer.status));
        }];
  }
 
  [buffer_ commit];
 
  buffer_ = nil;
  return true;
}

OnWaitUntilScheduled()

void impeller::CommandBufferMTL::OnWaitUntilScheduled ( )

overrideprivatevirtual

Implements impeller::CommandBuffer.

Definition at line 185 of file command_buffer_mtl.mm.

{}

SetLabel()

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

overrideprivatevirtual

Implements impeller::CommandBuffer.

Definition at line 140 of file command_buffer_mtl.mm.

                                                            {
  if (label.empty()) {
    return;
  }
 
  [buffer_ setLabel:@(label.data())];
}

Friends And Related Symbol Documentation

ContextMTL

friend class ContextMTL

friend

Definition at line 22 of file command_buffer_mtl.h.

---

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

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