[−][src]Struct vulkano::buffer::immutable::ImmutableBuffer
Buffer that is written once then read for as long as it is alive.
Implementations
impl<T: ?Sized> ImmutableBuffer<T>
[src]
pub fn from_data(
data: T,
usage: BufferUsage,
queue: Arc<Queue>
) -> Result<(Arc<ImmutableBuffer<T>>, CommandBufferExecFuture<NowFuture, AutoCommandBuffer>), DeviceMemoryAllocError> where
T: 'static + Send + Sync + Sized,
[src]
data: T,
usage: BufferUsage,
queue: Arc<Queue>
) -> Result<(Arc<ImmutableBuffer<T>>, CommandBufferExecFuture<NowFuture, AutoCommandBuffer>), DeviceMemoryAllocError> where
T: 'static + Send + Sync + Sized,
Builds an ImmutableBuffer
from some data.
This function builds a memory-mapped intermediate buffer, writes the data to it, builds a command buffer that copies from this intermediate buffer to the final buffer, and finally submits the command buffer as a future.
This function returns two objects: the newly-created buffer, and a future representing
the initial upload operation. In order to be allowed to use the ImmutableBuffer
, you must
either submit your operation after this future, or execute this future and wait for it to
be finished before submitting your own operation.
pub fn from_buffer<B>(
source: B,
usage: BufferUsage,
queue: Arc<Queue>
) -> Result<(Arc<ImmutableBuffer<T>>, CommandBufferExecFuture<NowFuture, AutoCommandBuffer>), DeviceMemoryAllocError> where
B: BufferAccess + TypedBufferAccess<Content = T> + 'static + Clone + Send + Sync,
T: 'static + Send + Sync,
[src]
source: B,
usage: BufferUsage,
queue: Arc<Queue>
) -> Result<(Arc<ImmutableBuffer<T>>, CommandBufferExecFuture<NowFuture, AutoCommandBuffer>), DeviceMemoryAllocError> where
B: BufferAccess + TypedBufferAccess<Content = T> + 'static + Clone + Send + Sync,
T: 'static + Send + Sync,
Builds an ImmutableBuffer
that copies its data from another buffer.
This function returns two objects: the newly-created buffer, and a future representing
the initial upload operation. In order to be allowed to use the ImmutableBuffer
, you must
either submit your operation after this future, or execute this future and wait for it to
be finished before submitting your own operation.
impl<T> ImmutableBuffer<T>
[src]
pub unsafe fn uninitialized(
device: Arc<Device>,
usage: BufferUsage
) -> Result<(Arc<ImmutableBuffer<T>>, ImmutableBufferInitialization<T>), DeviceMemoryAllocError>
[src]
device: Arc<Device>,
usage: BufferUsage
) -> Result<(Arc<ImmutableBuffer<T>>, ImmutableBufferInitialization<T>), DeviceMemoryAllocError>
Builds a new buffer with uninitialized data. Only allowed for sized data.
Returns two things: the buffer, and a special access that should be used for the initial upload to the buffer.
You will get an error if you try to use the buffer before using the initial upload access. However this function doesn't check whether you actually used this initial upload to fill the buffer like you're supposed to do.
You will also get an error if you try to get exclusive access to the final buffer.
Safety
- The
ImmutableBufferInitialization
should be used to fill the buffer with some initial data, otherwise the content is undefined.
impl<T> ImmutableBuffer<[T]>
[src]
pub fn from_iter<D>(
data: D,
usage: BufferUsage,
queue: Arc<Queue>
) -> Result<(Arc<ImmutableBuffer<[T]>>, CommandBufferExecFuture<NowFuture, AutoCommandBuffer>), DeviceMemoryAllocError> where
D: ExactSizeIterator<Item = T>,
T: 'static + Send + Sync + Sized,
[src]
data: D,
usage: BufferUsage,
queue: Arc<Queue>
) -> Result<(Arc<ImmutableBuffer<[T]>>, CommandBufferExecFuture<NowFuture, AutoCommandBuffer>), DeviceMemoryAllocError> where
D: ExactSizeIterator<Item = T>,
T: 'static + Send + Sync + Sized,
pub unsafe fn uninitialized_array(
device: Arc<Device>,
len: usize,
usage: BufferUsage
) -> Result<(Arc<ImmutableBuffer<[T]>>, ImmutableBufferInitialization<[T]>), DeviceMemoryAllocError>
[src]
device: Arc<Device>,
len: usize,
usage: BufferUsage
) -> Result<(Arc<ImmutableBuffer<[T]>>, ImmutableBufferInitialization<[T]>), DeviceMemoryAllocError>
Builds a new buffer with uninitialized data. Can be used for arrays.
Returns two things: the buffer, and a special access that should be used for the initial upload to the buffer.
You will get an error if you try to use the buffer before using the initial upload access. However this function doesn't check whether you actually used this initial upload to fill the buffer like you're supposed to do.
You will also get an error if you try to get exclusive access to the final buffer.
Safety
- The
ImmutableBufferInitialization
should be used to fill the buffer with some initial data, otherwise the content is undefined.
impl<T: ?Sized> ImmutableBuffer<T>
[src]
pub unsafe fn raw<'a, I>(
device: Arc<Device>,
size: usize,
usage: BufferUsage,
queue_families: I
) -> Result<(Arc<ImmutableBuffer<T>>, ImmutableBufferInitialization<T>), DeviceMemoryAllocError> where
I: IntoIterator<Item = QueueFamily<'a>>,
[src]
device: Arc<Device>,
size: usize,
usage: BufferUsage,
queue_families: I
) -> Result<(Arc<ImmutableBuffer<T>>, ImmutableBufferInitialization<T>), DeviceMemoryAllocError> where
I: IntoIterator<Item = QueueFamily<'a>>,
Builds a new buffer without checking the size and granting free access for the initial upload.
Returns two things: the buffer, and a special access that should be used for the initial upload to the buffer. You will get an error if you try to use the buffer before using the initial upload access. However this function doesn't check whether you used this initial upload to fill the buffer. You will also get an error if you try to get exclusive access to the final buffer.
Safety
- You must ensure that the size that you pass is correct for
T
. - The
ImmutableBufferInitialization
should be used to fill the buffer with some initial data.
impl<T: ?Sized, A> ImmutableBuffer<T, A>
[src]
pub fn device(&self) -> &Arc<Device>
[src]
Returns the device used to create this buffer.
pub fn queue_families(&self) -> Vec<QueueFamily<'_>>
[src]
Returns the queue families this buffer can be used on.
Trait Implementations
impl<T: ?Sized, A> BufferAccess for ImmutableBuffer<T, A>
[src]
pub fn inner(&self) -> BufferInner<'_>
[src]
pub fn size(&self) -> usize
[src]
pub fn conflicts_buffer(&self, other: &dyn BufferAccess) -> bool
[src]
pub fn conflicts_image(&self, other: &dyn ImageAccess) -> bool
[src]
pub fn conflict_key(&self) -> (u64, usize)
[src]
pub fn try_gpu_lock(
&self,
exclusive_access: bool,
_: &Queue
) -> Result<(), AccessError>
[src]
&self,
exclusive_access: bool,
_: &Queue
) -> Result<(), AccessError>
pub unsafe fn increase_gpu_lock(&self)
[src]
pub unsafe fn unlock(&self)
[src]
pub fn as_buffer_slice(&self) -> BufferSlice<Self::Content, &Self> where
Self: Sized + TypedBufferAccess,
[src]
Self: Sized + TypedBufferAccess,
pub fn slice<T>(&self, range: Range<usize>) -> Option<BufferSlice<[T], &Self>> where
Self: Sized + TypedBufferAccess<Content = [T]>,
[src]
Self: Sized + TypedBufferAccess<Content = [T]>,
pub fn into_buffer_slice(self) -> BufferSlice<Self::Content, Self> where
Self: Sized + TypedBufferAccess,
[src]
Self: Sized + TypedBufferAccess,
pub fn index<T>(&self, index: usize) -> Option<BufferSlice<[T], &Self>> where
Self: Sized + TypedBufferAccess<Content = [T]>,
[src]
Self: Sized + TypedBufferAccess<Content = [T]>,
pub fn raw_device_address(
&self
) -> Result<NonZeroU64, DeviceAddressUsageNotEnabledError>
[src]
&self
) -> Result<NonZeroU64, DeviceAddressUsageNotEnabledError>
impl<T: ?Sized, A> DeviceOwned for ImmutableBuffer<T, A>
[src]
impl<T: ?Sized, A> Eq for ImmutableBuffer<T, A>
[src]
impl<T: ?Sized, A> Hash for ImmutableBuffer<T, A>
[src]
pub fn hash<H: Hasher>(&self, state: &mut H)
[src]
pub fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
impl<T: ?Sized, A> PartialEq<ImmutableBuffer<T, A>> for ImmutableBuffer<T, A>
[src]
pub fn eq(&self, other: &Self) -> bool
[src]
#[must_use]pub fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
impl<T: ?Sized, A> TypedBufferAccess for ImmutableBuffer<T, A>
[src]
Auto Trait Implementations
impl<T: ?Sized, A> RefUnwindSafe for ImmutableBuffer<T, A> where
A: RefUnwindSafe,
T: RefUnwindSafe,
[src]
A: RefUnwindSafe,
T: RefUnwindSafe,
impl<T: ?Sized, A> Send for ImmutableBuffer<T, A> where
A: Send,
T: Send,
[src]
A: Send,
T: Send,
impl<T: ?Sized, A> Sync for ImmutableBuffer<T, A> where
A: Sync,
T: Sync,
[src]
A: Sync,
T: Sync,
impl<T: ?Sized, A> Unpin for ImmutableBuffer<T, A> where
A: Unpin,
[src]
A: Unpin,
impl<T: ?Sized, A> UnwindSafe for ImmutableBuffer<T, A> where
A: UnwindSafe,
T: UnwindSafe,
[src]
A: UnwindSafe,
T: UnwindSafe,
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Content for T
[src]
pub fn ref_from_ptr(*mut c_void, usize) -> Option<*mut T>
[src]
pub fn is_size_suitable(usize) -> bool
[src]
pub fn indiv_size() -> usize
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,