wgsl_bindgen 0.22.0

Type safe Rust bindings workflow for wgsl shaders in wgpu
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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156

use std::sync::OnceLock;

use indexmap::{indexmap, indexset, IndexMap};
use miette::IntoDiagnostic;
use pretty_assertions::assert_eq;
use wgsl_bindgen::bevy_util::DependencyTree;
use wgsl_bindgen::SourceFilePath;

pub type SourceDependencyMap =
  IndexMap<SourceFilePath, IndexMap<&'static str, &'static str>>;

pub fn bevy_dependency_map() -> &'static SourceDependencyMap {
  static MEM: OnceLock<SourceDependencyMap> = OnceLock::new();
  MEM.get_or_init(|| {
    indexmap![
      SourceFilePath::new("tests/shaders/integration/bevy_pbr_wgsl/mesh.wgsl") => indexmap![
        "bevy_pbr::mesh_view_types"    => "tests/shaders/integration/bevy_pbr_wgsl/mesh_view_types.wgsl",
        "bevy_pbr::mesh_view_bindings" => "tests/shaders/integration/bevy_pbr_wgsl/mesh_view_bindings.wgsl",
        "bevy_pbr::mesh_types"         => "tests/shaders/integration/bevy_pbr_wgsl/mesh_types.wgsl",
        "bevy_pbr::mesh_bindings"      => "tests/shaders/integration/bevy_pbr_wgsl/mesh_bindings.wgsl",
        "bevy_pbr::mesh_functions"     => "tests/shaders/integration/bevy_pbr_wgsl/mesh_functions.wgsl",
        "bevy_pbr::mesh_vertex_output" => "tests/shaders/integration/bevy_pbr_wgsl/mesh_vertex_output.wgsl",
      ],
      SourceFilePath::new("tests/shaders/integration/bevy_pbr_wgsl/output_VERTEX_UVS.wgsl") => indexmap![],
      SourceFilePath::new("tests/shaders/integration/bevy_pbr_wgsl/pbr.wgsl") => indexmap![
        "bevy_pbr::mesh_vertex_output"  => "tests/shaders/integration/bevy_pbr_wgsl/mesh_vertex_output.wgsl",
        "bevy_pbr::pbr::types"          => "tests/shaders/integration/bevy_pbr_wgsl/pbr/types.wgsl",
        "bevy_pbr::mesh_types"          => "tests/shaders/integration/bevy_pbr_wgsl/mesh_types.wgsl",
        "bevy_pbr::mesh_bindings"       => "tests/shaders/integration/bevy_pbr_wgsl/mesh_bindings.wgsl",
        "bevy_pbr::mesh_view_types"     => "tests/shaders/integration/bevy_pbr_wgsl/mesh_view_types.wgsl",
        "bevy_pbr::mesh_view_bindings"  => "tests/shaders/integration/bevy_pbr_wgsl/mesh_view_bindings.wgsl",
        "bevy_pbr::utils"               => "tests/shaders/integration/bevy_pbr_wgsl/utils.wgsl",
        "bevy_pbr::pbr::lighting"       => "tests/shaders/integration/bevy_pbr_wgsl/pbr/lighting.wgsl",
        "bevy_pbr::clustered_forward"   => "tests/shaders/integration/bevy_pbr_wgsl/clustered_forward.wgsl",
        "bevy_pbr::shadows"             => "tests/shaders/integration/bevy_pbr_wgsl/shadows.wgsl",
        "bevy_pbr::pbr::functions"      => "tests/shaders/integration/bevy_pbr_wgsl/pbr/functions.wgsl",
        "bevy_pbr::pbr::bindings"       => "tests/shaders/integration/bevy_pbr_wgsl/pbr/bindings.wgsl",
      ],
      SourceFilePath::new("tests/shaders/integration/bevy_pbr_wgsl/wireframe.wgsl") => indexmap![
        "bevy_pbr::mesh_types"         => "tests/shaders/integration/bevy_pbr_wgsl/mesh_types.wgsl",
        "bevy_pbr::mesh_view_types"    => "tests/shaders/integration/bevy_pbr_wgsl/mesh_view_types.wgsl",
        "bevy_pbr::mesh_view_bindings" => "tests/shaders/integration/bevy_pbr_wgsl/mesh_view_bindings.wgsl",
        "bevy_pbr::skinning"           => "tests/shaders/integration/bevy_pbr_wgsl/skinning.wgsl",
        "bevy_pbr::mesh_functions"     => "tests/shaders/integration/bevy_pbr_wgsl/mesh_functions.wgsl",
      ],
    ]
  })
}

fn build_bevy_deptree() -> DependencyTree {
  DependencyTree::try_build(
    "tests/shaders/integration/bevy_pbr_wgsl".into(),
    Some("bevy_pbr".into()),
    vec![
      SourceFilePath::new("tests/shaders/integration/bevy_pbr_wgsl/mesh.wgsl"),
      SourceFilePath::new(
        "tests/shaders/integration/bevy_pbr_wgsl/output_VERTEX_UVS.wgsl",
      ),
      SourceFilePath::new("tests/shaders/integration/bevy_pbr_wgsl/pbr.wgsl"),
      SourceFilePath::new("tests/shaders/integration/bevy_pbr_wgsl/wireframe.wgsl"),
    ],
    vec![],
  )
  .into_diagnostic()
  .expect("build_bevy_deptree error")
}

#[test]
fn test_dependency_tree_file_enumeration() {
  let deptree = build_bevy_deptree();

  assert_eq!(
    indexset![
      SourceFilePath::new("tests/shaders/integration/bevy_pbr_wgsl/mesh.wgsl"),
      SourceFilePath::new(
        "tests/shaders/integration/bevy_pbr_wgsl/mesh_view_bindings.wgsl"
      ),
      SourceFilePath::new("tests/shaders/integration/bevy_pbr_wgsl/mesh_view_types.wgsl"),
      SourceFilePath::new("tests/shaders/integration/bevy_pbr_wgsl/mesh_bindings.wgsl"),
      SourceFilePath::new("tests/shaders/integration/bevy_pbr_wgsl/mesh_types.wgsl"),
      SourceFilePath::new("tests/shaders/integration/bevy_pbr_wgsl/mesh_functions.wgsl"),
      SourceFilePath::new(
        "tests/shaders/integration/bevy_pbr_wgsl/mesh_vertex_output.wgsl"
      ),
      SourceFilePath::new(
        "tests/shaders/integration/bevy_pbr_wgsl/output_VERTEX_UVS.wgsl"
      ),
      SourceFilePath::new("tests/shaders/integration/bevy_pbr_wgsl/pbr.wgsl"),
      SourceFilePath::new("tests/shaders/integration/bevy_pbr_wgsl/pbr/functions.wgsl"),
      SourceFilePath::new("tests/shaders/integration/bevy_pbr_wgsl/pbr/types.wgsl"),
      SourceFilePath::new("tests/shaders/integration/bevy_pbr_wgsl/pbr/lighting.wgsl"),
      SourceFilePath::new("tests/shaders/integration/bevy_pbr_wgsl/utils.wgsl"),
      SourceFilePath::new(
        "tests/shaders/integration/bevy_pbr_wgsl/clustered_forward.wgsl"
      ),
      SourceFilePath::new("tests/shaders/integration/bevy_pbr_wgsl/shadows.wgsl"),
      SourceFilePath::new("tests/shaders/integration/bevy_pbr_wgsl/pbr/bindings.wgsl"),
      SourceFilePath::new("tests/shaders/integration/bevy_pbr_wgsl/wireframe.wgsl"),
      SourceFilePath::new("tests/shaders/integration/bevy_pbr_wgsl/skinning.wgsl"),
    ],
    deptree.all_files_including_dependencies(),
  )
}

#[test]
fn test_dependency_tree_full_dependencies() {
  let expected = bevy_dependency_map();

  let deptree = build_bevy_deptree();
  let actual = deptree
    .get_source_files_with_full_dependencies()
    .into_iter()
    .map(|source| {
      let source_path = source.source_file.file_path.clone();
      let dependencies = source
        .full_dependencies
        .into_iter()
        .map(|dep| {
          let module_name = dep.module_name.as_ref().unwrap().as_str();
          let module_path = dep.file_path.to_str().unwrap();
          (module_name, module_path)
        })
        .collect::<IndexMap<_, _>>();
      (source_path, dependencies)
    })
    .collect::<IndexMap<_, _>>();

  assert_eq!(expected, &actual);
}

#[test]
fn test_dependency_tree_order() {
  let deptree = build_bevy_deptree();
  let deps = deptree
    .get_full_dependency_for(&SourceFilePath::new(
      "tests/shaders/integration/bevy_pbr_wgsl/mesh.wgsl",
    ))
    .into_iter()
    .collect::<Vec<_>>();

  assert_eq!(
    vec![
      SourceFilePath::new("tests/shaders/integration/bevy_pbr_wgsl/mesh_view_types.wgsl"),
      SourceFilePath::new(
        "tests/shaders/integration/bevy_pbr_wgsl/mesh_view_bindings.wgsl"
      ),
      SourceFilePath::new("tests/shaders/integration/bevy_pbr_wgsl/mesh_types.wgsl"),
      SourceFilePath::new("tests/shaders/integration/bevy_pbr_wgsl/mesh_bindings.wgsl"),
      SourceFilePath::new("tests/shaders/integration/bevy_pbr_wgsl/mesh_functions.wgsl"),
      SourceFilePath::new(
        "tests/shaders/integration/bevy_pbr_wgsl/mesh_vertex_output.wgsl"
      )
    ],
    deps
  );
}