Struct vulkano::buffer::device_local::DeviceLocalBuffer

pub struct DeviceLocalBuffer<T: ?Sized, A = PotentialDedicatedAllocation<StdMemoryPoolAlloc>> { /* fields omitted */ }

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>

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

Builds a new buffer. Only allowed for sized data.

impl<T> DeviceLocalBuffer<[T]>

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

Builds a new buffer. Can be used for arrays.

impl<T: ?Sized> DeviceLocalBuffer<T>

pub unsafe fn raw<'a, I>(
    device: Arc<Device>,
    size: usize,
    usage: BufferUsage,
    queue_families: I
) -> Result<Arc<DeviceLocalBuffer<T>>, DeviceMemoryAllocError> 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.

impl<T: ?Sized, A> DeviceLocalBuffer<T, A>

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

Returns the queue families this buffer can be used on.

Trait Implementations

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

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

Returns the inner information about this buffer.

fn size(&self) -> usize

Returns the size of the buffer in bytes.

fn conflicts_buffer(&self, other: &dyn BufferAccess) -> bool

Returns true if an access to self potentially overlaps the same memory as an access to other.

fn conflicts_image(&self, other: &dyn ImageAccess) -> bool

Returns true if an access to self potentially overlaps the same memory as an access to other.

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

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 as_buffer_slice(&self) -> BufferSlice<Self::Content, &Self> where
    Self: Sized + TypedBufferAccess, 

Builds a BufferSlice object holding the buffer by reference.

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

Builds a BufferSlice object holding part of the buffer by reference.

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

Builds a BufferSlice object holding the buffer by value.

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

Builds a BufferSlice object holding part of the buffer by reference.

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

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

Formats the value using the given formatter.

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

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

Returns the device that owns Self.

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

type Content = T

The type of the content.

fn len(&self) -> usize where
    Self::Content: Content, 

Returns the length of the buffer in number of elements.