Struct vulkano::buffer::cpu_access::CpuAccessibleBuffer [−][src]
pub struct CpuAccessibleBuffer<T: ?Sized, A = PotentialDedicatedAllocation<StdMemoryPoolAlloc>> { /* fields omitted */ }
Expand description
Buffer whose content is accessible by the CPU.
Setting the host_cached
field on the various initializers to true
will make it so
the CpuAccessibleBuffer
prefers to allocate from host_cached memory. Host cached
memory caches GPU data on the CPU side. This can be more performant in cases where
the cpu needs to read data coming off the GPU.
Implementations
pub fn from_data(
device: Arc<Device>,
usage: BufferUsage,
host_cached: bool,
data: T
) -> Result<Arc<CpuAccessibleBuffer<T>>, DeviceMemoryAllocError> where
T: Content + Copy + 'static,
pub fn from_data(
device: Arc<Device>,
usage: BufferUsage,
host_cached: bool,
data: T
) -> Result<Arc<CpuAccessibleBuffer<T>>, DeviceMemoryAllocError> where
T: Content + Copy + 'static,
Builds a new buffer with some data in it. Only allowed for sized data.
pub unsafe fn uninitialized(
device: Arc<Device>,
usage: BufferUsage,
host_cached: bool
) -> Result<Arc<CpuAccessibleBuffer<T>>, DeviceMemoryAllocError>
pub unsafe fn uninitialized(
device: Arc<Device>,
usage: BufferUsage,
host_cached: bool
) -> Result<Arc<CpuAccessibleBuffer<T>>, DeviceMemoryAllocError>
Builds a new uninitialized buffer. Only allowed for sized data.
pub fn from_iter<I>(
device: Arc<Device>,
usage: BufferUsage,
host_cached: bool,
data: I
) -> Result<Arc<CpuAccessibleBuffer<[T]>>, DeviceMemoryAllocError> where
I: IntoIterator<Item = T>,
I::IntoIter: ExactSizeIterator,
T: Content + 'static,
pub fn from_iter<I>(
device: Arc<Device>,
usage: BufferUsage,
host_cached: bool,
data: I
) -> Result<Arc<CpuAccessibleBuffer<[T]>>, DeviceMemoryAllocError> where
I: IntoIterator<Item = T>,
I::IntoIter: ExactSizeIterator,
T: Content + 'static,
Builds a new buffer that contains an array T
. The initial data comes from an iterator
that produces that list of Ts.
pub unsafe fn uninitialized_array(
device: Arc<Device>,
len: DeviceSize,
usage: BufferUsage,
host_cached: bool
) -> Result<Arc<CpuAccessibleBuffer<[T]>>, DeviceMemoryAllocError>
pub unsafe fn uninitialized_array(
device: Arc<Device>,
len: DeviceSize,
usage: BufferUsage,
host_cached: bool
) -> Result<Arc<CpuAccessibleBuffer<[T]>>, DeviceMemoryAllocError>
Builds a new buffer. Can be used for arrays.
pub unsafe fn raw<'a, I>(
device: Arc<Device>,
size: DeviceSize,
usage: BufferUsage,
host_cached: bool,
queue_families: I
) -> Result<Arc<CpuAccessibleBuffer<T>>, DeviceMemoryAllocError> where
I: IntoIterator<Item = QueueFamily<'a>>,
pub unsafe fn raw<'a, I>(
device: Arc<Device>,
size: DeviceSize,
usage: BufferUsage,
host_cached: bool,
queue_families: I
) -> Result<Arc<CpuAccessibleBuffer<T>>, DeviceMemoryAllocError> where
I: IntoIterator<Item = QueueFamily<'a>>,
Builds a new buffer without checking the size.
Safety
You must ensure that the size that you pass is correct for T
.
Returns the queue families this buffer can be used on.
Locks the buffer in order to read its content from the CPU.
If the buffer is currently used in exclusive mode by the GPU, this function will return
an error. Similarly if you called write()
on the buffer and haven’t dropped the lock,
this function will return an error as well.
After this function successfully locks the buffer, any attempt to submit a command buffer that uses it in exclusive mode will fail. You can still submit this buffer for non-exclusive accesses (ie. reads).
Locks the buffer in order to write its content from the CPU.
If the buffer is currently in use by the GPU, this function will return an error. Similarly
if you called read()
on the buffer and haven’t dropped the lock, this function will
return an error as well.
After this function successfully locks the buffer, any attempt to submit a command buffer
that uses it and any attempt to call read()
will return an error.
Trait Implementations
impl<T: ?Sized, A> BufferAccess for CpuAccessibleBuffer<T, A> where
T: Send + Sync + 'static,
A: Send + Sync,
impl<T: ?Sized, A> BufferAccess for CpuAccessibleBuffer<T, A> where
T: Send + Sync + 'static,
A: Send + Sync,
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
impl<T: ?Sized, A> PartialEq<CpuAccessibleBuffer<T, A>> for CpuAccessibleBuffer<T, A> where
T: Send + Sync + 'static,
A: Send + Sync,
impl<T: ?Sized, A> PartialEq<CpuAccessibleBuffer<T, A>> for CpuAccessibleBuffer<T, A> where
T: Send + Sync + 'static,
A: Send + Sync,
impl<T: ?Sized, A> TypedBufferAccess for CpuAccessibleBuffer<T, A> where
T: Send + Sync + 'static,
A: Send + Sync,
impl<T: ?Sized, A> TypedBufferAccess for CpuAccessibleBuffer<T, A> where
T: Send + Sync + 'static,
A: Send + Sync,
Auto Trait Implementations
impl<T, A = PotentialDedicatedAllocation<StdMemoryPoolAlloc>> !RefUnwindSafe for CpuAccessibleBuffer<T, A>
impl<T: ?Sized, A> Send for CpuAccessibleBuffer<T, A> where
A: Send,
T: Send,
impl<T: ?Sized, A> Sync for CpuAccessibleBuffer<T, A> where
A: Sync,
T: Sync,
impl<T: ?Sized, A> Unpin for CpuAccessibleBuffer<T, A> where
A: Unpin,
impl<T: ?Sized, A> UnwindSafe for CpuAccessibleBuffer<T, A> where
A: UnwindSafe,
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.