impeller::DeviceBufferMTL Class Reference

#include <device_buffer_mtl.h>

Inheritance diagram for impeller::DeviceBufferMTL:

Public Member Functions
	DeviceBufferMTL ()
	~DeviceBufferMTL () override
id< MTLBuffer >	GetMTLBuffer () const
Public Member Functions inherited from impeller::DeviceBuffer
virtual	~DeviceBuffer ()
bool	CopyHostBuffer (const uint8_t *source, Range source_range, size_t offset=0u)
const DeviceBufferDescriptor &	GetDeviceBufferDescriptor () const
virtual void	Invalidate (std::optional< Range > range=std::nullopt) const

Private Member Functions
uint8_t *	OnGetContents () const override
std::shared_ptr< Texture >	AsTexture (Allocator &allocator, const TextureDescriptor &descriptor, uint16_t row_bytes) const override
bool	OnCopyHostBuffer (const uint8_t *source, Range source_range, size_t offset) override
bool	SetLabel (const std::string &label) override
bool	SetLabel (const std::string &label, Range range) override
void	Flush (std::optional< Range > range) const override

Friends
class	AllocatorMTL

Additional Inherited Members
Static Public Member Functions inherited from impeller::DeviceBuffer
static BufferView	AsBufferView (std::shared_ptr< DeviceBuffer > buffer)
	Create a buffer view of this entire buffer.
Static Public Member Functions inherited from impeller::BackendCast< DeviceBufferMTL, DeviceBuffer >
static DeviceBufferMTL &	Cast (DeviceBuffer &base)
static const DeviceBufferMTL &	Cast (const DeviceBuffer &base)
static DeviceBufferMTL *	Cast (DeviceBuffer *base)
static const DeviceBufferMTL *	Cast (const DeviceBuffer *base)
Protected Member Functions inherited from impeller::DeviceBuffer
	DeviceBuffer (DeviceBufferDescriptor desc)
Protected Attributes inherited from impeller::DeviceBuffer
const DeviceBufferDescriptor	desc_

Detailed Description

Definition at line 16 of file device_buffer_mtl.h.

Constructor & Destructor Documentation

DeviceBufferMTL()

impeller::DeviceBufferMTL::DeviceBufferMTL

(

)

~DeviceBufferMTL()

impeller::DeviceBufferMTL::~DeviceBufferMTL ( )

overridedefault

Member Function Documentation

AsTexture()

std::shared_ptr< Texture > impeller::DeviceBufferMTL::AsTexture ( Allocator &  allocator, const TextureDescriptor &  descriptor, uint16_t  row_bytes  ) const

overrideprivatevirtual

Reimplemented from impeller::DeviceBuffer.

Definition at line 32 of file device_buffer_mtl.mm.

                              {
  auto mtl_texture_desc = ToMTLTextureDescriptor(descriptor);
 
  if (!mtl_texture_desc) {
    VALIDATION_LOG << "Texture descriptor was invalid.";
    return nullptr;
  }
 
  if (@available(iOS 13.0, macos 10.15, *)) {
    mtl_texture_desc.resourceOptions = buffer_.resourceOptions;
  }
 
  auto texture = [buffer_ newTextureWithDescriptor:mtl_texture_desc
                                            offset:0
                                       bytesPerRow:row_bytes];
  if (!texture) {
    return nullptr;
  }
  return TextureMTL::Create(descriptor, texture);
}

Flush()

void impeller::DeviceBufferMTL::Flush ( std::optional< Range >  range ) const

overrideprivatevirtual

Make any pending writes visible to the GPU.

This method must be called if the device pointer provided by [OnGetContents] is written to without using [CopyHostBuffer]. On Devices with coherent host memory, this method will not perform extra work.

If the range is not provided, the entire buffer is flushed.

Reimplemented from impeller::DeviceBuffer.

Definition at line 81 of file device_buffer_mtl.mm.

                                                          {
#if !FML_OS_IOS
  auto flush_range = range.value_or(Range{0, GetDeviceBufferDescriptor().size});
  if (storage_mode_ == MTLStorageModeManaged) {
    [buffer_
        didModifyRange:NSMakeRange(flush_range.offset, flush_range.length)];
  }
#endif
}

GetMTLBuffer()

id< MTLBuffer > impeller::DeviceBufferMTL::GetMTLBuffer

(

)

const

Definition at line 21 of file device_buffer_mtl.mm.

                                                  {
  return buffer_;
}

OnCopyHostBuffer()

bool impeller::DeviceBufferMTL::OnCopyHostBuffer ( const uint8_t *  source, Range  source_range, size_t  offset  )

overrideprivatevirtual

Implements impeller::DeviceBuffer.

Definition at line 56 of file device_buffer_mtl.mm.

                                                                    {
  auto dest = static_cast<uint8_t*>(buffer_.contents);
 
  if (!dest) {
    return false;
  }
 
  if (source) {
    ::memmove(dest + offset, source + source_range.offset, source_range.length);
  }
 
// MTLStorageModeManaged is never present on always returns false on iOS. But
// the compiler is mad that `didModifyRange:` appears in a TU meant for iOS. So,
// just compile it away.
#if !FML_OS_IOS
  if (storage_mode_ == MTLStorageModeManaged) {
    [buffer_ didModifyRange:NSMakeRange(offset, source_range.length)];
  }
#endif
 
  return true;
}

OnGetContents()

uint8_t * impeller::DeviceBufferMTL::OnGetContents ( ) const

overrideprivatevirtual

Implements impeller::DeviceBuffer.

Definition at line 25 of file device_buffer_mtl.mm.

                                              {
  if (storage_mode_ != MTLStorageModeShared) {
    return nullptr;
  }
  return reinterpret_cast<uint8_t*>(buffer_.contents);
}

SetLabel() [1/2]

bool impeller::DeviceBufferMTL::SetLabel ( const std::string &  label )

overrideprivatevirtual

Implements impeller::DeviceBuffer.

Definition at line 91 of file device_buffer_mtl.mm.

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

SetLabel() [2/2]

bool impeller::DeviceBufferMTL::SetLabel ( const std::string &  label, Range  range  )

overrideprivatevirtual

Implements impeller::DeviceBuffer.

Definition at line 99 of file device_buffer_mtl.mm.

                                                                  {
  if (label.empty()) {
    return false;
  }
  [buffer_ addDebugMarker:@(label.c_str())
                    range:NSMakeRange(range.offset, range.length)];
  return true;
}

Friends And Related Symbol Documentation

AllocatorMTL

friend class AllocatorMTL

friend

Definition at line 28 of file device_buffer_mtl.h.

---

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

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