Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Merged by Bors] - Move import_path definitions into shader source #3976

Closed
wants to merge 1 commit into from
Closed

[Merged by Bors] - Move import_path definitions into shader source #3976

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions crates/bevy_pbr/src/render/mesh.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,11 @@ impl Plugin for MeshRenderPlugin {
);
shaders.set_untracked(
MESH_STRUCT_HANDLE,
Shader::from_wgsl(include_str!("mesh_struct.wgsl"))
.with_import_path("bevy_pbr::mesh_struct"),
Shader::from_wgsl(include_str!("mesh_struct.wgsl")),
);
shaders.set_untracked(
MESH_VIEW_BIND_GROUP_HANDLE,
Shader::from_wgsl(include_str!("mesh_view_bind_group.wgsl"))
.with_import_path("bevy_pbr::mesh_view_bind_group"),
Shader::from_wgsl(include_str!("mesh_view_bind_group.wgsl")),
);

app.add_plugin(UniformComponentPlugin::<MeshUniform>::default());
Expand Down
2 changes: 2 additions & 0 deletions crates/bevy_pbr/src/render/mesh_struct.wgsl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
#define_import_path bevy_pbr::mesh_struct

struct Mesh {
model: mat4x4<f32>;
inverse_transpose_model: mat4x4<f32>;
Expand Down
2 changes: 2 additions & 0 deletions crates/bevy_pbr/src/render/mesh_view_bind_group.wgsl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
#define_import_path bevy_pbr::mesh_view_bind_group

struct View {
view_proj: mat4x4<f32>;
view: mat4x4<f32>;
Expand Down
64 changes: 45 additions & 19 deletions crates/bevy_render/src/render_resource/shader.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,27 +45,29 @@ pub struct Shader {
impl Shader {
pub fn from_wgsl(source: impl Into<Cow<'static, str>>) -> Shader {
let source = source.into();
let shader_imports = SHADER_IMPORT_PROCESSOR.get_imports_from_str(&source);
Shader {
imports: SHADER_IMPORT_PROCESSOR.get_imports_from_str(&source),
imports: shader_imports.imports,
import_path: shader_imports.import_path,
source: Source::Wgsl(source),
import_path: None,
}
}

pub fn from_glsl(source: impl Into<Cow<'static, str>>, stage: naga::ShaderStage) -> Shader {
let source = source.into();
let shader_imports = SHADER_IMPORT_PROCESSOR.get_imports_from_str(&source);
Shader {
imports: SHADER_IMPORT_PROCESSOR.get_imports_from_str(&source),
imports: shader_imports.imports,
import_path: shader_imports.import_path,
source: Source::Glsl(source, stage),
import_path: None,
}
}

pub fn from_spirv(source: impl Into<Cow<'static, [u8]>>) -> Shader {
Shader {
imports: Vec::new(),
source: Source::SpirV(source.into()),
import_path: None,
source: Source::SpirV(source.into()),
}
}

Expand Down Expand Up @@ -238,12 +240,16 @@ impl AssetLoader for ShaderLoader {
_ => panic!("unhandled extension: {}", ext),
};

shader.import_path = Some(ShaderImport::AssetPath(
load_context.path().to_string_lossy().to_string(),
));
let imports = SHADER_IMPORT_PROCESSOR.get_imports(&shader);
let shader_imports = SHADER_IMPORT_PROCESSOR.get_imports(&shader);
if shader_imports.import_path.is_some() {
shader.import_path = shader_imports.import_path;
} else {
shader.import_path = Some(ShaderImport::AssetPath(
load_context.path().to_string_lossy().to_string(),
));
}
let mut asset = LoadedAsset::new(shader);
for import in imports {
for import in shader_imports.imports {
if let ShaderImport::AssetPath(asset_path) = import {
let path = PathBuf::from_str(&asset_path)?;
asset.add_dependency(path.into());
Expand Down Expand Up @@ -281,6 +287,7 @@ pub enum ProcessShaderError {
pub struct ShaderImportProcessor {
import_asset_path_regex: Regex,
import_custom_path_regex: Regex,
define_import_path_regex: Regex,
}

#[derive(Debug, PartialEq, Eq, Clone, Hash)]
Expand All @@ -292,34 +299,48 @@ pub enum ShaderImport {
impl Default for ShaderImportProcessor {
fn default() -> Self {
Self {
import_asset_path_regex: Regex::new(r#"^\s*#\s*import\s*"(.+)""#).unwrap(),
import_custom_path_regex: Regex::new(r"^\s*#\s*import\s*(.+)").unwrap(),
import_asset_path_regex: Regex::new(r#"^\s*#\s*import\s+"(.+)""#).unwrap(),
import_custom_path_regex: Regex::new(r"^\s*#\s*import\s+(.+)").unwrap(),
define_import_path_regex: Regex::new(r"^\s*#\s*define_import_path\s+(.+)").unwrap(),
}
}
}

#[derive(Default)]
pub struct ShaderImports {
imports: Vec<ShaderImport>,
import_path: Option<ShaderImport>,
}

impl ShaderImportProcessor {
pub fn get_imports(&self, shader: &Shader) -> Vec<ShaderImport> {
pub fn get_imports(&self, shader: &Shader) -> ShaderImports {
match &shader.source {
Source::Wgsl(source) => self.get_imports_from_str(source),
Source::Glsl(source, _stage) => self.get_imports_from_str(source),
Source::SpirV(_source) => Vec::new(),
Source::SpirV(_source) => ShaderImports::default(),
}
}

pub fn get_imports_from_str(&self, shader: &str) -> Vec<ShaderImport> {
let mut imports = Vec::new();
pub fn get_imports_from_str(&self, shader: &str) -> ShaderImports {
let mut shader_imports = ShaderImports::default();
for line in shader.lines() {
if let Some(cap) = self.import_asset_path_regex.captures(line) {
let import = cap.get(1).unwrap();
imports.push(ShaderImport::AssetPath(import.as_str().to_string()));
shader_imports
.imports
.push(ShaderImport::AssetPath(import.as_str().to_string()));
} else if let Some(cap) = self.import_custom_path_regex.captures(line) {
let import = cap.get(1).unwrap();
imports.push(ShaderImport::Custom(import.as_str().to_string()));
shader_imports
.imports
.push(ShaderImport::Custom(import.as_str().to_string()));
} else if let Some(cap) = self.define_import_path_regex.captures(line) {
let path = cap.get(1).unwrap();
shader_imports.import_path = Some(ShaderImport::Custom(path.as_str().to_string()));
}
}

imports
shader_imports
}
}

Expand Down Expand Up @@ -413,6 +434,11 @@ impl ShaderProcessor {
shader_defs,
&mut final_string,
)?;
} else if SHADER_IMPORT_PROCESSOR
.define_import_path_regex
.is_match(line)
{
// ignore import path lines
} else if *scopes.last().unwrap() {
final_string.push_str(line);
final_string.push('\n');
Expand Down
6 changes: 2 additions & 4 deletions crates/bevy_sprite/src/mesh2d/mesh.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,13 +50,11 @@ impl Plugin for Mesh2dRenderPlugin {
);
shaders.set_untracked(
MESH2D_STRUCT_HANDLE,
Shader::from_wgsl(include_str!("mesh2d_struct.wgsl"))
.with_import_path("bevy_sprite::mesh2d_struct"),
Shader::from_wgsl(include_str!("mesh2d_struct.wgsl")),
);
shaders.set_untracked(
MESH2D_VIEW_BIND_GROUP_HANDLE,
Shader::from_wgsl(include_str!("mesh2d_view_bind_group.wgsl"))
.with_import_path("bevy_sprite::mesh2d_view_bind_group"),
Shader::from_wgsl(include_str!("mesh2d_view_bind_group.wgsl")),
);

app.add_plugin(UniformComponentPlugin::<Mesh2dUniform>::default());
Expand Down
2 changes: 2 additions & 0 deletions crates/bevy_sprite/src/mesh2d/mesh2d_struct.wgsl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
#define_import_path bevy_sprite::mesh2d_struct

struct Mesh2d {
model: mat4x4<f32>;
inverse_transpose_model: mat4x4<f32>;
Expand Down
2 changes: 2 additions & 0 deletions crates/bevy_sprite/src/mesh2d/mesh2d_view_bind_group.wgsl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
#define_import_path bevy_sprite::mesh2d_view_bind_group

struct View {
view_proj: mat4x4<f32>;
view: mat4x4<f32>;
Expand Down