Struct vulkano::buffer::sys::Buffer

pub struct Buffer { /* private fields */ }

A storage for raw bytes.

Unlike RawBuffer, a Buffer has memory backing it, and can be used normally.

Implementations

impl Buffer

pub fn memory(&self) -> &BufferMemory

Returns the type of memory that is backing this buffer.

pub fn memory_requirements(&self) -> &MemoryRequirements

Returns the memory requirements for this buffer.

pub fn flags(&self) -> BufferCreateFlags

Returns the flags the buffer was created with.

pub fn size(&self) -> DeviceSize

Returns the size of the buffer in bytes.

pub fn usage(&self) -> &BufferUsage

Returns the usage the buffer was created with.

pub fn sharing(&self) -> &Sharing<SmallVec<[u32; 4]>>

Returns the sharing the buffer was created with.

pub fn external_memory_handle_types(&self) -> ExternalMemoryHandleTypes

Returns the external memory handle types that are supported with this buffer.

pub fn read(
    &self,
    range: Range<DeviceSize>
) -> Result<BufferReadGuard<'_, [u8]>, BufferError>

Locks the buffer in order to read its content from the host.

If the buffer is currently used in exclusive mode by the device, this function will return an error. Similarly if you called write() on the buffer and haven’t dropped the lock, this function will return an error as well.

After this function successfully locks the buffer, any attempt to submit a command buffer that uses it in exclusive mode will fail. You can still submit this buffer for non-exclusive accesses (ie. reads).

pub fn write(
    &self,
    range: Range<DeviceSize>
) -> Result<BufferWriteGuard<'_>, BufferError>

Locks the buffer in order to write its content from the host.

If the buffer is currently in use by the device, this function will return an error. Similarly if you called read() on the buffer and haven’t dropped the lock, this function will return an error as well.

After this function successfully locks the buffer, any attempt to submit a command buffer that uses it and any attempt to call read() will return an error.

Trait Implementations

impl Debug for Buffer

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

Formats the value using the given formatter.

impl DeviceOwned for Buffer

fn device(&self) -> &Arc<Device>

Returns the device that owns Self.

impl Hash for Buffer

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<Buffer> for Buffer

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl VulkanObject for Buffer

type Handle = Buffer

The type of the object.

fn handle(&self) -> Self::Handle

Returns the raw Vulkan handle of the object.

impl Eq for Buffer