Updated to bevy 0.16

Author: Kjolnyr

Cargo.lock

@@ -1,21 +1,22 @@
 [package]
-name = "bevy_easy_compute"
-version = "0.15.0"
+name = "bevy_app_compute"
+version = "0.16.0"
 authors = [
     "Cornchip <[email protected]>",
     "Kjolnyr <[email protected]>",
 ]
-edition = "2021"
+edition = "2024"
 description = "An easy way to run compute shaders for Bevy"
-repository = "https://github.com/AnthonyTornetta/bevy_easy_compute"
-homepage = "https://github.com/AnthonyTornetta/bevy_easy_compute"
-documentation = "https://docs.rs/bevy_easy_compute"
+repository = "https://github.com/Kjolnyr/bevy_app_compute"
+homepage = "https://github.com/Kjolnyr/bevy_app_compute"
+documentation = "https://docs.rs/bevy_app_compute"
 license = "MIT OR Apache-2.0"
 readme = "README.md"
-categories = ["game-development"]
+categories = ["game-development", "bevy"]
 
 [features]
 shader_format_spirv = ["wgpu/spirv"]
+shader_format_wesl = ["wesl"]
 webgl = []
 
 [lib]
@@ -24,18 +25,22 @@ doctest = false
 [dependencies]
 parking_lot = ">=0.12.3"
 bytemuck = ">=1.16.1"
+wesl = { version = "0.1.2", optional = true }
 
-# The following are only needed to support the `pipeline_cache` "hack". See:
+# The following are only needed to support the `pipeline_cache` "hack". See issue in bevy_easy_compute:
 # https://github.com/AnthonyTornetta/bevy_easy_compute/issues/7
 # Make sure these match bevy's versions
-wgpu = { version = "23.0.1", features = ["naga-ir"] }
-naga = { version = "23", features = ["wgsl-in"] }
-naga_oil = { version = "0.16", default-features = false, features = [
+wgpu = { version = "24.0.0", features = ["naga-ir"] }
+naga = { version = "24.0.0", features = ["wgsl-in"] }
+naga_oil = { version = "0.17.0", default-features = false, features = [
     "test_shader",
 ] }
+futures-lite = "2.0.1"
+thiserror = { version = "2", default-features = false }
+tracing = { version = "0.1", default-features = false, features = ["std"] } 
 
 [dependencies.bevy]
-version = "0.15"
+version = "0.16.0"
 default-features = false
 # See https://github.com/bevyengine/bevy/blob/main/docs/cargo_features.md
 features = [
@@ -46,10 +51,10 @@ features = [
 ]
 
 [dev-dependencies]
-rand = ">=0.8.5"
+rand = ">=0.9.1"
 
 [dev-dependencies.bevy]
-version = "0.15"
+version = "0.16.0"
 default-features = false
 features = [
   "animation",

Cargo.toml

@@ -1,28 +1,26 @@
 # Bevy Easy Compute
 
 ![MIT/Apache 2.0](https://img.shields.io/badge/license-MIT%2FApache-blue.svg)
-[![Doc](https://docs.rs/bevy_easy_compute/badge.svg)](https://docs.rs/bevy_easy_compute)
-[![Crate](https://img.shields.io/crates/v/bevy_easy_compute.svg)](https://crates.io/crates/bevy_easy_compute)
+[![Doc](https://docs.rs/bevy_app_compute/badge.svg)](https://docs.rs/bevy_app_compute)
+[![Crate](https://img.shields.io/crates/v/bevy_app_compute.svg)](https://crates.io/crates/bevy_app_compute)
 
 An easy way to run wgpu compute shaders within a bevy app.
 
-This is a fork of [Kjolnyr/bevy_app_compute](https://github.com/Kjolnyr/bevy_app_compute), which is no longer being maintained. This project's goal is to keep maintaining `bevy_app_compute` while keeping the overall architecture of it and adding improvements. Issues + PRs are welcome.
-
 ## Getting Started
 
 Add the following line to your `Cargo.toml`
 
 ```toml
 [dependencies]
-bevy_easy_compute = "0.15"
+bevy_app_compute = "0.16"
 ```
 
 ## Usage
 
 ### Setup
 
-Declare your shaders in structs implementing `ComputeShader`. The `shader()` fn should point to your shader source code.
-You need to derive `TypePath` as well:
+Declare your shaders in structs implementing `ComputeShader`. The `shader()` fn
+should point to your shader source code. You need to derive `TypePath` as well:
 
 ```rust
 #[derive(TypePath)]
@@ -35,7 +33,8 @@ impl ComputeShader for SimpleShader {
 }
 ```
 
-Next, declare a struct implementing `ComputeWorker` to declare the bindings and the logic of your worker:
+Next, declare a struct implementing `ComputeWorker` to declare the bindings and
+the logic of your worker:
 
 ```rust
 #[derive(Resource)]
@@ -78,15 +77,17 @@ fn main(@builtin(global_invocation_id) invocation_id: vec3<u32>) {
 }
 ```
 
-Add the `AppComputePlugin` plugin to your app, as well as one `AppComputeWorkerPlugin` per struct implementing `ComputeWorker`:
+Add the `AppComputePlugin` plugin to your app, as well as one
+`AppComputeWorkerPlugin` per struct implementing `ComputeWorker`:
 
 ```rust
 App::new()
     // ... other plugins ...
-    .add_plugins(bevy_easy_compute::AppComputeWorkerPlugin::<SimpleComputeWorker>::default());
+    .add_plugins(bevy_app_compute::AppComputeWorkerPlugin::<SimpleComputeWorker>::default());
 ```
 
-Your compute worker will now run every frame, during the `PostUpdate` stage. To read/write from it, use the `AppComputeWorker<T>` resource!
+Your compute worker will now run every frame, during the `PostUpdate` stage. To
+read/write from it, use the `AppComputeWorker<T>` resource!
 
 ```rust
 fn my_system(
@@ -104,11 +105,13 @@ fn my_system(
 }
 ```
 
-(see [simple.rs](https://github.com/AnthonyTornetta/bevy_easy_compute/tree/main/examples/simple.rs))
+(see
+[simple.rs](https://github.com/Kjolnyr/bevy_app_compute/tree/main/examples/simple.rs))
 
 ### Multiple passes
 
-You can have multiple passes without having to copy data back to the CPU in between:
+You can have multiple passes without having to copy data back to the CPU in
+between:
 
 ```rust
 let worker = AppComputeWorkerBuilder::new(world)
@@ -125,7 +128,8 @@ let worker = AppComputeWorkerBuilder::new(world)
     // the `output` buffer will contain [16.0, 25.0, 36.0, 49.0]
 ```
 
-(see [multi_pass.rs](https://github.com/AnthonyTornetta/bevy_easy_compute/tree/main/examples/multi_pass.rs))
+(see
+[multi_pass.rs](https://github.com/Kjolnyr/bevy_app_compute/tree/main/examples/multi_pass.rs))
 
 ### One shot computes
 
@@ -157,17 +161,18 @@ fn on_click_compute(
 }
 ```
 
-It will run at the end of the current frame, and you'll be able to read the data in the next frame.
+It will run at the end of the current frame, and you'll be able to read the data
+in the next frame.
 
-(see [one_shot.rs](https://github.com/AnthonyTornetta/bevy_easy_compute/tree/main/examples/one_shot.rs))
+(see
+[one_shot.rs](https://github.com/Kjolnyr/bevy_app_compute/tree/main/examples/one_shot.rs))
 
 ## Examples
 
-See [examples](https://github.com/AnthonyTornetta/bevy_easy_compute/tree/main/examples)
+See [examples](https://github.com/Kjolnyr/bevy_app_compute/tree/main/examples)
 
 ## Bevy version mapping
 
-| Bevy | bevy_easy_compute |
-| ---- | ----------------- |
-| 0.15 | 0.15              |
-| 0.14 | 0.14.1            |
+| Bevy | bevy_app_compute |
+| ---- | ---------------- |
+| 0.16 | 0.16             |

README.md

@@ -9,7 +9,7 @@ use bevy::diagnostic::{FrameTimeDiagnosticsPlugin, LogDiagnosticsPlugin};
 use bevy::prelude::*;
 
 use bevy::window::PrimaryWindow;
-use bevy_easy_compute::prelude::*;
+use bevy_app_compute::prelude::*;
 
 use worker::{Boid, BoidWorker};
 
@@ -19,7 +19,7 @@ fn main() {
     App::new()
         .add_plugins(DefaultPlugins)
         .add_plugins(LogDiagnosticsPlugin::default())
-        .add_plugins(FrameTimeDiagnosticsPlugin)
+        .add_plugins(FrameTimeDiagnosticsPlugin::default())
         .add_plugins(AppComputePlugin)
         .add_plugins(AppComputeWorkerPlugin::<BoidWorker>::default())
         .insert_resource(ClearColor(css::BLACK.into()))
@@ -61,12 +61,12 @@ fn move_entities(
     worker: ResMut<AppComputeWorker<BoidWorker>>,
     q_window: Query<&Window, With<PrimaryWindow>>,
     mut q_boid: Query<(&mut Transform, &BoidEntity), With<BoidEntity>>,
-) {
+) -> Result<()> {
     if !worker.ready() {
-        return;
+        return Ok(());
     }
 
-    let window = q_window.single();
+    let window = q_window.single()?;
 
     let boids = worker.read_vec::<Boid>("boids_dst");
 
@@ -81,4 +81,6 @@ fn move_entities(
             transform.translation = world_pos.extend(0.);
             transform.look_to(Vec3::Z, boids[boid_entity.0].vel.extend(0.));
         });
+
+    Ok(())
 }

examples/boids/main.rs

@@ -1,9 +1,9 @@
 use bevy::prelude::*;
 
-use bevy_easy_compute::prelude::*;
+use bevy_app_compute::prelude::*;
 use bytemuck::{Pod, Zeroable};
 
-use rand::distributions::{Distribution, Uniform};
+use rand::distr::{Distribution, Uniform};
 
 use crate::NUM_BOIDS;
 
@@ -50,8 +50,8 @@ impl ComputeWorker for BoidWorker {
         };
 
         let mut initial_boids_data = Vec::with_capacity(NUM_BOIDS as usize);
-        let mut rng = rand::thread_rng();
-        let unif = Uniform::new_inclusive(-1., 1.);
+        let mut rng = rand::rng();
+        let unif = Uniform::new_inclusive(-1., 1.).unwrap();
 
         for _ in 0..NUM_BOIDS {
             initial_boids_data.push(Boid {

examples/boids/worker.rs

@@ -9,7 +9,7 @@ use bevy::{
         renderer::RenderDevice,
     },
 };
-use bevy_easy_compute::prelude::*;
+use bevy_app_compute::prelude::*;
 
 use crate::worker::{
     GameOfLifeWorker, Settings, CELLS_IN_BUFFER, CELLS_OUT_BUFFER, SETTINGS_BUFFER,

examples/game_of_life/bind_groups.rs

@@ -20,7 +20,7 @@ use bevy::diagnostic::{FrameTimeDiagnosticsPlugin, LogDiagnosticsPlugin};
 
 use bevy::prelude::*;
 
-use bevy_easy_compute::prelude::*;
+use bevy_app_compute::prelude::*;
 use render::draw_plugin::DrawPlugin;
 
 use crate::bind_groups::get_buffers_for_renderer;
@@ -32,7 +32,7 @@ fn main() {
     App::new()
         .add_plugins(DefaultPlugins)
         .add_plugins(LogDiagnosticsPlugin::default())
-        .add_plugins(FrameTimeDiagnosticsPlugin)
+        .add_plugins(FrameTimeDiagnosticsPlugin::default())
         .add_plugins(AppComputePlugin)
         .add_plugins(AppComputeWorkerPlugin::<GameOfLifeWorker>::default())
         .add_plugins(DrawPlugin)

examples/game_of_life/main.rs

@@ -1,8 +1,9 @@
 use bevy::prelude::*;
 
-use bevy_easy_compute::prelude::*;
+use bevy_app_compute::prelude::*;
 use bytemuck::{Pod, Zeroable};
-use rand::{distributions::Uniform, Rng};
+use rand::{Rng, distr::Uniform};
+use tracing::info;
 use wgpu::BufferUsages;
 
 use crate::DIMENSIONS;
@@ -37,8 +38,8 @@ impl ComputeWorker for GameOfLifeWorker {
         };
 
         let mut initial_cell_data = Vec::with_capacity(NUMBER_OF_CELLS as usize);
-        let mut rng = rand::thread_rng();
-        let range = Uniform::new(0.0, 1.0);
+        let mut rng = rand::rng();
+        let range = Uniform::new(0.0, 1.0).unwrap();
 
         info!("Generating {NUMBER_OF_CELLS} random cells...");
         for _ in 0..NUMBER_OF_CELLS {

examples/game_of_life/worker.rs

@@ -2,7 +2,7 @@
 //! input for the next pass.
 
 use bevy::{prelude::*, reflect::TypePath};
-use bevy_easy_compute::prelude::*;
+use bevy_app_compute::prelude::*;
 
 #[derive(TypePath)]
 struct FirstPassShader;

examples/multi_pass.rs

@@ -1,7 +1,7 @@
 //! Example showing how to execute compute shaders on-demand
 
 use bevy::prelude::*;
-use bevy_easy_compute::prelude::*;
+use bevy_app_compute::prelude::*;
 
 #[derive(TypePath)]
 struct SimpleShader;