Struct vulkano::buffer::BufferSlice

pub struct BufferSlice<T: ?Sized, B> { /* fields omitted */ }

A subpart of a buffer.

This object doesn't correspond to any Vulkan object. It exists for API convenience.

Example

Creating a slice:

use vulkano::buffer::BufferSlice;
let _slice = BufferSlice::from(&buffer);

Selecting a slice of a buffer that contains [T]:

use vulkano::buffer::BufferSlice;
let _slice = BufferSlice::from(&buffer).slice(12 .. 14).unwrap();

Methods

impl<T: ?Sized, B> BufferSlice<T, B>

fn from_typed_buffer_access(r: B) -> BufferSlice<T, B> where
    B: TypedBufferAccess<Content = T>, 

fn buffer(&self) -> &B

Returns the buffer that this slice belongs to.

fn offset(&self) -> usize

Returns the offset of that slice within the buffer.

fn size(&self) -> usize

Returns the size of that slice in bytes.

unsafe fn slice_custom<F, R: ?Sized>(self, f: F) -> BufferSlice<R, B> where
    F: for<'r> FnOnce(&'r T) -> &'r R, 

Builds a slice that contains an element from inside the buffer.

This method builds an object that represents a slice of the buffer. No actual operation is performed.

Example

TODO

Safety

The object whose reference is passed to the closure is uninitialized. Therefore you must not access the content of the object.

You must return a reference to an element from the parameter. The closure must not panic.

impl<T, B> BufferSlice<[T], B>

fn len(&self) -> usize

Returns the number of elements in this slice.

fn index(self, index: usize) -> Option<BufferSlice<T, B>>

Reduces the slice to just one element of the array.

Returns None if out of range.

fn slice(self, range: Range<usize>) -> Option<BufferSlice<[T], B>>

Reduces the slice to just a range of the array.

Returns None if out of range.

Trait Implementations

impl<T: ?Sized, B> Clone for BufferSlice<T, B> where
    B: Clone, 

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

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

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,
    self_offset: usize,
    self_size: usize,
    other: &BufferAccess,
    other_offset: usize,
    other_size: usize
) -> bool

Returns true if an access to self (as defined by self_offset and self_size) potentially overlaps the same memory as an access to other (as defined by other_offset and other_size).

fn conflict_key(&self, self_offset: usize, self_size: usize) -> u64

Returns a key that uniquely identifies the range given by offset/size.

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.

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 len(&self) -> usize where
    Self: TypedBufferAccess,
    Self::Content: Content, 

Returns the length of the buffer in number of elements.

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.

fn conflicts_image(
    &self,
    self_offset: usize,
    self_size: usize,
    other: &ImageAccess,
    other_first_layer: u32,
    other_num_layers: u32,
    other_first_mipmap: u32,
    other_num_mipmaps: u32
) -> bool

Returns true if an access to self (as defined by self_offset and self_size) potentially overlaps the same memory as an access to other (as defined by other_first_layer, other_num_layers, other_first_mipmap and other_num_mipmaps).

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

Shortcut for conflicts_buffer that compares the whole buffer to another.

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

Shortcut for conflicts_image that compares the whole buffer to a whole image.

fn conflict_key_all(&self) -> u64

Shortcut for conflict_key that grabs the key of the whole buffer.

impl<T: ?Sized, B> TypedBufferAccess for BufferSlice<T, B> where
    B: BufferAccess, 

type Content = T

The type of the content.

impl<T: ?Sized, B> DeviceOwned for BufferSlice<T, B> where
    B: DeviceOwned, 

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

Returns the device that owns Self.

impl<T, B> From<BufferSlice<T, B>> for BufferSlice<[T], B>

fn from(r: BufferSlice<T, B>) -> BufferSlice<[T], B>

Performs the conversion.