impeller::BlitCopyTextureToBufferCommandMTL Struct Reference

#include <blit_command_mtl.h>

Inheritance diagram for impeller::BlitCopyTextureToBufferCommandMTL:

Public Member Functions
	~BlitCopyTextureToBufferCommandMTL () override
std::string	GetLabel () const override
bool	Encode (id< MTLBlitCommandEncoder > encoder) const override
Public Member Functions inherited from impeller::BlitEncodeMTL
virtual	~BlitEncodeMTL ()

Additional Inherited Members
Static Public Member Functions inherited from impeller::BackendCast< BlitEncodeMTL, BlitCommand >
static BlitEncodeMTL &	Cast (BlitCommand &base)
static const BlitEncodeMTL &	Cast (const BlitCommand &base)
static BlitEncodeMTL *	Cast (BlitCommand *base)
static const BlitEncodeMTL *	Cast (const BlitCommand *base)
Public Attributes inherited from impeller::BlitCopyTextureToBufferCommand
std::shared_ptr< Texture >	source
std::shared_ptr< DeviceBuffer >	destination
IRect	source_region
size_t	destination_offset
Public Attributes inherited from impeller::BlitCommand
std::string	label

Detailed Description

Definition at line 34 of file blit_command_mtl.h.

Constructor & Destructor Documentation

~BlitCopyTextureToBufferCommandMTL()

impeller::BlitCopyTextureToBufferCommandMTL::~BlitCopyTextureToBufferCommandMTL ( )

overridedefault

Member Function Documentation

Encode()

bool impeller::BlitCopyTextureToBufferCommandMTL::Encode ( id< MTLBlitCommandEncoder >  encoder ) const

overridevirtual

Implements impeller::BlitEncodeMTL.

Definition at line 60 of file blit_command_mtl.mm.

                                             {
  auto source_mtl = TextureMTL::Cast(*source).GetMTLTexture();
  if (!source_mtl) {
    return false;
  }
 
  auto destination_mtl = DeviceBufferMTL::Cast(*destination).GetMTLBuffer();
  if (!destination_mtl) {
    return false;
  }
 
  auto source_origin_mtl =
      MTLOriginMake(source_region.origin.x, source_region.origin.y, 0);
  auto source_size_mtl =
      MTLSizeMake(source_region.size.width, source_region.size.height, 1);
 
  auto destination_bytes_per_pixel =
      BytesPerPixelForPixelFormat(source->GetTextureDescriptor().format);
  auto destination_bytes_per_row =
      source_size_mtl.width * destination_bytes_per_pixel;
  auto destination_bytes_per_image =
      source_size_mtl.height * destination_bytes_per_row;
 
  [encoder copyFromTexture:source_mtl
                   sourceSlice:0
                   sourceLevel:0
                  sourceOrigin:source_origin_mtl
                    sourceSize:source_size_mtl
                      toBuffer:destination_mtl
             destinationOffset:destination_offset
        destinationBytesPerRow:destination_bytes_per_row
      destinationBytesPerImage:destination_bytes_per_image];
 
  return true;
};

References impeller::BytesPerPixelForPixelFormat(), impeller::BackendCast< TextureMTL, Texture >::Cast(), impeller::BackendCast< DeviceBufferMTL, Buffer >::Cast(), impeller::BlitCopyTextureToBufferCommand::destination_offset, impeller::DeviceBufferMTL::GetMTLBuffer(), impeller::TextureMTL::GetMTLTexture(), impeller::TSize< T >::height, impeller::TRect< T >::origin, impeller::TRect< T >::size, impeller::BlitCopyTextureToBufferCommand::source, impeller::BlitCopyTextureToBufferCommand::source_region, impeller::TSize< T >::width, impeller::TPoint< T >::x, and impeller::TPoint< T >::y.

GetLabel()

std::string impeller::BlitCopyTextureToBufferCommandMTL::GetLabel ( ) const

overridevirtual

Implements impeller::BlitEncodeMTL.

Definition at line 56 of file blit_command_mtl.mm.

                                                            {
  return label;
}

References impeller::BlitCommand::label.

---

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

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