Trait vulkano::buffer::BufferAccess

pub unsafe trait BufferAccess: DeviceOwned + Send + Sync {
    fn inner(&self) -> BufferInner<'_>;
    fn size(&self) -> DeviceSize;

    fn usage(&self) -> &BufferUsage { ... }
    fn into_buffer_slice(
        self: &Arc<Self>
    ) -> Arc<BufferSlice<Self::Content, Self>>
    where
        Self: Sized + TypedBufferAccess,
    { ... }
    fn slice<T>(
        self: &Arc<Self>,
        range: Range<DeviceSize>
    ) -> Option<Arc<BufferSlice<[T], Self>>>
    where
        Self: Sized + TypedBufferAccess<Content = [T]>,
    { ... }
    fn index<T>(
        self: &Arc<Self>,
        index: DeviceSize
    ) -> Option<Arc<BufferSlice<T, Self>>>
    where
        Self: Sized + TypedBufferAccess<Content = [T]>,
    { ... }
    fn raw_device_address(&self) -> Result<NonZeroU64, BufferDeviceAddressError> { ... }
}

Trait for objects that represent a way for the GPU to have access to a buffer or a slice of a buffer.

See also TypedBufferAccess.

Required Methods

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

Returns the inner information about this buffer.

fn size(&self) -> DeviceSize

Returns the size of the buffer in bytes.

Provided Methods

fn usage(&self) -> &BufferUsage

Returns the usage the buffer was created with.

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.

This method can be used when you want to perform an operation on some part of the buffer and not on the whole buffer.

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.

This method can be used when you want to perform an operation on a specific element of the buffer and not on the whole buffer.

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

Gets the device address for this buffer.

Safety

No lock checking or waiting is performed. This is nevertheless still safe because the returned value isn’t directly dereferencable. Unsafe code is required to dereference the value in a shader.

Trait Implementations

impl Debug for dyn BufferAccess

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

Formats the value using the given formatter.

impl Hash for dyn BufferAccess

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 PartialEq<dyn BufferAccess + 'static> for dyn BufferAccess

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 Eq for dyn BufferAccess

Implementors

impl<T> BufferAccess for T where
    T: SafeDeref + Send + Sync,
    T::Target: BufferAccess, 

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

impl<T, A> BufferAccess for CpuBufferPoolChunk<T, A> where
    T: Send + Sync,
    [T]: BufferContents,
    A: MemoryPool, 

impl<T, A> BufferAccess for CpuBufferPoolSubbuffer<T, A> where
    T: Send + Sync,
    [T]: BufferContents,
    A: MemoryPool, 

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

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

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

impl<T, B> BufferAccess for BufferSlice<T, B> where
    B: BufferAccess,
    T: Send + Sync + ?Sized,