Struct vulkano::buffer::BufferSlice [−][src]
pub struct BufferSlice<T: ?Sized, B> { /* fields omitted */ }
Expand description
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();
Implementations
pub fn from_typed_buffer_access(r: Arc<B>) -> Arc<BufferSlice<T, B>> where
B: TypedBufferAccess<Content = T>,
Returns the offset of that slice within the buffer.
Returns the size of that slice in bytes.
pub unsafe fn slice_custom<F, R: ?Sized>(&self, f: F) -> Arc<BufferSlice<R, B>> where
F: for<'r> FnOnce(&'r T) -> &'r R,
pub unsafe fn slice_custom<F, R: ?Sized>(&self, f: F) -> Arc<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.
Changes the T
generic parameter of the BufferSlice
to the desired type. This can be
useful when you have a buffer with various types of data and want to create a typed slice
of a region that contains a single type of data.
Example
let blob_slice: Arc<BufferSlice<[u8], Arc<ImmutableBuffer<[u8]>>>> = return;
let vertex_slice: Arc<BufferSlice<[VertexImpl], Arc<ImmutableBuffer<[u8]>>>> = unsafe {
blob_slice.reinterpret::<[VertexImpl]>()
};
Safety
Correct offset
and size
must be ensured before using this BufferSlice
on the device.
See BufferSlice::slice
for adjusting these properties.
Returns the number of elements in this slice.
Reduces the slice to just one element of the array.
Returns None
if out of range.
Reduces the slice to just a range of the array.
Returns None
if out of range.
Trait Implementations
Returns the inner information about this buffer.
Returns the size of the buffer in bytes.
Returns a key that uniquely identifies the buffer. Two buffers or images that potentially overlap in memory must return the same key. Read more
Locks the resource for usage on the GPU. Returns an error if the lock can’t be acquired. Read more
Locks the resource for usage on the GPU. Supposes that the resource is already locked, and simply increases the lock by one. Read more
Unlocks the resource previously acquired with try_gpu_lock
or increase_gpu_lock
. Read more
fn into_buffer_slice(self: &Arc<Self>) -> Arc<BufferSlice<Self::Content, Self>> where
Self: Sized + TypedBufferAccess,
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]>,
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. Read more
fn index<T>(
self: &Arc<Self>,
index: 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]>,
Returns a BufferSlice
for a single element in the buffer. Returns None
if out of range. Read more
Gets the device address for this buffer. Read more
Performs the conversion.
impl<T: ?Sized, B> PartialEq<BufferSlice<T, B>> for BufferSlice<T, B> where
T: Send + Sync,
B: BufferAccess,
impl<T: ?Sized, B> PartialEq<BufferSlice<T, B>> for BufferSlice<T, B> where
T: Send + Sync,
B: BufferAccess,
impl<T, B> TypedBufferAccess for BufferSlice<T, B> where
T: Send + Sync + ?Sized,
B: BufferAccess,
impl<T, B> TypedBufferAccess for BufferSlice<T, B> where
T: Send + Sync + ?Sized,
B: BufferAccess,
Auto Trait Implementations
impl<T: ?Sized, B> RefUnwindSafe for BufferSlice<T, B> where
B: RefUnwindSafe,
T: RefUnwindSafe,
impl<T: ?Sized, B> Unpin for BufferSlice<T, B> where
T: Unpin,
impl<T: ?Sized, B> UnwindSafe for BufferSlice<T, B> where
B: RefUnwindSafe,
T: UnwindSafe,
Blanket Implementations
Mutably borrows from an owned value. Read more
Builds a pointer to this type from a raw pointer.
Returns true if the size is suitable to store a type like this.
Returns the size of an individual element.