Struct Buffer 

pub struct Buffer {
    pub device: Device,
    pub handle: Buffer,
    pub info: BufferInfo,
    /* private fields */
}

Smart pointer handle to a buffer object.

Also contains information about the object.

let info = BufferInfo::device_mem(1_024, vk::BufferUsageFlags::STORAGE_BUFFER);
let my_buf = Buffer::create(&device, info)?;

assert_eq!(my_buf.info, info);
assert_ne!(my_buf.handle, vk::Buffer::null());

Fields

device: Device

The device which owns this buffer resource.

Note: This field is read-only.

handle: Buffer

The native Vulkan resource handle of this buffer.

Note: This field is read-only.

info: BufferInfo

Information used to create this resource.

Note: This field is read-only.

Implementations

impl Buffer

pub fn create( device: &Device, info: impl Into<BufferInfo>, ) -> Result<Self, DriverError>

Creates a new buffer on the given device.

Examples

Basic usage:

const SIZE: vk::DeviceSize = 1024;
let info = BufferInfo::host_mem(SIZE, vk::BufferUsageFlags::UNIFORM_BUFFER);
let buf = Buffer::create(&device, info)?;

assert_ne!(buf.handle, vk::Buffer::null());
assert_eq!(buf.info.size, SIZE);

pub fn create_from_slice( device: &Device, usage: BufferUsageFlags, data: &[u8], ) -> Result<Self, DriverError>

Creates a new mappable buffer on the given device and fills it with the data in slice.

Examples

Basic usage:

const DATA: [u8; 4] = [0xfe, 0xed, 0xbe, 0xef];
let buf = Buffer::create_from_slice(&device, vk::BufferUsageFlags::UNIFORM_BUFFER, &DATA)?;

assert_ne!(buf.handle, vk::Buffer::null());
assert_eq!(buf.info.size, 4);
assert_eq!(Buffer::mapped_slice(&buf), &DATA);

pub fn copy_from_slice(&mut self, offset: DeviceSize, data: &[u8])

Updates a mappable buffer starting at offset with the data in slice.

Panics

Panics if the buffer was not created with host-writable memory.

Examples

Basic usage:

const DATA: [u8; 4] = [0xde, 0xad, 0xc0, 0xde];
Buffer::copy_from_slice(&mut my_buf, 0, &DATA);

assert_eq!(Buffer::mapped_slice(&my_buf), &DATA);

pub fn device_address(&self) -> DeviceAddress

Returns the device address of this object.

Panics

Panics if the buffer was not created with the SHADER_DEVICE_ADDRESS usage flag.

Examples

Basic usage:

let addr = my_buf.device_address();

assert_ne!(addr, 0);

pub fn mapped_slice(&self) -> &[u8]

Returns a mapped slice.

Panics

Panics if the buffer was not created with host-readable memory.

Examples

Basic usage:

// my_buf is mappable and filled with four zeroes
let data = Buffer::mapped_slice(&my_buf);

assert_eq!(data.len(), 4);
assert_eq!(data[0], 0x00);

pub fn mapped_slice_mut(&mut self) -> &mut [u8]

Returns a mapped mutable slice.

Panics

Panics if the buffer was not created with host-writable memory.

Examples

Basic usage:

let mut data = Buffer::mapped_slice_mut(&mut my_buf);
data.copy_from_slice(&42f32.to_be_bytes());

assert_eq!(data.len(), 4);
assert_eq!(data[0], 0x42);

pub fn set_debug_name(&self, name: impl AsRef<str>)

Sets the debugging name assigned to this buffer.

pub fn sync_info(&self) -> BufferSyncInfo

Returns compact synchronization information for the buffer’s current access ranges.

pub fn with_debug_name(self, name: impl AsRef<str>) -> Self

Sets the debugging name assigned to this buffer.

Trait Implementations

impl Debug for Buffer

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

Formats the value using the given formatter.

impl Drop for Buffer

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Eq for Buffer

impl PartialEq for Buffer

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Pool<BufferInfo, Buffer> for FifoPool

fn resource(&mut self, info: BufferInfo) -> Result<Lease<Buffer>, DriverError>

Request a resource.

impl Pool<BufferInfo, Buffer> for HashPool

fn resource(&mut self, info: BufferInfo) -> Result<Lease<Buffer>, DriverError>

Request a resource.

impl Pool<BufferInfo, Buffer> for LazyPool

fn resource(&mut self, info: BufferInfo) -> Result<Lease<Buffer>, DriverError>

Request a resource.

impl Resource for Buffer

type Node = BufferNode

The resource handle type.