Struct BufferVec 

pub struct BufferVec<T: BufferVecItem> { /* private fields */ }

The advanced buffer object that could be used as a vector

Implementations

impl<T> BufferVec<T>

where T: BufferVecItem,

pub fn new( device: Arc<VulkanDevice>, usage: VkBufferUsageFlags, ) -> Result<Self, VulkanError>

Create the BufferVec<T>

pub fn get_device(&self) -> Arc<VulkanDevice>

Get the device

pub fn from( device: Arc<VulkanDevice>, data: &[T], cmdbuf: VkCommandBuffer, usage: VkBufferUsageFlags, ) -> Result<Self, VulkanError>

Create from a slice of data

pub fn with_capacity( device: Arc<VulkanDevice>, capacity: usize, usage: VkBufferUsageFlags, ) -> Result<Self, VulkanError>

Create the BufferVec<T> with an initial capacity

pub fn change_capacity( &mut self, new_capacity: usize, ) -> Result<(), VulkanError>

Change the capacity

• If the capacity is less than the current items, the number of items will be reduced to the new capacity.

pub unsafe fn set_data_modified( &mut self, first_index: usize, length: usize, flag: bool, )

Set data is modified or not

Safety

This would change the behavior of how flush does to the data. The data marked as modified will be uploaded to the device, while the data marked as unmodified maybe uploaded to the device, or not (skipped because the gap is long enough) You are going to control which part of the data will be synchronized to the device, while you are not actually knowing if the data is really changed.

• first_index: Which part of the data you are going to mark.
• length: From the index, how many items you are going to mark.
• flag: The boolean value of the mark, true means the data is marked as changed and will be synchronized to the device after next flush was called, false means the data is unchanged and will not be synchronized to the device.

Panic

Panic if the index and range is out of bounds

pub unsafe fn set_len(&mut self, new_len: usize)

Change the length Forces the length of the vector to new_len.

This is a low-level operation that maintains none of the normal invariants of the type.

Safety

new_len must be less than or equal to capacity(). The elements at old_len..new_len must be initialized.

pub fn into_inner(self) -> Buffer

Get the inner buffer

pub unsafe fn from_raw_parts( buffer: Buffer, length: usize, ) -> Result<Self, VulkanError>

Creates a BufferVec<T> directly from a buffer, a length, and a capacity.

Safety

This is highly unsafe, just like the Rust official Vec<T>::from_raw_parts()

• Unlike the Rust official Vec<T>::from_raw_parts(), capacity is not needed to be provided since it was calculated by buffer.get_size() / size_of::<T>()
• length must be less than the calculated capacity.

pub fn push(&mut self, data: T) -> Result<(), VulkanError>

Push data to the buffer

pub fn pop(&mut self) -> T

Pop data from the buffer

pub fn remove(&mut self, index: usize) -> T

Removes and returns the element at position index within the vector, shifting all elements after it to the left.

Note: Because this shifts over the remaining elements, it has a worst-case performance of O(n). If you don’t need the order of elements to be preserved, use swap_remove instead.

Panics

Panics if index is out of bounds.

pub fn swap_remove(&mut self, index: usize) -> T

Removes an element from the vector and returns it.

The removed element is replaced by the last element of the vector.

This does not preserve ordering of the remaining elements, but is O(1). If you need to preserve the element order, use remove instead.

Panics

Panics if index is out of bounds.

pub fn resize(&mut self, new_len: usize, new_data: T) -> Result<(), VulkanError>

Resize the buffer

pub fn clear(&mut self)

Clear the buffer

pub fn get_capacity(&self) -> usize

Get the capacity

pub fn len(&self) -> usize

Get num items in the buffer

pub fn is_empty(&self) -> bool

Get is the buffer empty?

pub fn shrink_to_fit(&mut self) -> Result<(), VulkanError>

Shrink to fit

pub fn flush(&mut self, cmdbuf: VkCommandBuffer) -> Result<(), VulkanError>

Flush the staging buffer to the device memory

Trait Implementations

impl<T> BufferForDraw<T> for BufferVec<T>

where T: BufferVecItem,

fn create( device: Arc<VulkanDevice>, data: &[T], cmdbuf: VkCommandBuffer, usage: VkBufferUsageFlags, ) -> Result<Self, VulkanError>

Used to create the buffer

fn get_vk_buffer(&self) -> VkBuffer

Must be able to get the VkBuffer handle

fn get_device(&self) -> Arc<VulkanDevice>

Get the device

fn set_data(&mut self, data: &[T]) -> Result<(), VulkanError>

Set data to be flushed

fn flush(&mut self, cmdbuf: VkCommandBuffer) -> Result<(), VulkanError>

Flush staging buffer data to GPU

fn len(&self) -> usize

Get the number of the items in the buffer

fn convert_to_buffer_vec(self) -> BufferVec<T>

Convert to BufferVec<T>

fn convert_to_buffer_with_type(self) -> BufferWithType<T>

Convert to BufferWithType<T>

fn discard_staging_buffer(&self)

Discard staging buffer if the buffer’s staging buffer is discardable

fn is_empty(&self) -> bool

Check if the buffer is empty

impl<T> Clone for BufferVec<T>

where T: BufferVecItem,

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T> Debug for BufferVec<T>

where T: BufferVecItem,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T> Index<Range<usize>> for BufferVec<T>

where T: BufferVecItem,

type Output = [T]

The returned type after indexing.

fn index(&self, range: Range<usize>) -> &[T]

Performs the indexing (container[index]) operation.

impl<T> Index<RangeFrom<usize>> for BufferVec<T>

where T: BufferVecItem,

type Output = [T]

The returned type after indexing.

fn index(&self, range: RangeFrom<usize>) -> &[T]

Performs the indexing (container[index]) operation.

impl<T> Index<RangeFull> for BufferVec<T>

where T: BufferVecItem,

type Output = [T]

The returned type after indexing.

fn index(&self, _: RangeFull) -> &[T]

Performs the indexing (container[index]) operation.

impl<T> Index<RangeInclusive<usize>> for BufferVec<T>

where T: BufferVecItem,

type Output = [T]

The returned type after indexing.

fn index(&self, range: RangeInclusive<usize>) -> &[T]

Performs the indexing (container[index]) operation.

impl<T> Index<RangeTo<usize>> for BufferVec<T>

where T: BufferVecItem,

type Output = [T]

The returned type after indexing.

fn index(&self, range: RangeTo<usize>) -> &[T]

Performs the indexing (container[index]) operation.

impl<T> Index<RangeToInclusive<usize>> for BufferVec<T>

where T: BufferVecItem,

type Output = [T]

The returned type after indexing.

fn index(&self, range: RangeToInclusive<usize>) -> &[T]

Performs the indexing (container[index]) operation.

impl<T> Index<usize> for BufferVec<T>

where T: BufferVecItem,

type Output = T

The returned type after indexing.

fn index(&self, index: usize) -> &T

Performs the indexing (container[index]) operation.

impl<T> IndexMut<Range<usize>> for BufferVec<T>

where T: BufferVecItem,

fn index_mut(&mut self, range: Range<usize>) -> &mut [T]

Performs the mutable indexing (container[index]) operation.

impl<T> IndexMut<RangeFrom<usize>> for BufferVec<T>

where T: BufferVecItem,

fn index_mut(&mut self, range: RangeFrom<usize>) -> &mut [T]

Performs the mutable indexing (container[index]) operation.

impl<T> IndexMut<RangeFull> for BufferVec<T>

where T: BufferVecItem,

fn index_mut(&mut self, _: RangeFull) -> &mut [T]

Performs the mutable indexing (container[index]) operation.

impl<T> IndexMut<RangeInclusive<usize>> for BufferVec<T>

where T: BufferVecItem,

fn index_mut(&mut self, range: RangeInclusive<usize>) -> &mut [T]

Performs the mutable indexing (container[index]) operation.

impl<T> IndexMut<RangeTo<usize>> for BufferVec<T>

where T: BufferVecItem,

fn index_mut(&mut self, range: RangeTo<usize>) -> &mut [T]

Performs the mutable indexing (container[index]) operation.

impl<T> IndexMut<RangeToInclusive<usize>> for BufferVec<T>

where T: BufferVecItem,

fn index_mut(&mut self, range: RangeToInclusive<usize>) -> &mut [T]

Performs the mutable indexing (container[index]) operation.

impl<T> IndexMut<usize> for BufferVec<T>

where T: BufferVecItem,

fn index_mut(&mut self, index: usize) -> &mut T

Performs the mutable indexing (container[index]) operation.

impl<T> Send for BufferVec<T>

where T: BufferVecItem,

impl<T> Sync for BufferVec<T>

where T: BufferVecItem,