Struct vulkano::buffer::cpu_access::CpuAccessibleBuffer [−][src]
pub struct CpuAccessibleBuffer<T: ?Sized, A = PotentialDedicatedAllocation<StdMemoryPoolAlloc>> { /* fields omitted */ }
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
impl<T> CpuAccessibleBuffer<T>
[src]
impl<T> CpuAccessibleBuffer<T>
[src]pub fn from_data(
device: Arc<Device>,
usage: BufferUsage,
host_cached: bool,
data: T
) -> Result<Arc<CpuAccessibleBuffer<T>>, DeviceMemoryAllocError> where
T: Content + Copy + 'static,
[src]
pub fn from_data(
device: Arc<Device>,
usage: BufferUsage,
host_cached: bool,
data: T
) -> Result<Arc<CpuAccessibleBuffer<T>>, DeviceMemoryAllocError> where
T: Content + Copy + 'static,
[src]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>
[src]
pub unsafe fn uninitialized(
device: Arc<Device>,
usage: BufferUsage,
host_cached: bool
) -> Result<Arc<CpuAccessibleBuffer<T>>, DeviceMemoryAllocError>
[src]Builds a new uninitialized buffer. Only allowed for sized data.
impl<T> CpuAccessibleBuffer<[T]>
[src]
impl<T> CpuAccessibleBuffer<[T]>
[src]pub fn from_iter<I>(
device: Arc<Device>,
usage: BufferUsage,
host_cached: bool,
data: I
) -> Result<Arc<CpuAccessibleBuffer<[T]>>, DeviceMemoryAllocError> where
I: ExactSizeIterator<Item = T>,
T: Content + 'static,
[src]
pub fn from_iter<I>(
device: Arc<Device>,
usage: BufferUsage,
host_cached: bool,
data: I
) -> Result<Arc<CpuAccessibleBuffer<[T]>>, DeviceMemoryAllocError> where
I: ExactSizeIterator<Item = T>,
T: Content + 'static,
[src]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: usize,
usage: BufferUsage,
host_cached: bool
) -> Result<Arc<CpuAccessibleBuffer<[T]>>, DeviceMemoryAllocError>
[src]
pub unsafe fn uninitialized_array(
device: Arc<Device>,
len: usize,
usage: BufferUsage,
host_cached: bool
) -> Result<Arc<CpuAccessibleBuffer<[T]>>, DeviceMemoryAllocError>
[src]Builds a new buffer. Can be used for arrays.
impl<T: ?Sized> CpuAccessibleBuffer<T>
[src]
impl<T: ?Sized> CpuAccessibleBuffer<T>
[src]pub unsafe fn raw<'a, I>(
device: Arc<Device>,
size: usize,
usage: BufferUsage,
host_cached: bool,
queue_families: I
) -> Result<Arc<CpuAccessibleBuffer<T>>, DeviceMemoryAllocError> where
I: IntoIterator<Item = QueueFamily<'a>>,
[src]
pub unsafe fn raw<'a, I>(
device: Arc<Device>,
size: usize,
usage: BufferUsage,
host_cached: bool,
queue_families: I
) -> Result<Arc<CpuAccessibleBuffer<T>>, DeviceMemoryAllocError> where
I: IntoIterator<Item = QueueFamily<'a>>,
[src]Builds a new buffer without checking the size.
Safety
You must ensure that the size that you pass is correct for T
.
impl<T: ?Sized, A> CpuAccessibleBuffer<T, A>
[src]
impl<T: ?Sized, A> CpuAccessibleBuffer<T, A>
[src]pub fn queue_families(&self) -> Vec<QueueFamily<'_>>
[src]
pub fn queue_families(&self) -> Vec<QueueFamily<'_>>
[src]Returns the queue families this buffer can be used on.
impl<T: ?Sized, A> CpuAccessibleBuffer<T, A> where
T: Content + 'static,
A: MemoryPoolAlloc,
[src]
impl<T: ?Sized, A> CpuAccessibleBuffer<T, A> where
T: Content + 'static,
A: MemoryPoolAlloc,
[src]pub fn read(&self) -> Result<ReadLock<'_, T>, ReadLockError>
[src]
pub fn read(&self) -> Result<ReadLock<'_, T>, ReadLockError>
[src]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).
pub fn write(&self) -> Result<WriteLock<'_, T>, WriteLockError>
[src]
pub fn write(&self) -> Result<WriteLock<'_, T>, WriteLockError>
[src]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: 'static + Send + Sync,
[src]
impl<T: ?Sized, A> BufferAccess for CpuAccessibleBuffer<T, A> where
T: 'static + Send + Sync,
[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
) -> Result<(), AccessError>
[src]
fn try_gpu_lock(
&self,
exclusive_access: bool,
_: &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, A> DeviceOwned for CpuAccessibleBuffer<T, A>
[src]
impl<T: ?Sized, A> DeviceOwned for CpuAccessibleBuffer<T, A>
[src]impl<T: ?Sized, A> PartialEq<CpuAccessibleBuffer<T, A>> for CpuAccessibleBuffer<T, A> where
T: 'static + Send + Sync,
[src]
impl<T: ?Sized, A> PartialEq<CpuAccessibleBuffer<T, A>> for CpuAccessibleBuffer<T, A> where
T: 'static + Send + Sync,
[src]impl<T: ?Sized, A> TypedBufferAccess for CpuAccessibleBuffer<T, A> where
T: 'static + Send + Sync,
[src]
impl<T: ?Sized, A> TypedBufferAccess for CpuAccessibleBuffer<T, A> where
T: 'static + Send + Sync,
[src]impl<T: ?Sized, A> Eq for CpuAccessibleBuffer<T, A> where
T: 'static + Send + Sync,
[src]
T: 'static + 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,
A: Send,
T: Send,
impl<T: ?Sized, A> Sync for CpuAccessibleBuffer<T, A> where
A: Sync,
T: Sync,
A: Sync,
T: Sync,
impl<T: ?Sized, A> Unpin for CpuAccessibleBuffer<T, A> where
A: Unpin,
A: Unpin,
impl<T: ?Sized, A> UnwindSafe for CpuAccessibleBuffer<T, A> where
A: UnwindSafe,
T: UnwindSafe,
A: 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.