Embed shaders into crate (#5)

Author: evroon

Cargo.lock

@@ -3,7 +3,7 @@ name = "bevy-volumetric-clouds"
 description = "A plugin for Bevy that renders clouds using raymarching"
 repository = "https://github.com/evroon/bevy-volumetric-clouds"
 readme = "README.md"
-version = "0.1.1"
+version = "0.1.2"
 publish = true
 authors = ["evroon"]
 edition = "2024"
@@ -12,8 +12,7 @@ keywords = ["bevy", "gamedev", "clouds", "volumetric-clouds", "raymarching"]
 categories = ["game-development"]
 
 [features]
-# dev = ["bevy/dynamic_linking"]
-dev = ["bevy/file_watcher"]
+dev = ["bevy/dynamic_linking", "bevy/file_watcher", "bevy/embedded_watcher"]
 debug = ["bevy/debug", "bevy_egui", "bevy/bevy_text"]
 fly_camera = []
 

Cargo.toml

@@ -64,6 +64,12 @@ There are a few features:
 - `debug`: enables an `egui` UI that allows you to tweak shader uniforms (parameters) in-game.
 - `fly_camera`: adds a `fly_camera` module that controls the camera using keyboard and mouse.
 
+## Bevy version compatibility
+
+| bevy | bevy-volumetric-clouds |
+|------|------------------------|
+| 0.17 | 0.1.*                  |
+
 ## Credits
 
 1. "The real-time volumetric cloudscapes of Horizon Zero Dawn" by Andrew Schneider and Nathan Vos ([article](https://www.guerrilla-games.com/read/the-real-time-volumetric-cloudscapes-of-horizon-zero-dawn))

README.md

@@ -1,7 +1,5 @@
-/// Controls the compute shader which renders the volumetric clouds.
-use std::borrow::Cow;
-
 use bevy::{
+    asset::load_embedded_asset,
     ecs::system::ResMut,
     prelude::*,
     render::{
@@ -18,6 +16,8 @@ use bevy::{
         texture::GpuImage,
     },
 };
+/// Controls the compute shader which renders the volumetric clouds.
+use std::borrow::Cow;
 
 use crate::config::CloudsConfig;
 
@@ -121,6 +121,10 @@ fn prepare_textures_bind_group(
     commands.insert_resource(CloudsImageBindGroup(bind_group));
 }
 
+/// The compute shading pipeline
+///
+/// Note that the compute shader is loaded in [`CloudsShaderPlugin`] so this resource depends on
+/// that plugin.
 #[derive(Resource)]
 struct CloudsPipeline {
     texture_bind_group_layout: BindGroupLayout,
@@ -133,9 +137,7 @@ impl FromWorld for CloudsPipeline {
     fn from_world(world: &mut World) -> Self {
         let render_device = world.resource::<RenderDevice>();
         let texture_bind_group_layout = CloudsImage::bind_group_layout(render_device);
-        let shader = world
-            .resource::<AssetServer>()
-            .load("shaders/clouds_compute.wgsl");
+        let shader = load_embedded_asset!(world, "shaders/clouds_compute.wgsl");
         let pipeline_cache = world.resource::<PipelineCache>();
 
         let entries = BindGroupLayoutEntries::sequential(

src/compute.rs

@@ -9,7 +9,6 @@ pub mod config;
 pub mod fly_camera;
 mod images;
 mod render;
-mod shader_utils;
 mod skybox;
 #[cfg(feature = "debug")]
 mod ui;
@@ -25,8 +24,7 @@ use crate::{
     compute::CameraMatrices,
     config::CloudsConfig,
     images::build_images,
-    render::CloudsMaterial,
-    shader_utils::ShaderCommonPlugin,
+    render::{CloudsMaterial, CloudsShaderPlugin},
     skybox::system::{SkyboxMaterials, init_skybox_mesh, setup_daylight, update_skybox_transform},
     uniforms::CloudsImage,
 };
@@ -41,11 +39,7 @@ pub struct CloudsPlugin;
 impl Plugin for CloudsPlugin {
     fn build(&self, app: &mut App) {
         app.insert_resource(CloudsConfig::default())
-            .add_plugins((
-                CloudsComputePlugin,
-                ShaderCommonPlugin,
-                MaterialPlugin::<CloudsMaterial>::default(),
-            ))
+            .add_plugins((CloudsComputePlugin, CloudsShaderPlugin))
             .add_systems(Startup, (clouds_setup, setup_daylight))
             .add_systems(Update, (update_skybox_transform, update_camera_matrices));
         #[cfg(feature = "debug")]

src/lib.rs

@@ -1,9 +1,11 @@
 use bevy::{
-    prelude::*, reflect::TypePath, render::render_resource::AsBindGroup, shader::ShaderRef,
+    asset::{AssetPath, embedded_asset, embedded_path},
+    prelude::*,
+    reflect::TypePath,
+    render::render_resource::AsBindGroup,
+    shader::{ShaderRef, load_shader_library},
 };
 
-const SHADER_ASSET_PATH: &str = "shaders/clouds.wgsl";
-
 #[derive(Asset, TypePath, AsBindGroup, Debug, Clone)]
 pub(crate) struct CloudsMaterial {
     #[texture(100, visibility(vertex, fragment))]
@@ -25,6 +27,21 @@ pub(crate) struct CloudsMaterial {
 
 impl Material for CloudsMaterial {
     fn fragment_shader() -> ShaderRef {
-        SHADER_ASSET_PATH.into()
+        ShaderRef::Path(
+            AssetPath::from_path_buf(embedded_path!("shaders/clouds.wgsl")).with_source("embedded"),
+        )
+    }
+}
+
+pub(crate) struct CloudsShaderPlugin;
+
+impl Plugin for CloudsShaderPlugin {
+    fn build(&self, app: &mut App) {
+        load_shader_library!(app, "shaders/common.wgsl");
+
+        embedded_asset!(app, "shaders/clouds.wgsl");
+        embedded_asset!(app, "shaders/clouds_compute.wgsl");
+
+        app.add_plugins(MaterialPlugin::<CloudsMaterial>::default());
     }
 }