Struct vulkano::buffer::cpu_access::CpuAccessibleBuffer
[−]
[src]
pub struct CpuAccessibleBuffer<T: ?Sized, A = StdMemoryPoolAlloc> { /* fields omitted */ }
Buffer whose content is accessible by the CPU.
Methods
impl<T> CpuAccessibleBuffer<T>
[src]
fn new<'a, I>(
device: Arc<Device>,
usage: BufferUsage,
queue_families: I
) -> Result<Arc<CpuAccessibleBuffer<T>>, DeviceMemoryAllocError> where
I: IntoIterator<Item = QueueFamily<'a>>,
device: Arc<Device>,
usage: BufferUsage,
queue_families: I
) -> Result<Arc<CpuAccessibleBuffer<T>>, DeviceMemoryAllocError> where
I: IntoIterator<Item = QueueFamily<'a>>,
Deprecated. Use from_data
instead.
fn from_data<'a, I>(
device: Arc<Device>,
usage: BufferUsage,
queue_families: I,
data: T
) -> Result<Arc<CpuAccessibleBuffer<T>>, DeviceMemoryAllocError> where
I: IntoIterator<Item = QueueFamily<'a>>,
T: Content + 'static,
device: Arc<Device>,
usage: BufferUsage,
queue_families: I,
data: T
) -> Result<Arc<CpuAccessibleBuffer<T>>, DeviceMemoryAllocError> where
I: IntoIterator<Item = QueueFamily<'a>>,
T: Content + 'static,
Builds a new buffer with some data in it. Only allowed for sized data.
unsafe fn uninitialized<'a, I>(
device: Arc<Device>,
usage: BufferUsage,
queue_families: I
) -> Result<Arc<CpuAccessibleBuffer<T>>, DeviceMemoryAllocError> where
I: IntoIterator<Item = QueueFamily<'a>>,
device: Arc<Device>,
usage: BufferUsage,
queue_families: I
) -> Result<Arc<CpuAccessibleBuffer<T>>, DeviceMemoryAllocError> where
I: IntoIterator<Item = QueueFamily<'a>>,
Builds a new uninitialized buffer. Only allowed for sized data.
impl<T> CpuAccessibleBuffer<[T]>
[src]
fn from_iter<'a, I, Q>(
device: Arc<Device>,
usage: BufferUsage,
queue_families: Q,
data: I
) -> Result<Arc<CpuAccessibleBuffer<[T]>>, DeviceMemoryAllocError> where
I: ExactSizeIterator<Item = T>,
T: Content + 'static,
Q: IntoIterator<Item = QueueFamily<'a>>,
device: Arc<Device>,
usage: BufferUsage,
queue_families: Q,
data: I
) -> Result<Arc<CpuAccessibleBuffer<[T]>>, DeviceMemoryAllocError> where
I: ExactSizeIterator<Item = T>,
T: Content + 'static,
Q: IntoIterator<Item = QueueFamily<'a>>,
Builds a new buffer that contains an array T
. The initial data comes from an iterator
that produces that list of Ts.
fn array<'a, I>(
device: Arc<Device>,
len: usize,
usage: BufferUsage,
queue_families: I
) -> Result<Arc<CpuAccessibleBuffer<[T]>>, DeviceMemoryAllocError> where
I: IntoIterator<Item = QueueFamily<'a>>,
device: Arc<Device>,
len: usize,
usage: BufferUsage,
queue_families: I
) -> Result<Arc<CpuAccessibleBuffer<[T]>>, DeviceMemoryAllocError> where
I: IntoIterator<Item = QueueFamily<'a>>,
Deprecated. Use uninitialized_array
or from_iter
instead.
unsafe fn uninitialized_array<'a, I>(
device: Arc<Device>,
len: usize,
usage: BufferUsage,
queue_families: I
) -> Result<Arc<CpuAccessibleBuffer<[T]>>, DeviceMemoryAllocError> where
I: IntoIterator<Item = QueueFamily<'a>>,
device: Arc<Device>,
len: usize,
usage: BufferUsage,
queue_families: I
) -> Result<Arc<CpuAccessibleBuffer<[T]>>, DeviceMemoryAllocError> where
I: IntoIterator<Item = QueueFamily<'a>>,
Builds a new buffer. Can be used for arrays.
impl<T: ?Sized> CpuAccessibleBuffer<T>
[src]
unsafe fn raw<'a, I>(
device: Arc<Device>,
size: usize,
usage: BufferUsage,
queue_families: I
) -> Result<Arc<CpuAccessibleBuffer<T>>, DeviceMemoryAllocError> where
I: IntoIterator<Item = QueueFamily<'a>>,
device: Arc<Device>,
size: usize,
usage: BufferUsage,
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
.
impl<T: ?Sized, A> CpuAccessibleBuffer<T, A>
[src]
fn queue_families(&self) -> Vec<QueueFamily>
Returns the queue families this buffer can be used on.
impl<T: ?Sized, A> CpuAccessibleBuffer<T, A> where
T: Content + 'static,
A: MemoryPoolAlloc,
[src]
T: Content + 'static,
A: MemoryPoolAlloc,
fn read(&self) -> Result<ReadLock<T>, ReadLockError>
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-exlusive accesses (ie. reads).
fn write(&self) -> Result<WriteLock<T>, WriteLockError>
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: Debug + ?Sized, A: Debug> Debug for CpuAccessibleBuffer<T, A>
[src]
impl<T: ?Sized, A> BufferAccess for CpuAccessibleBuffer<T, A> where
T: 'static + Send + Sync,
[src]
T: 'static + Send + Sync,
fn inner(&self) -> BufferInner
Returns the inner information about this buffer.
fn size(&self) -> usize
Returns the size of the buffer in bytes.
fn conflict_key(&self, self_offset: usize, self_size: usize) -> u64
Returns a key that uniquely identifies the range given by offset/size. Read more
fn try_gpu_lock(
&self,
exclusive_access: bool,
_: &Queue
) -> Result<(), AccessError>
&self,
exclusive_access: bool,
_: &Queue
) -> Result<(), AccessError>
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)
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)
Unlocks the resource previously acquired with try_gpu_lock
or increase_gpu_lock
. Read more
fn len(&self) -> usize where
Self: TypedBufferAccess,
Self::Content: Content,
Self: TypedBufferAccess,
Self::Content: Content,
Returns the length of the buffer in number of elements. Read more
fn as_buffer_slice(&self) -> BufferSlice<Self::Content, &Self> where
Self: Sized + TypedBufferAccess,
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]>,
Self: Sized + TypedBufferAccess<Content = [T]>,
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,
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]>,
Self: Sized + TypedBufferAccess<Content = [T]>,
Builds a BufferSlice
object holding part of the buffer by reference. Read more
fn conflicts_buffer(
&self,
self_offset: usize,
self_size: usize,
other: &BufferAccess,
other_offset: usize,
other_size: usize
) -> bool
&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
). Read more
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
&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
). Read more
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, A> TypedBufferAccess for CpuAccessibleBuffer<T, A> where
T: 'static + Send + Sync,
[src]
T: 'static + Send + Sync,
type Content = T
The type of the content.