impeller::BlitPassMTL Class Reference

#include <blit_pass_mtl.h>

Inheritance diagram for impeller::BlitPassMTL:

Public Member Functions
	~BlitPassMTL () override
Public Member Functions inherited from impeller::BlitPass
virtual	~BlitPass ()
void	SetLabel (std::string label)
bool	AddCopy (std::shared_ptr< Texture > source, std::shared_ptr< Texture > destination, std::optional< IRect > source_region=std::nullopt, IPoint destination_origin={}, std::string label="")
	Record a command to copy the contents of one texture to another texture. The blit area is limited by the intersection of the texture coverage with respect the source region and destination origin. No work is encoded into the command buffer at this time.
bool	AddCopy (std::shared_ptr< Texture > source, std::shared_ptr< DeviceBuffer > destination, std::optional< IRect > source_region=std::nullopt, size_t destination_offset=0, std::string label="")
	Record a command to copy the contents of the buffer to the texture. No work is encoded into the command buffer at this time.
bool	AddCopy (BufferView source, std::shared_ptr< Texture > destination, IPoint destination_origin={}, std::string label="")
	Record a command to copy the contents of the buffer to the texture. No work is encoded into the command buffer at this time.
bool	GenerateMipmap (std::shared_ptr< Texture > texture, std::string label="")
	Record a command to generate all mip levels for a texture. No work is encoded into the command buffer at this time.

Private Member Functions
bool	IsValid () const override
void	OnSetLabel (std::string label) override
bool	EncodeCommands (const std::shared_ptr< Allocator > &transients_allocator) const override
	Encode the recorded commands to the underlying command buffer.
bool	OnCopyTextureToTextureCommand (std::shared_ptr< Texture > source, std::shared_ptr< Texture > destination, IRect source_region, IPoint destination_origin, std::string label) override
bool	OnCopyTextureToBufferCommand (std::shared_ptr< Texture > source, std::shared_ptr< DeviceBuffer > destination, IRect source_region, size_t destination_offset, std::string label) override
bool	OnCopyBufferToTextureCommand (BufferView source, std::shared_ptr< Texture > destination, IPoint destination_origin, std::string label) override
bool	OnGenerateMipmapCommand (std::shared_ptr< Texture > texture, std::string label) override

Friends
class	CommandBufferMTL

Additional Inherited Members
Protected Member Functions inherited from impeller::BlitPass
	BlitPass ()

Detailed Description

Definition at line 16 of file blit_pass_mtl.h.

Constructor & Destructor Documentation

~BlitPassMTL()

impeller::BlitPassMTL::~BlitPassMTL ( )

overridedefault

Member Function Documentation

EncodeCommands()

bool impeller::BlitPassMTL::EncodeCommands ( const std::shared_ptr< Allocator > &  transients_allocator ) const

overrideprivatevirtual

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.

Implements impeller::BlitPass.

Definition at line 47 of file blit_pass_mtl.mm.

                                                                {
  TRACE_EVENT0("impeller", "BlitPassMTL::EncodeCommands");
  if (!IsValid()) {
    return false;
  }
 
  auto blit_command_encoder = [buffer_ blitCommandEncoder];
 
  if (!blit_command_encoder) {
    return false;
  }
 
  if (!label_.empty()) {
    [blit_command_encoder setLabel:@(label_.c_str())];
  }
 
  // Success or failure, the pass must end. The buffer can only process one pass
  // at a time.
  fml::ScopedCleanupClosure auto_end(
      [blit_command_encoder]() { [blit_command_encoder endEncoding]; });
 
  return EncodeCommands(blit_command_encoder);
}

IsValid()

bool impeller::BlitPassMTL::IsValid ( ) const

overrideprivatevirtual

Implements impeller::BlitPass.

Definition at line 36 of file blit_pass_mtl.mm.

                                {
  return is_valid_;
}

OnCopyBufferToTextureCommand()

bool impeller::BlitPassMTL::OnCopyBufferToTextureCommand ( BufferView  source, std::shared_ptr< Texture >  destination, IPoint  destination_origin, std::string  label  )

overrideprivatevirtual

Implements impeller::BlitPass.

Definition at line 126 of file blit_pass_mtl.mm.

                     {
  auto command = std::make_unique<BlitCopyBufferToTextureCommandMTL>();
  command->label = label;
  command->source = std::move(source);
  command->destination = std::move(destination);
  command->destination_origin = destination_origin;
 
  commands_.emplace_back(std::move(command));
  return true;
}

OnCopyTextureToBufferCommand()

bool impeller::BlitPassMTL::OnCopyTextureToBufferCommand ( std::shared_ptr< Texture >  source, std::shared_ptr< DeviceBuffer >  destination, IRect  source_region, size_t  destination_offset, std::string  label  )

overrideprivatevirtual

Implements impeller::BlitPass.

Definition at line 109 of file blit_pass_mtl.mm.

                     {
  auto command = std::make_unique<BlitCopyTextureToBufferCommandMTL>();
  command->label = label;
  command->source = std::move(source);
  command->destination = std::move(destination);
  command->source_region = source_region;
  command->destination_offset = destination_offset;
 
  commands_.emplace_back(std::move(command));
  return true;
}

OnCopyTextureToTextureCommand()

bool impeller::BlitPassMTL::OnCopyTextureToTextureCommand ( std::shared_ptr< Texture >  source, std::shared_ptr< Texture >  destination, IRect  source_region, IPoint  destination_origin, std::string  label  )

overrideprivatevirtual

Implements impeller::BlitPass.

Definition at line 91 of file blit_pass_mtl.mm.

                     {
  auto command = std::make_unique<BlitCopyTextureToTextureCommandMTL>();
  command->label = label;
  command->source = std::move(source);
  command->destination = std::move(destination);
  command->source_region = source_region;
  command->destination_origin = destination_origin;
 
  commands_.emplace_back(std::move(command));
  return true;
}

OnGenerateMipmapCommand()

bool impeller::BlitPassMTL::OnGenerateMipmapCommand ( std::shared_ptr< Texture >  texture, std::string  label  )

overrideprivatevirtual

Implements impeller::BlitPass.

Definition at line 142 of file blit_pass_mtl.mm.

                                                           {
  auto command = std::make_unique<BlitGenerateMipmapCommandMTL>();
  command->label = label;
  command->texture = std::move(texture);
 
  commands_.emplace_back(std::move(command));
  return true;
}

OnSetLabel()

void impeller::BlitPassMTL::OnSetLabel ( std::string  label )

overrideprivatevirtual

Implements impeller::BlitPass.

Definition at line 40 of file blit_pass_mtl.mm.

                                            {
  if (label.empty()) {
    return;
  }
  label_ = std::move(label);
}

Friends And Related Symbol Documentation

CommandBufferMTL

friend class CommandBufferMTL

friend

Definition at line 22 of file blit_pass_mtl.h.

---

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

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