Struct SpecialTypes

pub struct SpecialTypes {
    pub ray_desc: Option<Handle<Type>>,
    pub ray_intersection: Option<Handle<Type>>,
    pub ray_vertex_return: Option<Handle<Type>>,
    pub external_texture_params: Option<Handle<Type>>,
    pub external_texture_transfer_function: Option<Handle<Type>>,
    pub predeclared_types: FastIndexMap<PredeclaredType, Handle<Type>>,
}

Set of special types that can be optionally generated by the frontends.

Fields

ray_desc: Option<Handle<Type>>

Type for RayDesc.

Call Module::generate_ray_desc_type to populate this if needed and return the handle.

ray_intersection: Option<Handle<Type>>

Type for RayIntersection.

Call Module::generate_ray_intersection_type to populate this if needed and return the handle.

ray_vertex_return: Option<Handle<Type>>

Type for RayVertexReturn.

Call Module::generate_vertex_return_type

external_texture_params: Option<Handle<Type>>

Struct containing parameters required by some backends to emit code for ImageClass::External textures.

See wgpu_core::device::resource::ExternalTextureParams for the documentation of each field.

In WGSL, this type would be:

struct NagaExternalTextureParams {         // align size offset
    yuv_conversion_matrix: mat4x4<f32>,    //    16   64      0
    gamut_conversion_matrix: mat3x3<f32>,  //    16   48     64
    src_tf: NagaExternalTextureTransferFn, //     4   16    112
    dst_tf: NagaExternalTextureTransferFn, //     4   16    128
    sample_transform: mat3x2<f32>,         //     8   24    144
    load_transform: mat3x2<f32>,           //     8   24    168
    size: vec2<u32>,                       //     8    8    192
    num_planes: u32,                       //     4    4    200
}                            // whole struct:    16  208

Call Module::generate_external_texture_types to populate this if needed.

external_texture_transfer_function: Option<Handle<Type>>

Struct describing a gamma encoding transfer function. Member of NagaExternalTextureParams, describing how the backend should perform color space conversion when sampling from ImageClass::External textures.

In WGSL, this type would be:

struct NagaExternalTextureTransferFn { // align size offset
    a: f32,                            //     4    4      0
    b: f32,                            //     4    4      4
    g: f32,                            //     4    4      8
    k: f32,                            //     4    4     12
}                         // whole struct:    4   16

Call Module::generate_external_texture_types to populate this if needed.

predeclared_types: FastIndexMap<PredeclaredType, Handle<Type>>

Types for predeclared wgsl types instantiated on demand.

Call Module::generate_predeclared_type to populate this if needed and return the handle.

Trait Implementations

impl<'arbitrary> Arbitrary<'arbitrary> for SpecialTypes

fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl Clone for SpecialTypes

fn clone(&self) -> SpecialTypes

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SpecialTypes

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

Formats the value using the given formatter.

impl Default for SpecialTypes

fn default() -> SpecialTypes

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SpecialTypes

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SpecialTypes

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.