Struct encase::ArrayLength

pub struct ArrayLength;

Helper type meant to be used together with the ShaderType derive macro

This type should be interpreted as an u32 in the shader

Problem

There are cases where the use of the WGSL function arrayLength() might be inadequate because of its return value

• being a minimum of 1 due to how minBindingSize is calculated

• possibly being higher than expected due to padding at the end of a struct or buffer being interpreted as array elements

• representing the capacity of the array for usecaseses that require oversized buffers

Solution

Using this type on a field of a struct with the ShaderType derive macro will automatically:

• on write, write the length of the contained runtime-sized array as an u32 to the buffer

• on read, read the value as an u32 from the buffer (rep as LEN) and when reading the elements of the contained runtime-sized array a max of LEN elements will be read

Trait Implementations

impl Clone for ArrayLength

fn clone(&self) -> ArrayLength

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CreateFrom for ArrayLength

fn create_from<B: BufferRef>(reader: &mut Reader<B>) -> Self

impl Debug for ArrayLength

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

Formats the value using the given formatter.

impl Default for ArrayLength

fn default() -> ArrayLength

Returns the “default value” for a type.

impl Ord for ArrayLength

fn cmp(&self, other: &ArrayLength) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for ArrayLength

fn eq(&self, other: &ArrayLength) -> 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 PartialOrd for ArrayLength

fn partial_cmp(&self, other: &ArrayLength) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl ReadFrom for ArrayLength

fn read_from<B: BufferRef>(&mut self, reader: &mut Reader<B>)

impl ShaderSize for ArrayLength

const SHADER_SIZE: NonZeroU64 = _

Represents WGSL Size (equivalent to ShaderType::min_size)

impl ShaderType for ArrayLength

fn min_size() -> NonZeroU64

Represents the minimum size of Self (equivalent to GPUBufferBindingLayout.minBindingSize)

fn size(&self) -> NonZeroU64

Returns the size of Self at runtime

fn assert_uniform_compat()

Asserts that Self meets the requirements of the uniform address space restrictions on stored values and the uniform address space layout constraints

impl WriteInto for ArrayLength

fn write_into<B: BufferMut>(&self, writer: &mut Writer<B>)

impl Copy for ArrayLength

impl Eq for ArrayLength

impl StructuralEq for ArrayLength

impl StructuralPartialEq for ArrayLength