[−][src]Trait vulkano::buffer::BufferAccess

pub unsafe trait BufferAccess: DeviceOwned {
    fn inner(&self) -> BufferInner;

    fn size(&self) -> usize;

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

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

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

    fn try_gpu_lock(
        &self, 
        exclusive_access: bool, 
        queue: &Queue
    ) -> Result<(), AccessError>;

    unsafe fn increase_gpu_lock(&self);

    unsafe fn unlock(&self);

    fn as_buffer_slice(&self) -> BufferSlice<Self::Content, &Self>
    where
        Self: Sized + TypedBufferAccess,
    { ... }

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

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

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

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) -> 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.

If this function returns false, this means that we are allowed to mutably access the content of self at the same time as the content of other without causing a data race.

Note that the function must be transitive. In other words if conflicts(a, b) is true and conflicts(b, c) is true, then conflicts(a, c) must be true as well.

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.

If this function returns false, this means that we are allowed to mutably access the content of self at the same time as the content of other without causing a data race.

Note that the function must be transitive. In other words if conflicts(a, b) is true and conflicts(b, c) is true, then conflicts(a, c) must be true as well.

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.

The key is shared amongst all buffers and images, which means that you can make several different buffer objects share the same memory, or make some buffer objects share memory with images, as long as they return the same key.

Since it is possible to accidentally return the same key for memory ranges that don't overlap, the conflicts_buffer or conflicts_image function should always be called to verify whether they actually overlap.

fn try_gpu_lock(
    &self,
    exclusive_access: bool,
    queue: &Queue
) -> Result<(), AccessError>

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

This function exists to prevent the user from causing a data race by reading and writing to the same resource at the same time.

If you call this function, you should call unlock() once the resource is no longer in use by the GPU. The implementation is not expected to automatically perform any unlocking and can rely on the fact that unlock() is going to be called.

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.

Must only be called after try_gpu_lock() succeeded.

If you call this function, you should call unlock() once the resource is no longer in use by the GPU. The implementation is not expected to automatically perform any unlocking and can rely on the fact that unlock() is going to be called.

unsafe fn unlock(&self)

Unlocks the resource previously acquired with try_gpu_lock or increase_gpu_lock.

Safety

Must only be called once per previous lock.

Loading content...

Provided methods

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.

This method can only be called for buffers whose type is known to be an array.

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

Returns None if out of range.

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.

This method can only be called for buffers whose type is known to be an array.

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.

Returns None if out of range.

Loading content...

Implementors

impl<T> BufferAccess for T where
    T: SafeDeref,
    T::Target: BufferAccess, [src]

impl<T, A> BufferAccess for CpuBufferPoolChunk<T, A> where
    A: MemoryPool, [src]

impl<T, A> BufferAccess for CpuBufferPoolSubbuffer<T, A> where
    A: MemoryPool, [src]

impl<T: ?Sized, A> BufferAccess for CpuAccessibleBuffer<T, A> where
    T: 'static + Send + Sync, [src]

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

impl<T: ?Sized, A> BufferAccess for ImmutableBuffer<T, A>[src]

impl<T: ?Sized, A> BufferAccess for ImmutableBufferInitialization<T, A>[src]

impl<T: ?Sized, B> BufferAccess for BufferSlice<T, B> where
    B: BufferAccess, [src]

Loading content...