impeller::DeviceBufferVK Class Reference

#include <device_buffer_vk.h>

Inheritance diagram for impeller::DeviceBufferVK:

Public Member Functions
	DeviceBufferVK (DeviceBufferDescriptor desc, std::weak_ptr< Context > context, UniqueBufferVMA buffer, VmaAllocationInfo info)
	~DeviceBufferVK () override
vk::Buffer	GetBuffer () const
Public Member Functions inherited from impeller::DeviceBuffer
virtual	~DeviceBuffer ()
bool	CopyHostBuffer (const uint8_t *source, Range source_range, size_t offset=0u)
virtual std::shared_ptr< Texture >	AsTexture (Allocator &allocator, const TextureDescriptor &descriptor, uint16_t row_bytes) const
const DeviceBufferDescriptor &	GetDeviceBufferDescriptor () const

Private Member Functions
uint8_t *	OnGetContents () 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
void	Invalidate (std::optional< Range > range) const override

Friends
class	AllocatorVK

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< DeviceBufferVK, DeviceBuffer >
static DeviceBufferVK &	Cast (DeviceBuffer &base)
static const DeviceBufferVK &	Cast (const DeviceBuffer &base)
static DeviceBufferVK *	Cast (DeviceBuffer *base)
static const DeviceBufferVK *	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 17 of file device_buffer_vk.h.

Constructor & Destructor Documentation

DeviceBufferVK()

impeller::DeviceBufferVK::DeviceBufferVK	(	DeviceBufferDescriptor	desc,
		std::weak_ptr< Context >	context,
		UniqueBufferVMA	buffer,
		VmaAllocationInfo	info
	)

Definition at line 14 of file device_buffer_vk.cc.

    : DeviceBuffer(desc),
      context_(std::move(context)),
      resource_(ContextVK::Cast(*context_.lock().get()).GetResourceManager(),
                BufferResource{
                    std::move(buffer),  //
                    info                //
                }) {}

~DeviceBufferVK()

impeller::DeviceBufferVK::~DeviceBufferVK ( )

overridedefault

Member Function Documentation

Flush()

void impeller::DeviceBufferVK::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 67 of file device_buffer_vk.cc.

                                                         {
  auto flush_range = range.value_or(Range{0, GetDeviceBufferDescriptor().size});
  ::vmaFlushAllocation(resource_->buffer.get().allocator,
                       resource_->buffer.get().allocation, flush_range.offset,
                       flush_range.length);
}

GetBuffer()

vk::Buffer impeller::DeviceBufferVK::GetBuffer

(

)

const

Definition at line 86 of file device_buffer_vk.cc.

                                         {
  return resource_->buffer.get().buffer;
}

Invalidate()

void impeller::DeviceBufferVK::Invalidate ( std::optional< Range >  range ) const

overrideprivatevirtual

Reimplemented from impeller::DeviceBuffer.

Definition at line 74 of file device_buffer_vk.cc.

                                                              {
  auto flush_range = range.value_or(Range{0, GetDeviceBufferDescriptor().size});
  ::vmaInvalidateAllocation(resource_->buffer.get().allocator,
                            resource_->buffer.get().allocation,
                            flush_range.offset, flush_range.length);
}

OnCopyHostBuffer()

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

overrideprivatevirtual

Implements impeller::DeviceBuffer.

Definition at line 32 of file device_buffer_vk.cc.

                                                     {
  uint8_t* dest = OnGetContents();
 
  if (!dest) {
    return false;
  }
 
  if (source) {
    ::memmove(dest + offset, source + source_range.offset, source_range.length);
  }
  ::vmaFlushAllocation(resource_->buffer.get().allocator,
                       resource_->buffer.get().allocation, offset,
                       source_range.length);
 
  return true;
}

OnGetContents()

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

overrideprivatevirtual

Implements impeller::DeviceBuffer.

Definition at line 28 of file device_buffer_vk.cc.

                                             {
  return static_cast<uint8_t*>(resource_->info.pMappedData);
}

SetLabel() [1/2]

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

overrideprivatevirtual

Implements impeller::DeviceBuffer.

Definition at line 51 of file device_buffer_vk.cc.

                                                    {
  auto context = context_.lock();
  if (!context || !resource_->buffer.is_valid()) {
    // The context could have died at this point.
    return false;
  }
 
  ::vmaSetAllocationName(resource_->buffer.get().allocator,   //
                         resource_->buffer.get().allocation,  //
                         label.c_str()                        //
  );
 
  return ContextVK::Cast(*context).SetDebugName(resource_->buffer.get().buffer,
                                                label);
}

SetLabel() [2/2]

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

overrideprivatevirtual

Implements impeller::DeviceBuffer.

Definition at line 81 of file device_buffer_vk.cc.

                                                                 {
  // We do not have the ability to name ranges. Just name the whole thing.
  return SetLabel(label);
}

Friends And Related Symbol Documentation

AllocatorVK

friend class AllocatorVK

friend

Definition at line 31 of file device_buffer_vk.h.

---

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

• impeller/renderer/backend/vulkan/device_buffer_vk.h
• impeller/renderer/backend/vulkan/device_buffer_vk.cc