Struct vulkano::buffer::BufferSlice [−][src]
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();
Implementations
impl<T: ?Sized, B> BufferSlice<T, B>
[src]
impl<T: ?Sized, B> BufferSlice<T, B>
[src]pub fn from_typed_buffer_access(r: B) -> BufferSlice<T, B> where
B: TypedBufferAccess<Content = T>,
[src]
B: TypedBufferAccess<Content = T>,
pub unsafe fn slice_custom<F, R: ?Sized>(self, f: F) -> BufferSlice<R, B> where
F: for<'r> FnOnce(&'r T) -> &'r R,
[src]
pub unsafe fn slice_custom<F, R: ?Sized>(self, f: F) -> BufferSlice<R, B> where
F: for<'r> FnOnce(&'r T) -> &'r R,
[src]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.
pub unsafe fn reinterpret<R: ?Sized>(self) -> BufferSlice<R, B>
[src]
pub unsafe fn reinterpret<R: ?Sized>(self) -> BufferSlice<R, B>
[src]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: BufferSlice<[u8], Arc<ImmutableBuffer<[u8]>>> = return; let vertex_slice: 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.
impl<T, B> BufferSlice<[T], B>
[src]
impl<T, B> BufferSlice<[T], B>
[src]pub fn index(self, index: usize) -> Option<BufferSlice<T, B>>
[src]
pub fn index(self, index: usize) -> Option<BufferSlice<T, B>>
[src]Reduces the slice to just one element of the array.
Returns None
if out of range.
Trait Implementations
impl<T: ?Sized, B> BufferAccess for BufferSlice<T, B> where
B: BufferAccess,
[src]
impl<T: ?Sized, B> BufferAccess for BufferSlice<T, B> where
B: BufferAccess,
[src]fn inner(&self) -> BufferInner<'_>
[src]
fn inner(&self) -> BufferInner<'_>
[src]Returns the inner information about this buffer.
fn conflicts_buffer(&self, other: &dyn BufferAccess) -> bool
[src]
fn conflicts_buffer(&self, other: &dyn BufferAccess) -> bool
[src]Returns true if an access to self
potentially overlaps the same memory as an access to
other
. Read more
fn conflicts_image(&self, other: &dyn ImageAccess) -> bool
[src]
fn conflicts_image(&self, other: &dyn ImageAccess) -> bool
[src]Returns true if an access to self
potentially overlaps the same memory as an access to
other
. Read more
fn conflict_key(&self) -> (u64, usize)
[src]
fn conflict_key(&self) -> (u64, usize)
[src]Returns a key that uniquely identifies the buffer. Two buffers or images that potentially overlap in memory must return the same key. Read more
fn try_gpu_lock(
&self,
exclusive_access: bool,
queue: &Queue
) -> Result<(), AccessError>
[src]
fn try_gpu_lock(
&self,
exclusive_access: bool,
queue: &Queue
) -> Result<(), AccessError>
[src]Locks the resource for usage on the GPU. Returns an error if the lock can’t be acquired. Read more
unsafe fn increase_gpu_lock(&self)
[src]
unsafe fn increase_gpu_lock(&self)
[src]Locks the resource for usage on the GPU. Supposes that the resource is already locked, and simply increases the lock by one. Read more
unsafe fn unlock(&self)
[src]
unsafe fn unlock(&self)
[src]Unlocks the resource previously acquired with try_gpu_lock
or increase_gpu_lock
. Read more
fn as_buffer_slice(&self) -> BufferSlice<Self::Content, &Self> where
Self: Sized + TypedBufferAccess,
[src]
fn as_buffer_slice(&self) -> BufferSlice<Self::Content, &Self> where
Self: Sized + TypedBufferAccess,
[src]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]>,
[src]
fn slice<T>(&self, range: Range<usize>) -> Option<BufferSlice<[T], &Self>> where
Self: Sized + TypedBufferAccess<Content = [T]>,
[src]Builds a BufferSlice
object holding part of the buffer by reference. Read more
fn into_buffer_slice(self) -> BufferSlice<Self::Content, Self> where
Self: Sized + TypedBufferAccess,
[src]
fn into_buffer_slice(self) -> BufferSlice<Self::Content, Self> where
Self: Sized + TypedBufferAccess,
[src]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]>,
[src]
fn index<T>(&self, index: usize) -> Option<BufferSlice<[T], &Self>> where
Self: Sized + TypedBufferAccess<Content = [T]>,
[src]Builds a BufferSlice
object holding part of the buffer by reference. Read more
fn raw_device_address(
&self
) -> Result<NonZeroU64, DeviceAddressUsageNotEnabledError>
[src]
fn raw_device_address(
&self
) -> Result<NonZeroU64, DeviceAddressUsageNotEnabledError>
[src]Gets the device address for this buffer. Read more
impl<T: ?Sized, B> Clone for BufferSlice<T, B> where
B: Clone,
[src]
impl<T: ?Sized, B> Clone for BufferSlice<T, B> where
B: Clone,
[src]impl<T: ?Sized, B> DeviceOwned for BufferSlice<T, B> where
B: DeviceOwned,
[src]
impl<T: ?Sized, B> DeviceOwned for BufferSlice<T, B> where
B: DeviceOwned,
[src]impl<T, B> From<BufferSlice<T, B>> for BufferSlice<[T], B>
[src]
impl<T, B> From<BufferSlice<T, B>> for BufferSlice<[T], B>
[src]fn from(r: BufferSlice<T, B>) -> BufferSlice<[T], B>
[src]
fn from(r: BufferSlice<T, B>) -> BufferSlice<[T], B>
[src]Performs the conversion.
impl<T: ?Sized, B> Hash for BufferSlice<T, B> where
B: BufferAccess,
[src]
impl<T: ?Sized, B> Hash for BufferSlice<T, B> where
B: BufferAccess,
[src]impl<T: ?Sized, B> PartialEq<BufferSlice<T, B>> for BufferSlice<T, B> where
B: BufferAccess,
[src]
impl<T: ?Sized, B> PartialEq<BufferSlice<T, B>> for BufferSlice<T, B> where
B: BufferAccess,
[src]impl<T: ?Sized, B> TypedBufferAccess for BufferSlice<T, B> where
B: BufferAccess,
[src]
impl<T: ?Sized, B> TypedBufferAccess for BufferSlice<T, B> where
B: BufferAccess,
[src]impl<T: ?Sized, B> Eq for BufferSlice<T, B> where
B: BufferAccess,
[src]
B: BufferAccess,
Auto Trait Implementations
impl<T: ?Sized, B> RefUnwindSafe for BufferSlice<T, B> where
B: RefUnwindSafe,
T: RefUnwindSafe,
B: RefUnwindSafe,
T: RefUnwindSafe,
impl<T: ?Sized, B> Send for BufferSlice<T, B> where
B: Send,
T: Send,
B: Send,
T: Send,
impl<T: ?Sized, B> Sync for BufferSlice<T, B> where
B: Sync,
T: Sync,
B: Sync,
T: Sync,
impl<T: ?Sized, B> Unpin for BufferSlice<T, B> where
B: Unpin,
T: Unpin,
B: Unpin,
T: Unpin,
impl<T: ?Sized, B> UnwindSafe for BufferSlice<T, B> where
B: UnwindSafe,
T: UnwindSafe,
B: UnwindSafe,
T: UnwindSafe,
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> Content for T
[src]
impl<T> Content for T
[src]pub fn ref_from_ptr(*mut c_void, usize) -> Option<*mut T>
[src]
pub fn ref_from_ptr(*mut c_void, usize) -> Option<*mut T>
[src]Builds a pointer to this type from a raw pointer.
pub fn is_size_suitable(usize) -> bool
[src]
pub fn is_size_suitable(usize) -> bool
[src]Returns true if the size is suitable to store a type like this.
pub fn indiv_size() -> usize
[src]
pub fn indiv_size() -> usize
[src]Returns the size of an individual element.
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more