impeller::DeviceBuffer Class Reference

#include <device_buffer.h>

Inheritance diagram for impeller::DeviceBuffer:

Public Member Functions
virtual	~DeviceBuffer ()
bool	CopyHostBuffer (const uint8_t *source, Range source_range, size_t offset=0u)
virtual bool	SetLabel (const std::string &label)=0
virtual bool	SetLabel (const std::string &label, Range range)=0
virtual std::shared_ptr< Texture >	AsTexture (Allocator &allocator, const TextureDescriptor &descriptor, uint16_t row_bytes) const
const DeviceBufferDescriptor &	GetDeviceBufferDescriptor () const
virtual uint8_t *	OnGetContents () const =0
virtual void	Flush (std::optional< Range > range=std::nullopt) const
virtual void	Invalidate (std::optional< Range > range=std::nullopt) const

Static Public Member Functions
static BufferView	AsBufferView (std::shared_ptr< DeviceBuffer > buffer)
	Create a buffer view of this entire buffer.

Protected Member Functions
	DeviceBuffer (DeviceBufferDescriptor desc)
virtual bool	OnCopyHostBuffer (const uint8_t *source, Range source_range, size_t offset)=0

Protected Attributes
const DeviceBufferDescriptor	desc_

Detailed Description

Definition at line 19 of file device_buffer.h.

Constructor & Destructor Documentation

~DeviceBuffer()

impeller::DeviceBuffer::~DeviceBuffer ( )

virtualdefault

DeviceBuffer()

impeller::DeviceBuffer::DeviceBuffer ( DeviceBufferDescriptor  desc )

explicitprotected

Definition at line 9 of file device_buffer.cc.

: desc_(desc) {}

Member Function Documentation

AsBufferView()

BufferView impeller::DeviceBuffer::AsBufferView ( std::shared_ptr< DeviceBuffer >  buffer )

static

Create a buffer view of this entire buffer.

Definition at line 18 of file device_buffer.cc.

                                                                        {
  BufferView view;
  view.buffer = std::move(buffer);
  view.range = {0u, view.buffer->desc_.size};
  return view;
}

AsTexture()

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

virtual

Reimplemented in impeller::DeviceBufferMTL, and impeller::TestImpellerDeviceBuffer.

Definition at line 25 of file device_buffer.cc.

                              {
  auto texture = allocator.CreateTexture(descriptor);
  if (!texture) {
    return nullptr;
  }
  if (!texture->SetContents(std::make_shared<fml::NonOwnedMapping>(
          OnGetContents(), desc_.size))) {
    return nullptr;
  }
  return texture;
}

CopyHostBuffer()

bool impeller::DeviceBuffer::CopyHostBuffer	(	const uint8_t *	source,
		Range	source_range,
		size_t	offset = 0u
	)

Definition at line 44 of file device_buffer.cc.

                                                               {
  if (source_range.length == 0u) {
    // Nothing to copy. Bail.
    return true;
  }
 
  if (source == nullptr) {
    // Attempted to copy data from a null buffer.
    return false;
  }
 
  if (desc_.storage_mode != StorageMode::kHostVisible) {
    // One of the storage modes where a transfer queue must be used.
    return false;
  }
 
  if (offset + source_range.length > desc_.size) {
    // Out of bounds of this buffer.
    return false;
  }
 
  return OnCopyHostBuffer(source, source_range, offset);
}

Flush()

void impeller::DeviceBuffer::Flush ( std::optional< Range >  range = std::nullopt ) const

virtual

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 in impeller::DeviceBufferMTL, impeller::DeviceBufferVK, and impeller::DeviceBufferGLES.

Definition at line 13 of file device_buffer.cc.

{}

GetDeviceBufferDescriptor()

const DeviceBufferDescriptor & impeller::DeviceBuffer::GetDeviceBufferDescriptor

(

)

const

Definition at line 40 of file device_buffer.cc.

                                                                            {
  return desc_;
}

Invalidate()

void impeller::DeviceBuffer::Invalidate ( std::optional< Range >  range = std::nullopt ) const

virtual

Reimplemented in impeller::DeviceBufferVK.

Definition at line 15 of file device_buffer.cc.

{}

OnCopyHostBuffer()

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

protectedpure virtual

Implemented in impeller::DeviceBufferGLES, impeller::DeviceBufferMTL, impeller::DeviceBufferVK, and impeller::TestImpellerDeviceBuffer.

OnGetContents()

virtual uint8_t * impeller::DeviceBuffer::OnGetContents ( ) const

pure virtual

Implemented in impeller::DeviceBufferGLES, impeller::DeviceBufferMTL, impeller::DeviceBufferVK, and impeller::TestImpellerDeviceBuffer.

SetLabel() [1/2]

virtual bool impeller::DeviceBuffer::SetLabel ( const std::string &  label )

pure virtual

Implemented in impeller::DeviceBufferGLES, impeller::DeviceBufferMTL, impeller::DeviceBufferVK, and impeller::TestImpellerDeviceBuffer.

SetLabel() [2/2]

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

pure virtual

Implemented in impeller::DeviceBufferGLES, impeller::DeviceBufferMTL, impeller::DeviceBufferVK, and impeller::TestImpellerDeviceBuffer.

Member Data Documentation

desc_

const DeviceBufferDescriptor impeller::DeviceBuffer::desc_

protected

Definition at line 55 of file device_buffer.h.

---

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

• impeller/core/device_buffer.h
• impeller/core/device_buffer.cc