Struct vulkano::buffer::subbuffer::BufferContentsLayout

pub struct BufferContentsLayout(/* private fields */);

Describes the layout required for a type so that it can be read from/written to a buffer. This is used to allocate (sub)buffers generically.

This is similar to DeviceLayout except that this exists for the sole purpose of describing the layout of buffer contents specifically. Which means for example that the sizedness of the type is captured, as well as the layout of the head and tail if the layout is for unsized data, in order to be able to represent everything that Vulkan can stuff in a buffer.

BufferContentsLayout also has an additional invariant compared to DeviceLayout: the alignment of the data must not exceed 64. This is because that’s the guaranteed alignment that all DeviceMemory blocks must be aligned to at minimum, and hence any greater alignment can’t be guaranteed. Other than that, the invariant that sizes must be non-zero applies here as well, for both sized data and the element type of unsized data.

Implementations

impl BufferContentsLayout

pub const fn head_size(&self) -> DeviceSize

Returns the size of the head (sized part). If the data has no sized part, then this will return 0.

pub const fn element_size(&self) -> Option<DeviceSize>

Returns the size of the element type if the data is unsized, or returns None. Guaranteed to be non-zero.

pub const fn alignment(&self) -> DeviceAlignment

Returns the alignment required for the data. Guaranteed to not exceed 64.

pub const fn layout_for_len( &self, len: NonZeroDeviceSize ) -> Option<DeviceLayout>

Returns the DeviceLayout for the data for the given len, or returns None on arithmetic overflow or if the total size would exceed DeviceLayout::MAX_SIZE.

Trait Implementations

impl Clone for BufferContentsLayout

fn clone(&self) -> BufferContentsLayout

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BufferContentsLayout

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

Formats the value using the given formatter.

impl Hash for BufferContentsLayout

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for BufferContentsLayout

fn eq(&self, other: &BufferContentsLayout) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for BufferContentsLayout

impl Eq for BufferContentsLayout

impl StructuralEq for BufferContentsLayout

impl StructuralPartialEq for BufferContentsLayout