Struct vulkano::buffer::device_local::DeviceLocalBuffer

pub struct DeviceLocalBuffer<T, A = PotentialDedicatedAllocation<StdMemoryPoolAlloc>> where
    T: BufferContents + ?Sized,  { /* private fields */ }

Buffer whose content is in device-local memory.

This buffer type is useful in order to store intermediary data. For example you execute a compute shader that writes to this buffer, then read the content of the buffer in a following compute or graphics pipeline.

The DeviceLocalBuffer will be in device-local memory, unless the device doesn’t provide any device-local memory.

Implementations

impl<T> DeviceLocalBuffer<T> where
    T: BufferContents, 

pub fn new<'a, I>(
    device: Arc<Device>,
    usage: BufferUsage,
    queue_families: I
) -> Result<Arc<DeviceLocalBuffer<T>>, DeviceMemoryAllocationError> where
    I: IntoIterator<Item = QueueFamily<'a>>, 

Builds a new buffer. Only allowed for sized data.

Panics

• Panics if T has zero size.

impl<T> DeviceLocalBuffer<[T]> where
    [T]: BufferContents, 

pub fn array<'a, I>(
    device: Arc<Device>,
    len: DeviceSize,
    usage: BufferUsage,
    queue_families: I
) -> Result<Arc<DeviceLocalBuffer<[T]>>, DeviceMemoryAllocationError> where
    I: IntoIterator<Item = QueueFamily<'a>>, 

Builds a new buffer. Can be used for arrays.

Panics

• Panics if T has zero size.
• Panics if len is zero.

impl<T> DeviceLocalBuffer<T> where
    T: BufferContents + ?Sized, 

pub unsafe fn raw<'a, I>(
    device: Arc<Device>,
    size: DeviceSize,
    usage: BufferUsage,
    queue_families: I
) -> Result<Arc<DeviceLocalBuffer<T>>, DeviceMemoryAllocationError> where
    I: IntoIterator<Item = QueueFamily<'a>>, 

Builds a new buffer without checking the size.

Safety

• You must ensure that the size that you pass is correct for T.

Panics

• Panics if size is zero.

pub unsafe fn raw_with_exportable_fd<'a, I>(
    device: Arc<Device>,
    size: DeviceSize,
    usage: BufferUsage,
    queue_families: I
) -> Result<Arc<DeviceLocalBuffer<T>>, DeviceMemoryAllocationError> where
    I: IntoIterator<Item = QueueFamily<'a>>, 

Same as raw but with exportable fd option for the allocated memory on Linux/BSD

Panics

• Panics if size is zero.

pub fn export_posix_fd(&self) -> Result<File, DeviceMemoryExportError>

Exports posix file descriptor for the allocated memory requires khr_external_memory_fd and khr_external_memory extensions to be loaded. Only works on Linux/BSD.

impl<T, A> DeviceLocalBuffer<T, A> where
    T: BufferContents + ?Sized, 

pub fn queue_families(&self) -> Vec<QueueFamily<'_>>

Returns the queue families this buffer can be used on.

Trait Implementations

impl<T, A> BufferAccess for DeviceLocalBuffer<T, A> where
    T: BufferContents + ?Sized,
    A: Send + Sync, 

fn inner(&self) -> BufferInner<'_>

Returns the inner information about this buffer.

fn size(&self) -> DeviceSize

Returns the size of the buffer in bytes.

fn conflict_key(&self) -> (u64, u64)

Returns a key that uniquely identifies the buffer. Two buffers or images that potentially overlap in memory must return the same key.

fn try_gpu_lock(&self, exclusive: bool, _: &Queue) -> Result<(), AccessError>

Locks the resource for usage on the GPU. Returns an error if the lock can’t be acquired.

unsafe fn increase_gpu_lock(&self)

Locks the resource for usage on the GPU. Supposes that the resource is already locked, and simply increases the lock by one.

unsafe fn unlock(&self)

Unlocks the resource previously acquired with try_gpu_lock or increase_gpu_lock.

fn into_buffer_slice(self: &Arc<Self>) -> Arc<BufferSlice<Self::Content, Self>> where
    Self: Sized + TypedBufferAccess, 

Returns a BufferSlice covering the whole buffer.

fn slice<T>(
    self: &Arc<Self>,
    range: Range<DeviceSize>
) -> Option<Arc<BufferSlice<[T], Self>>> where
    Self: Sized + TypedBufferAccess<Content = [T]>, 

Returns a BufferSlice for a subrange of elements in the buffer. Returns None if out of range.

fn index<T>(
    self: &Arc<Self>,
    index: DeviceSize
) -> Option<Arc<BufferSlice<T, Self>>> where
    Self: Sized + TypedBufferAccess<Content = [T]>, 

Returns a BufferSlice for a single element in the buffer. Returns None if out of range.

fn raw_device_address(&self) -> Result<NonZeroU64, BufferDeviceAddressError>

Gets the device address for this buffer.

impl<T: Debug, A: Debug> Debug for DeviceLocalBuffer<T, A> where
    T: BufferContents + ?Sized, 

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

Formats the value using the given formatter.

impl<T, A> DeviceOwned for DeviceLocalBuffer<T, A> where
    T: BufferContents + ?Sized, 

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

Returns the device that owns Self.

impl<T, A> Hash for DeviceLocalBuffer<T, A> where
    T: BufferContents + ?Sized,
    A: Send + Sync, 

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, 

Feeds a slice of this type into the given Hasher.

impl<T, A> PartialEq<DeviceLocalBuffer<T, A>> for DeviceLocalBuffer<T, A> where
    T: BufferContents + ?Sized,
    A: Send + Sync, 

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 !=.

impl<T, A> TypedBufferAccess for DeviceLocalBuffer<T, A> where
    T: BufferContents + ?Sized,
    A: Send + Sync, 

type Content = T

The type of the content.

fn len(&self) -> DeviceSize

Returns the length of the buffer in number of elements.

impl<T, A> Eq for DeviceLocalBuffer<T, A> where
    T: BufferContents + ?Sized,
    A: Send + Sync,