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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128

use std::str::FromStr;
use wgsldoc::models::types::{ImportModule, PathType, Primitive, Type, Vector, VectorDimension};

#[test]
fn test_primitive_display() {
    assert_eq!(format!("{}", Primitive::Bool), "bool");
    assert_eq!(format!("{}", Primitive::Float32), "f32");
    assert_eq!(format!("{}", Primitive::Float64), "f64");
    assert_eq!(format!("{}", Primitive::Uint8), "u8");
    assert_eq!(format!("{}", Primitive::Uint16), "u16");
    assert_eq!(format!("{}", Primitive::Uint32), "u32");
    assert_eq!(format!("{}", Primitive::Uint64), "u64");
    assert_eq!(format!("{}", Primitive::Sint8), "i8");
    assert_eq!(format!("{}", Primitive::Sint16), "i16");
    assert_eq!(format!("{}", Primitive::Sint32), "i32");
    assert_eq!(format!("{}", Primitive::Sint64), "i64");
}

#[test]
fn test_primitive_from_str() {
    assert!(matches!(Primitive::from_str("bool"), Ok(Primitive::Bool)));
    assert!(matches!(Primitive::from_str("f32"), Ok(Primitive::Float32)));
    assert!(matches!(Primitive::from_str("f64"), Ok(Primitive::Float64)));
    assert!(matches!(Primitive::from_str("u32"), Ok(Primitive::Uint32)));
    assert!(matches!(Primitive::from_str("i32"), Ok(Primitive::Sint32)));
    assert!(Primitive::from_str("invalid").is_err());
}

#[test]
fn test_vector_display() {
    let vec2 = Vector::new(VectorDimension::D2, Primitive::Float32);
    assert_eq!(format!("{}", vec2), "vec2<f32>");

    let vec3 = Vector::new(VectorDimension::D3, Primitive::Float32);
    assert_eq!(format!("{}", vec3), "vec3<f32>");

    let vec4 = Vector::new(VectorDimension::D4, Primitive::Float32);
    assert_eq!(format!("{}", vec4), "vec4<f32>");
}

#[test]
fn test_vector_dimension_from_str() {
    assert!(matches!(
        VectorDimension::from_str("2"),
        Ok(VectorDimension::D2)
    ));
    assert!(matches!(
        VectorDimension::from_str("3"),
        Ok(VectorDimension::D3)
    ));
    assert!(matches!(
        VectorDimension::from_str("4"),
        Ok(VectorDimension::D4)
    ));
    assert!(VectorDimension::from_str("5").is_err());
}

#[test]
fn test_path_type_new() {
    let path = PathType::new(None, "Camera".to_string());
    assert_eq!(path.name(), "Camera");
    assert!(path.module().is_none());
    assert_eq!(*path.import_module(), ImportModule::Undefined);
}

#[test]
fn test_path_type_with_module() {
    let path = PathType::new(Some("Utils".to_string()), "Camera".to_string());
    assert_eq!(path.name(), "Camera");
    assert_eq!(path.module(), Some("Utils"));
    assert_eq!(*path.import_module(), ImportModule::Undefined);
}

#[test]
fn test_rendered_type_primitive() {
    let ty = Type::Primitive(Primitive::Float32);
    let rendered = ty.rendered_type(&[], false);
    assert_eq!(rendered.name, "f32");
    assert!(!rendered.is_function_pointer);
    assert!(rendered.import.is_none());
}

#[test]
fn test_rendered_type_vector() {
    let ty = Type::Vector(Vector::new(VectorDimension::D3, Primitive::Float32));
    let rendered = ty.rendered_type(&[], false);
    assert_eq!(rendered.name, "vec3<f32>");
    assert!(!rendered.is_function_pointer);
}

#[test]
fn test_rendered_type_path() {
    let ty = Type::Path(PathType::new(None, "Camera".to_string()));
    let rendered = ty.rendered_type(&[], false);
    assert_eq!(rendered.name, "Camera");
    assert!(rendered.module.is_none());
    assert!(!rendered.is_this);
}

#[test]
fn test_rendered_type_function_pointer() {
    let ty = Type::Primitive(Primitive::Float32);
    let rendered = ty.rendered_type(&[], true);
    assert!(rendered.is_function_pointer);
}

#[test]
fn test_import_module_equality() {
    assert_eq!(ImportModule::Undefined, ImportModule::Undefined);
    assert_eq!(
        ImportModule::Named("Test".to_string()),
        ImportModule::Named("Test".to_string())
    );
    assert_eq!(ImportModule::This, ImportModule::This);
    assert_ne!(ImportModule::Undefined, ImportModule::This);
}

#[test]
fn test_type_default() {
    let ty = Type::default();
    match ty {
        Type::Primitive(p) => match p {
            Primitive::Sint32 => {}
            _ => panic!("Expected default to be Sint32"),
        },
        _ => panic!("Expected default type to be Primitive"),
    }
}