feat!(wgcore): rename Shader::absolute_path to Shader::wgsl_path

Author: sebcrozet

Diff for: crates/wgcore-derive/src/lib.rs

@@ -77,7 +77,7 @@ pub fn derive_shader(item: TokenStream) -> TokenStream {
                 // First try to find a path from the shader registry.
                 // If doesn’t exist in the registry, try the absolute path.
                 // If it doesn’t exist in the absolute path, load the embedded string.
-                if let Some(path) = Self::absolute_path() {
+                if let Some(path) = Self::wgsl_path() {
                     // TODO: handle error
                     std::fs::read_to_string(path).unwrap()
                 } else {
@@ -139,7 +139,7 @@ pub fn derive_shader(item: TokenStream) -> TokenStream {
                         #naga_module
                     }
 
-                    fn absolute_path() -> Option<std::path::PathBuf> {
+                    fn wgsl_path() -> Option<std::path::PathBuf> {
                         if let Some(path) = wgcore::ShaderRegistry::get().get_path::<#struct_identifier>() {
                             Some(path.clone())
                         } else {
@@ -181,7 +181,7 @@ pub fn derive_shader(item: TokenStream) -> TokenStream {
                             #to_derive::watch_sources(state)?;
                         )*
 
-                        if let Some(path) = Self::absolute_path() {
+                        if let Some(path) = Self::wgsl_path() {
                             state.watch_file(&path)?;
                         }
 
@@ -195,7 +195,7 @@ pub fn derive_shader(item: TokenStream) -> TokenStream {
                             }
                         )*
 
-                        Self::absolute_path()
+                        Self::wgsl_path()
                             .map(|path| state.file_changed(&path))
                             .unwrap_or_default()
                     }

Diff for: crates/wgcore/CHANGELOG.md

@@ -7,6 +7,7 @@
 ### Changed
 
 - Rename `Shader::set_absolute_path` to `Shader::set_wgsl_path`.
+- Rename `Shader::absolute_path` to `Shader::wgsl_path`.
 - Workgroup memory automatic zeroing is now **disabled** by default due to its significant
   performance impact.
 

Diff for: crates/wgcore/src/shader.rs

@@ -15,7 +15,7 @@ use wgpu::{Device, Label, ShaderModule};
 /// To access the global shader registry, call [`ShaderRegistry::get`].
 /// Whenever a shader source is needed (e.g. as a dependency of another, for instantiating one
 /// of its kernel, for hot-reloading), the path registered in this map will take precedence in the
-/// automatically-generated implementation of [`Shader::absolute_path`]. If no path is provided
+/// automatically-generated implementation of [`Shader::wgsl_path`]. If no path is provided
 /// by this registry, the absolute path detected automatically by the `derive(Shader)` will be
 /// applied. If neither exist, the shader loading code will default to the shader sources that
 /// were embedded at the time of compilation of the module.
@@ -102,11 +102,11 @@ pub trait Shader: Sized + 'static {
         Ok(composer)
     }
 
-    /// The absolute path of this wgsl shader source file.
+    /// The path of this wgsl shader source file.
     ///
     /// This returns the path from the global [`ShaderRegistry`] if it was set. Otherwise, this returns
     /// the path automatically-computed by the `derive(Shader)`. If that failed too, returns `None`.
-    fn absolute_path() -> Option<PathBuf>;
+    fn wgsl_path() -> Option<PathBuf>;
 
     /// Registers in the global [`ShaderRegistry`] known path for this shader.
     ///