Struct vulkano::buffer::immutable::ImmutableBuffer

pub struct ImmutableBuffer<T, A = PotentialDedicatedAllocation<StdMemoryPoolAlloc>> where
    T: BufferContents + ?Sized,  { /* private fields */ }

Buffer that is written once then read for as long as it is alive.

Implementations

impl<T> ImmutableBuffer<T> where
    T: BufferContents + ?Sized, 

pub fn from_buffer<B>(
    source: Arc<B>,
    usage: BufferUsage,
    queue: Arc<Queue>
) -> Result<(Arc<ImmutableBuffer<T>>, CommandBufferExecFuture<NowFuture, PrimaryAutoCommandBuffer>), DeviceMemoryAllocationError> where
    B: TypedBufferAccess<Content = T> + 'static, 

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> where
    T: BufferContents, 

pub fn from_data(
    data: T,
    usage: BufferUsage,
    queue: Arc<Queue>
) -> Result<(Arc<ImmutableBuffer<T>>, CommandBufferExecFuture<NowFuture, PrimaryAutoCommandBuffer>), DeviceMemoryAllocationError>

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.

Panics

• Panics if T has zero size.

pub unsafe fn uninitialized(
    device: Arc<Device>,
    usage: BufferUsage
) -> Result<(Arc<ImmutableBuffer<T>>, Arc<ImmutableBufferInitialization<T>>), DeviceMemoryAllocationError>

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.

Panics

• Panics if T has zero size.

impl<T> ImmutableBuffer<[T]> where
    [T]: BufferContents, 

pub fn from_iter<D>(
    data: D,
    usage: BufferUsage,
    queue: Arc<Queue>
) -> Result<(Arc<ImmutableBuffer<[T]>>, CommandBufferExecFuture<NowFuture, PrimaryAutoCommandBuffer>), DeviceMemoryAllocationError> where
    D: IntoIterator<Item = T>,
    D::IntoIter: ExactSizeIterator, 

Panics

• Panics if T has zero size.
• Panics if data is empty.

pub unsafe fn uninitialized_array(
    device: Arc<Device>,
    len: DeviceSize,
    usage: BufferUsage
) -> Result<(Arc<ImmutableBuffer<[T]>>, Arc<ImmutableBufferInitialization<[T]>>), DeviceMemoryAllocationError>

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.

Panics

• Panics if T has zero size.
• Panics if len is zero.

impl<T> ImmutableBuffer<T> where
    T: BufferContents + ?Sized, 

pub unsafe fn raw<'a, I>(
    device: Arc<Device>,
    size: DeviceSize,
    usage: BufferUsage,
    queue_families: I
) -> Result<(Arc<ImmutableBuffer<T>>, Arc<ImmutableBufferInitialization<T>>), DeviceMemoryAllocationError> 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.

Panics

• Panics if size is zero.

impl<T, A> ImmutableBuffer<T, A> where
    T: BufferContents + ?Sized, 

pub fn device(&self) -> &Arc<Device>

Returns the device used to create this buffer.

pub fn queue_families(&self) -> Vec<QueueFamily<'_>>

Returns the queue families this buffer can be used on.

Trait Implementations

impl<T, A> BufferAccess for ImmutableBuffer<T, A> where
    T: BufferContents + ?Sized,
    A: Send + Sync, 

fn inner(&self) -> BufferInner<'_>

Returns the inner information about this buffer.

fn size(&self) -> DeviceSize

Returns the size of the buffer in bytes.

fn conflict_key(&self) -> (u64, u64)

Returns a key that uniquely identifies the buffer. Two buffers or images that potentially overlap in memory must return the same key.

fn try_gpu_lock(
    &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.

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.

unsafe fn unlock(&self)

Unlocks the resource previously acquired with try_gpu_lock or increase_gpu_lock.

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]>, 

Returns a BufferSlice for a subrange of elements in the buffer. Returns None if out of range.

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.

fn raw_device_address(&self) -> Result<NonZeroU64, BufferDeviceAddressError>

Gets the device address for this buffer.

impl<T: Debug, A: Debug> Debug for ImmutableBuffer<T, A> where
    T: BufferContents + ?Sized, 

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T, A> DeviceOwned for ImmutableBuffer<T, A> where
    T: BufferContents + ?Sized, 

fn device(&self) -> &Arc<Device>

Returns the device that owns Self.

impl<T, A> Hash for ImmutableBuffer<T, A> where
    T: BufferContents + ?Sized,
    A: Send + Sync, 

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<T, A> PartialEq<ImmutableBuffer<T, A>> for ImmutableBuffer<T, A> where
    T: BufferContents + ?Sized,
    A: Send + Sync, 

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T, A> TypedBufferAccess for ImmutableBuffer<T, A> where
    T: BufferContents + ?Sized,
    A: Send + Sync, 

type Content = T

The type of the content.

fn len(&self) -> DeviceSize

Returns the length of the buffer in number of elements.

impl<T, A> Eq for ImmutableBuffer<T, A> where
    T: BufferContents + ?Sized,
    A: Send + Sync,