Struct Buffer 

pub struct Buffer {
    pub device: Arc<VulkanDevice>,
    pub buffer: Arc<VulkanBuffer>,
    pub memory: Arc<VulkanMemory>,
    pub staging_buffer: RwLock<Option<StagingBuffer>>,
    /* private fields */
}

The Vulkan buffer object, same as the OpenGL buffer object, could be used to store vertices, elements(indices), and the other data.

Fields

device: Arc<VulkanDevice>

The VulkanDevice is the associated device

buffer: Arc<VulkanBuffer>

The buffer

memory: Arc<VulkanMemory>

The device memory

staging_buffer: RwLock<Option<StagingBuffer>>

The staging buffer

Implementations

impl Buffer

pub fn new( device: Arc<VulkanDevice>, size: VkDeviceSize, data: Option<*const c_void>, usage: VkBufferUsageFlags, ) -> Result<Self, VulkanError>

Create a new buffer

• If data is None, cmdbuf could be null() because no vkCmdCopyBuffer() will be issued.

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

Create the staging buffer if not exist

pub fn discard_staging_buffer(&self)

Discard the staging buffer to save memory

pub fn get_usage(&self) -> VkBufferUsageFlags

Get the usage

pub fn get_size(&self) -> VkDeviceSize

Get the size

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

where T: Sized + Clone + Copy,

Map staging buffer as slice

pub fn get_staging_buffer_address(&self) -> Result<*mut c_void, VulkanError>

Get the address of the staging buffer memory data

pub unsafe fn set_staging_data( &self, data: *const c_void, offset: VkDeviceSize, size: usize, ) -> Result<(), VulkanError>

Update new data to the buffer

Safety

You must provide a valid pointer data, otherwise the behavior of this function is undefined.

pub unsafe fn get_staging_data( &self, data: *mut c_void, offset: VkDeviceSize, size: usize, ) -> Result<(), VulkanError>

Retrieve the data from the staging buffer

Safety

You must provide a valid pointer data, otherwise the behavior of this function is undefined.

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

Upload the data from the staging buffer

pub fn upload_staging_buffer_multi( &self, cmdbuf: VkCommandBuffer, regions: &[BufferRegion], ) -> Result<(), VulkanError>

Upload the data from the staging buffer

pub fn download_staging_buffer( &self, cmdbuf: VkCommandBuffer, offset: VkDeviceSize, size: VkDeviceSize, ) -> Result<(), VulkanError>

Download the data to the staging buffer

pub fn download_staging_buffer_multi( &self, cmdbuf: VkCommandBuffer, regions: &[BufferRegion], ) -> Result<(), VulkanError>

Download the data to the staging buffer

pub fn create_buffer_view( &self, format: VkFormat, ) -> Result<VulkanBufferView, VulkanError>

Create a buffer view

pub fn create_buffer_view_partial( &self, range: &BufferViewRange, ) -> Result<VulkanBufferView, VulkanError>

Create a buffer view

Trait Implementations

impl Clone for Buffer

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Buffer

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

Formats the value using the given formatter.