wgsldoc 1.0.1

Documentation generator for WGSL shaders
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

//! Binding model module used for parsing and representing WGSL bindings.
//! Used for generating bindings documentation.

use serde::Serialize;
use crate::{
    impl_eq_name,
    models::{
        import::{Import, RegisterImports},
        types::{RenderedType, Type},
    },
};

/// Represents a binding in a shader module. Example:
/// ```wgsl
/// @group(0) @binding(1) var<uniform> myBinding: MyType;
/// ```
#[derive(Debug)]
pub struct Binding {
    docs: Option<String>,
    attr_group: u16,
    attr_binding: u16,
    name: String,
    ty: Type,
}

impl RegisterImports for Binding {
    fn register_imports(&mut self, imports: &[Import]) {
        if let Type::Path(ref mut ty) = &mut self.ty {
            ty.register_imports(imports)
        }
    }

    fn register_same_module_types(&mut self, type_names: &[String]) {
        if let Type::Path(ref mut ty) = &mut self.ty {
            ty.register_same_module_types(type_names)
        }
    }
}

impl_eq_name!(Binding::name);

/// A serializable representation of a binding for rendering purposes used in Tera.
#[derive(Debug, Serialize)]
pub struct RenderedBinding {
    docs: Option<String>,
    attr_group: u16,
    attr_binding: u16,
    name: String,
    ty: RenderedType,
}

impl Binding {
    /// Creates a new Binding instance (usually from parsed elements).
    pub fn new(
        docs: Option<String>,
        attr_group: u16,
        attr_binding: u16,
        name: String,
        ty: Type,
    ) -> Binding {
        Binding {
            docs,
            attr_group,
            attr_binding,
            name,
            ty,
        }
    }

    /// Get field `docs` from instance of `Binding`.
    pub fn docs(&self) -> Option<&str> {
        self.docs.as_deref()
    }

    /// Get field `name` from instance of `Binding`.
    pub fn name(&self) -> &str {
        &self.name
    }

    /// Get field `type` from instance of `Binding`.
    pub fn binding_type(&self) -> &Type {
        &self.ty
    }

    /// Renders the binding into a serializable form for templates.
    pub fn rendered(&self, imports: &[Import]) -> RenderedBinding {
        RenderedBinding {
            docs: self.docs.clone(),
            attr_group: self.attr_group,
            attr_binding: self.attr_binding,
            name: self.name.clone(),
            ty: self.binding_type().rendered_type(imports, false),
        }
    }
}