Trait ShaderType 

pub trait ShaderType {
    // Provided methods
    fn min_size() -> NonZero<u64> { ... }
    fn size(&self) -> NonZero<u64> { ... }
    fn assert_uniform_compat() { ... }
}

Base trait for all WGSL host-shareable types

Provided Methods

fn min_size() -> NonZero<u64>

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

For WGSL fixed-footprint types it represents WGSL Size (equivalent to ShaderSize::SHADER_SIZE)

For WGSL runtime-sized arrays and WGSL structs containing runtime-sized arrays (non fixed-footprint types) this will be calculated by assuming the array has one element

fn size(&self) -> NonZero<u64>

Returns the size of Self at runtime

For WGSL fixed-footprint types it’s equivalent to Self::min_size and ShaderSize::SHADER_SIZE

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

Examples

Array

Will panic since runtime-sized arrays are not compatible with the uniform address space restrictions on stored values

<Vec<test_impl::Vec4f>>::assert_uniform_compat();

Will panic since the stride is 4 bytes

<[f32; 2]>::assert_uniform_compat();

Will not panic since the stride is 16 bytes

<[test_impl::Vec4f; 2]>::assert_uniform_compat();

Struct

Will panic since runtime-sized arrays are not compatible with the uniform address space restrictions on stored values

#[derive(ShaderType)]
struct Invalid {
    #[shader(size(runtime))]
    vec: Vec<test_impl::Vec4f>
}
Invalid::assert_uniform_compat();

Will panic since the inner struct’s size must be a multiple of 16

#[derive(ShaderType)]
struct S {
    x: f32,
}

#[derive(ShaderType)]
struct Invalid {
    a: f32,
    b: S, // offset between fields 'a' and 'b' must be at least 16 (currently: 4)
}
Invalid::assert_uniform_compat();

Will not panic (fixed via #[shader(align)] attribute)

#[derive(ShaderType)]
struct Valid {
    a: f32,
    #[shader(align(16))]
    b: S,
}
Valid::assert_uniform_compat();

Will not panic (fixed via size attribute)

#[derive(ShaderType)]
struct Valid {
    #[shader(size(16))]
    a: f32,
    b: S,
}
Valid::assert_uniform_compat();

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementations on Foreign Types

impl ShaderType for Atomic<i32>

impl ShaderType for Atomic<u32>

impl ShaderType for Option<NonZero<i32>>

impl ShaderType for Option<NonZero<u32>>

impl ShaderType for Wrapping<i32>

impl ShaderType for Wrapping<u32>

impl ShaderType for f32

impl ShaderType for i32

impl ShaderType for u32

impl<T, const N: usize> ShaderType for [T; N]

where T: ShaderType + ShaderSize,

impl<T> ShaderType for &T

where T: ShaderType + ?Sized,

fn size(&self) -> NonZero<u64>

impl<T> ShaderType for &mut T

where T: ShaderType + ?Sized,

fn size(&self) -> NonZero<u64>

impl<T> ShaderType for Cell<T>

where T: Copy + ShaderType,

fn size(&self) -> NonZero<u64>

impl<T> ShaderType for Cow<'_, T>

where T: ToOwned<Owned = T> + ShaderType + ?Sized,

fn size(&self) -> NonZero<u64>

impl<T> ShaderType for LinkedList<T>

where T: ShaderType + ShaderSize, LinkedList<T>: Length,

fn size(&self) -> NonZero<u64>

impl<T> ShaderType for Rc<T>

where T: ShaderType + ?Sized,

fn size(&self) -> NonZero<u64>

impl<T> ShaderType for VecDeque<T>

where T: ShaderType + ShaderSize, VecDeque<T>: Length,

fn size(&self) -> NonZero<u64>

impl<T> ShaderType for [T]

where T: ShaderType + ShaderSize, [T]: Length,

fn size(&self) -> NonZero<u64>

Implementors

impl ShaderType for ArrayLength

impl ShaderType for ColorGradingUniform

where Mat3: ShaderType + ShaderSize, Vec3: ShaderType + ShaderSize, Vec2: ShaderType + ShaderSize, f32: ShaderType + ShaderSize,

impl ShaderType for GlobalsUniform

where f32: ShaderType + ShaderSize, u32: ShaderType,

impl ShaderType for GpuBinMetadata

where u32: ShaderType + ShaderSize,

impl ShaderType for GpuBinUnpackingMetadata

where u32: ShaderType + ShaderSize, [u32; 61]: ShaderType,

impl ShaderType for GpuRenderBinnedMeshInstance

where u32: ShaderType + ShaderSize,

impl ShaderType for GpuUniformAllocationMetadata

where u32: ShaderType + ShaderSize, [u32; 60]: ShaderType,

impl ShaderType for IVec2

where i32: ShaderSize,

impl ShaderType for IVec3

where i32: ShaderSize,

impl ShaderType for IVec4

where i32: ShaderSize,

impl ShaderType for IndirectBatchSet

where u32: ShaderType + ShaderSize,

impl ShaderType for IndirectParametersBuildJob

where u32: ShaderType + ShaderSize, [UVec4; 15]: ShaderType,

impl ShaderType for IndirectParametersIndexed

where u32: ShaderType + ShaderSize,

impl ShaderType for IndirectParametersMetadata

where u32: ShaderType + ShaderSize,

impl ShaderType for IndirectParametersNonIndexed

where u32: ShaderType + ShaderSize,

impl ShaderType for LatePreprocessWorkItemIndirectParameters

where u32: ShaderType + ShaderSize, UVec4: ShaderType,

impl ShaderType for LinearRgba

Available on crate feature encase only.

impl ShaderType for Mat2

where f32: ShaderSize,

impl ShaderType for Mat3

where f32: ShaderSize,

impl ShaderType for Mat4

where f32: ShaderSize,

impl ShaderType for MeshMetadata

where Vec3: ShaderType + ShaderSize, u32: ShaderType + ShaderSize, [Vec4; 2]: ShaderType,

impl ShaderType for PreprocessWorkItem

where u32: ShaderType + ShaderSize,

impl ShaderType for UVec2

where u32: ShaderSize,

impl ShaderType for UVec3

where u32: ShaderSize,

impl ShaderType for UVec4

where u32: ShaderSize,

impl ShaderType for Vec2

where f32: ShaderSize,

impl ShaderType for Vec3

where f32: ShaderSize,

impl ShaderType for Vec4

where f32: ShaderSize,

impl ShaderType for ViewUniform

where Mat4: ShaderType + ShaderSize, Vec3: ShaderType + ShaderSize, f32: ShaderType + ShaderSize, Vec4: ShaderType + ShaderSize, [Vec4; 6]: ShaderType + ShaderSize, ColorGradingUniform: ShaderType + ShaderSize, u32: ShaderType,

impl<T> ShaderType for Arc<T>

where T: ShaderType + ?Sized,

impl<T> ShaderType for Box<T>

where T: ShaderType + ?Sized,

impl<T> ShaderType for Vec<T>

where T: ShaderType + ShaderSize, Vec<T>: Length,