Struct BufferWithType 

pub struct BufferWithType<T>
where
    T: BufferVecItem,
{ /* private fields */ }

A wrapper for Buffer

Implementations

impl<T> BufferWithType<T>

where T: BufferVecItem,

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

Create the BufferWithType<T>

• cmdbuf: Could be null, thus the staging buffer would not be uploaded immediately.

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

Create the BufferWithType<T>

pub fn new_from_buffer(buffer: Buffer) -> Self

Create the BufferWithType<T>

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

Get the device

pub fn ensure_staging_buffer<'a>( &'a self, ) -> Result<RwLockWriteGuard<'a, Option<StagingBuffer>>, VulkanError>

Create staging buffer for the BufferWithType<T>

pub fn discard_staging_buffer(&self)

Discard the staging buffer to save memory

pub fn get_item(&self, index: usize) -> Option<T>

Get data by an index

pub fn set_item(&self, index: usize, data: T) -> Result<(), VulkanError>

Set data

pub fn get_data(&self) -> Option<&[T]>

Get all data

pub fn map_staging_buffer_as_slice_locked<'a>( &'a self, ) -> Result<BufferMapGuard<'a, T>, VulkanError>

Map as slice

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

Set all data NOTE The buffer will be resized to the exact size of the data, causes the return value of get_vk_buffer to be changed to a new buffer.

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

Upload staging buffer data to buffer

pub fn len(&self) -> usize

Get the count of the data

pub fn is_empty(&self) -> bool

Get if the buffer is empty

pub fn into_inner(self) -> Buffer

Get the inner buffer

Trait Implementations

impl<T> BufferForDraw<T> for BufferWithType<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 discard_staging_buffer(&self)

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

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 is_empty(&self) -> bool

Check if the buffer is empty

impl<T> Clone for BufferWithType<T>

where T: BufferVecItem + Clone,

fn clone(&self) -> BufferWithType<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for BufferWithType<T>

where T: BufferVecItem + Debug,

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

Formats the value using the given formatter.

impl<T> Send for BufferWithType<T>

where T: BufferVecItem,

impl<T> Sync for BufferWithType<T>

where T: BufferVecItem,