Merge pull request #364 from armansito/pr-force_rw_storage-feature

[shaders] Option to force read_write access mode on all storage bindings
linebender · Sep 22, 2023 · ee3a076 · ee3a076
2 parents e121dd4 + d47dbfd
commit ee3a076
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 5 deletions.
diff --git a/crates/shaders/Cargo.toml b/crates/shaders/Cargo.toml
@@ -8,6 +8,17 @@ repository.workspace = true
 [features]
 default = ["compile", "wgsl", "msl"]
 compile = ["naga", "thiserror"]
+
+# Enabling this feature applies a transformation that converts all storage bindings
+# to have the `read_write` access mode. For WGSL shaders, this affects the bind group
+# layout of all pipelines and changes the usage scope of storage buffers. For MSL shaders,
+# this removes the `const` qualifier from entry-point parameters in the `device` address
+# space.
+#
+# Enabling this feature may have a performance impact and is not recommended.
+force_rw_storage = []
+
+# Target shading language variants of the vello shaders to link into the library.
 wgsl = []
 msl = []
 

diff --git a/crates/shaders/src/compile/preprocess.rs b/crates/shaders/src/compile/preprocess.rs
@@ -69,7 +69,10 @@ pub fn preprocess(
 
             match directive {
                 if_item @ ("ifdef" | "ifndef" | "else" | "endif") if !directive_is_at_start => {
-                    eprintln!("#{if_item} directives must be the first non_whitespace items on their line, ignoring (line {line_number})");
+                    eprintln!(
+                        "#{if_item} directives must be the first non_whitespace items on \
+                               their line, ignoring (line {line_number})"
+                    );
                     break;
                 }
                 def_test @ ("ifdef" | "ifndef") => {
@@ -87,15 +90,21 @@ pub fn preprocess(
                     let item = stack.last_mut();
                     if let Some(item) = item {
                         if item.else_passed {
-                            eprintln!("Second else for same ifdef/ifndef (line {line_number}); ignoring second else")
+                            eprintln!(
+                                "Second else for same ifdef/ifndef (line {line_number}); \
+                                       ignoring second else"
+                            )
                         } else {
                             item.else_passed = true;
                             item.active = !item.active;
                         }
                     }
                     let remainder = directive_start[directive_len..].trim();
                     if !remainder.is_empty() {
-                        eprintln!("#else directives don't take an argument. `{remainder}` will not be in output (line {line_number})");
+                        eprintln!(
+                            "#else directives don't take an argument. `{remainder}` will not \
+                                   be in output (line {line_number})"
+                        );
                     }
                     // Don't add this line to the output; it should be empty (see warning above)
                     continue 'all_lines;
@@ -106,7 +115,10 @@ pub fn preprocess(
                     }
                     let remainder = directive_start[directive_len..].trim();
                     if !remainder.is_empty() {
-                        eprintln!("#endif directives don't take an argument. `{remainder}` will not be in output (line {line_number})");
+                        eprintln!(
+                            "#endif directives don't take an argument. `{remainder}` will \
+                                   not be in output (line {line_number})"
+                        );
                     }
                     // Don't add this line to the output; it should be empty (see warning above)
                     continue 'all_lines;
@@ -132,7 +144,8 @@ pub fn preprocess(
                     let import = imports.get(import_name);
                     if let Some(import) = import {
                         // In theory, we can cache this until the top item of the stack changes
-                        // However, in practise there will only ever be at most 2 stack items, so it's reasonable to just recompute it every time
+                        // However, in practise there will only ever be at most 2 stack items, so
+                        // it's reasonable to just recompute it every time
                         if stack.iter().all(|item| item.active) {
                             output.push_str(&preprocess(import, defines, imports));
                         }
@@ -153,6 +166,14 @@ pub fn preprocess(
             if line.starts_with("let ") {
                 output.push_str("const");
                 output.push_str(&line[3..]);
+            } else if let Some(idx) = line.find("var<storage>") {
+                if cfg!(feature = "force_rw_storage") {
+                    let mut line = line.to_string();
+                    line.replace_range(idx..(idx + 12), "var<storage, read_write>");
+                    output.push_str(&line);
+                } else {
+                    output.push_str(line);
+                }
             } else {
                 output.push_str(line);
             }