Struct wgsl_to_wgpu::WriteOptions

pub struct WriteOptions {
    pub derive_bytemuck_vertex: bool,
    pub derive_bytemuck_host_shareable: bool,
    pub derive_encase_host_shareable: bool,
    pub derive_serde: bool,
    pub matrix_vector_types: MatrixVectorTypes,
}

Options for configuring the generated bindings to work with additional dependencies. Use WriteOptions::default for only requiring WGPU itself.

Fields

derive_bytemuck_vertex: bool

Derive bytemuck::Pod and bytemuck::Zeroable for WGSL vertex input structs when true.

derive_bytemuck_host_shareable: bool

Derive bytemuck::Pod and bytemuck::Zeroable for user defined WGSL structs for host-shareable types (uniform and storage buffers) when true.

This will generate compile time assertions to check that the memory layout of structs and struct fields matches what is expected by WGSL. This does not account for all layout and alignment rules like storage buffer offset alignment.

Most applications should instead handle these requirements more reliably at runtime using encase.

derive_encase_host_shareable: bool

Derive encase::ShaderType for user defined WGSL structs for host-shareable types (uniform and storage buffers) when true. Use MatrixVectorTypes::Glam for best compatibility.

derive_serde: bool

Derive serde::Serialize and serde::Deserialize for user defined WGSL structs when true.

matrix_vector_types: MatrixVectorTypes

The format to use for matrix and vector types.

Trait Implementations

impl Clone for WriteOptions

fn clone(&self) -> WriteOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WriteOptions

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

Formats the value using the given formatter.

impl Default for WriteOptions

fn default() -> WriteOptions

Returns the “default value” for a type.

impl PartialEq for WriteOptions

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

impl Eq for WriteOptions

impl StructuralPartialEq for WriteOptions