diff --git a/Cargo.toml b/Cargo.toml index 5e92ed8..09a4a5b 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -11,9 +11,9 @@ json = ["bevy_common_assets/json"] msgpack = ["bevy_common_assets/msgpack"] [dependencies] -bevy = "0.10.0" +bevy = "0.11.*" serde = "1.0.152" serde_json = "1.0.93" -bevy_common_assets = "0.6.0" +bevy_common_assets = "0.7.0" once_cell = "1.17.1" -rust-gpu-builder-shared = { git = "https://github.com/bevy-rust-gpu/rust-gpu-builder-shared", tag = "v0.2.0", features = ["bevy"] } +rust-gpu-builder-shared = { path = "./lib/rust-gpu-builder-shared", features = ["bevy"] } diff --git a/lib/rust-gpu-builder-shared/.github/workflows/create-tag-release.yml b/lib/rust-gpu-builder-shared/.github/workflows/create-tag-release.yml new file mode 100644 index 0000000..623532c --- /dev/null +++ b/lib/rust-gpu-builder-shared/.github/workflows/create-tag-release.yml @@ -0,0 +1,44 @@ +name: Release on Tag + +on: + push: + tags: + - "v[0-9]+.[0-9]+.[0-9]+" + +jobs: + release: + runs-on: ubuntu-latest + + permissions: + contents: write + pull-requests: read + + name: Generate Release + steps: + - name: checkout + uses: actions/checkout@v3 + with: + fetch-depth: 0 + + - name: Get previous tag + id: previousTag + run: | + name=$(git --no-pager tag --sort=creatordate --merged ${{ github.ref_name }} | tail -2 | head -1) + echo "previousTag: $name" + echo "previousTag=$name" >> $GITHUB_ENV + + - name: Generate changelog + id: changelog + uses: metcalfc/changelog-generator@v4.1.0 + with: + myToken: ${{ secrets.GITHUB_TOKEN }} + head-ref: ${{ env.previousTag }} + base-ref: ${{ github.ref_name }} + + - name: Create Release + uses: ncipollo/release-action@v1.12.0 + with: + draft: true + token: ${{ github.token }} + name: "Release ${{ github.ref_name }}" + body: "## Release Notes\n\nTODO\n\n## Commits\n\n${{ steps.changelog.outputs.changelog }}" diff --git a/lib/rust-gpu-builder-shared/.github/workflows/publish-rust-docs.yml b/lib/rust-gpu-builder-shared/.github/workflows/publish-rust-docs.yml new file mode 100644 index 0000000..df0d494 --- /dev/null +++ b/lib/rust-gpu-builder-shared/.github/workflows/publish-rust-docs.yml @@ -0,0 +1,11 @@ +name: Publish Rust Docs +run-name: ${{ github.actor }} is publishing documentation 🚀 +on: + push: + +permissions: + contents: write + +jobs: + publish-cargo-doc: + uses: Shfty/github-actions/.github/workflows/publish-rust-docs.yml@master diff --git a/lib/rust-gpu-builder-shared/.github/workflows/rust.yml b/lib/rust-gpu-builder-shared/.github/workflows/rust.yml new file mode 100644 index 0000000..d54fa2f --- /dev/null +++ b/lib/rust-gpu-builder-shared/.github/workflows/rust.yml @@ -0,0 +1,22 @@ +name: Rust + +on: + push: + branches: [ "master" ] + pull_request: + branches: [ "master" ] + +env: + CARGO_TERM_COLOR: always + +jobs: + build: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + - name: Build + run: cargo build --verbose + - name: Run tests + run: cargo test --verbose diff --git a/lib/rust-gpu-builder-shared/.gitignore b/lib/rust-gpu-builder-shared/.gitignore new file mode 100644 index 0000000..2c96eb1 --- /dev/null +++ b/lib/rust-gpu-builder-shared/.gitignore @@ -0,0 +1,2 @@ +target/ +Cargo.lock diff --git a/lib/rust-gpu-builder-shared/Cargo.toml b/lib/rust-gpu-builder-shared/Cargo.toml new file mode 100644 index 0000000..ef16839 --- /dev/null +++ b/lib/rust-gpu-builder-shared/Cargo.toml @@ -0,0 +1,13 @@ +[package] +name = "rust-gpu-builder-shared" +version = "0.2.0" +edition = "2021" + +[features] +default = ["bevy"] +bevy = ["dep:bevy", "dep:bevy_reflect"] + +[dependencies] +serde = { version = "1.0.157", features = ["derive"] } +bevy = { version = "0.11.*", optional = true } +bevy_reflect = { version = "0.11.*", optional = true } diff --git a/lib/rust-gpu-builder-shared/LICENSE-APACHE b/lib/rust-gpu-builder-shared/LICENSE-APACHE new file mode 100644 index 0000000..d9a10c0 --- /dev/null +++ b/lib/rust-gpu-builder-shared/LICENSE-APACHE @@ -0,0 +1,176 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS diff --git a/lib/rust-gpu-builder-shared/LICENSE-MIT b/lib/rust-gpu-builder-shared/LICENSE-MIT new file mode 100644 index 0000000..9cf1062 --- /dev/null +++ b/lib/rust-gpu-builder-shared/LICENSE-MIT @@ -0,0 +1,19 @@ +MIT License + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/lib/rust-gpu-builder-shared/README.md b/lib/rust-gpu-builder-shared/README.md new file mode 100644 index 0000000..ab674a7 --- /dev/null +++ b/lib/rust-gpu-builder-shared/README.md @@ -0,0 +1,8 @@ +
+ +# `rust-gpu-builder-shared` + +Shared code for using `rust-gpu-builder` output in downstream crates. + +
+ diff --git a/lib/rust-gpu-builder-shared/src/lib.rs b/lib/rust-gpu-builder-shared/src/lib.rs new file mode 100644 index 0000000..66411e6 --- /dev/null +++ b/lib/rust-gpu-builder-shared/src/lib.rs @@ -0,0 +1,33 @@ + +use ::bevy::utils::HashMap; +use bevy_reflect::Reflect; +use serde::{Deserialize, Serialize}; + +/// Module binary data container. +#[derive(Debug, Clone, Serialize, Deserialize, Reflect)] +pub enum RustGpuBuilderModules { + /// Contains a single unnamed module. + Single(Vec), + /// Contains multiple named modules. + Multi(HashMap>), +} + +/// Compile output from `rust-gpu-builder`, +/// includes SPIR-V binary modules and entry point metadata. +#[derive(Debug, Clone, Serialize, Deserialize, Reflect)] +pub struct RustGpuBuilderOutput { + pub entry_points: Vec, + pub modules: RustGpuBuilderModules, +} + +#[cfg(feature = "bevy")] +mod bevy { + use super::RustGpuBuilderOutput; + use bevy::{reflect::TypeUuid, utils::Uuid}; + + /// Implementing TypeUuid allows use as a `bevy` asset + impl TypeUuid for RustGpuBuilderOutput { + const TYPE_UUID: Uuid = + Uuid::from_fields(1664188495, 11437, 8530, &[15, 75, 77, 14, 32, 11, 25, 52]); + } +} diff --git a/src/builder_output.rs b/src/builder_output.rs index 144fa34..706b736 100644 --- a/src/builder_output.rs +++ b/src/builder_output.rs @@ -1,8 +1,8 @@ use std::{collections::BTreeMap, sync::RwLock}; use bevy::prelude::{ - default, AssetEvent, Assets, CoreSet, Deref, DerefMut, EventReader, Handle, IntoSystemConfig, - Plugin, Res, ResMut, Shader, + default, AssetEvent, Assets, Deref, DerefMut, EventReader, Handle, + Plugin, Res, ResMut, Shader, PreUpdate, }; use once_cell::sync::Lazy; use rust_gpu_builder_shared::RustGpuBuilderOutput; @@ -20,11 +20,11 @@ impl Plugin for BuilderOutputPlugin { >::new(&["rust-gpu.json"])); #[cfg(feature = "msgpack")] - app.add_plugin(bevy_common_assets::msgpack::MsgPackAssetPlugin::< + app.add_plugins(bevy_common_assets::msgpack::MsgPackAssetPlugin::< RustGpuBuilderOutput, >::new(&["rust-gpu.msgpack"])); - app.add_system(builder_output_events.in_base_set(CoreSet::PreUpdate)); + app.add_systems(PreUpdate, builder_output_events); } } @@ -64,7 +64,7 @@ pub fn builder_output_events( // Create a `RustGpuArtifact` from the affected asset let artifact = match asset.modules { rust_gpu_builder_shared::RustGpuBuilderModules::Single(ref single) => { - let shader = shaders.add(Shader::from_spirv(single.clone())); + let shader = shaders.add(Shader::from_spirv(single.clone(), "")); RustGpuArtifact { entry_points: asset.entry_points, modules: RustGpuModules::Single(shader), @@ -75,7 +75,7 @@ pub fn builder_output_events( modules: RustGpuModules::Multi( multi .into_iter() - .map(|(k, module)| (k.clone(), shaders.add(Shader::from_spirv(module)))) + .map(|(k, module)| (k.clone(), shaders.add(Shader::from_spirv(module, "")))) .collect(), ), }, @@ -90,7 +90,7 @@ pub fn builder_output_events( // On remove, remove the corresponding artifact from static storage if let AssetEvent::Removed { handle } = event { - RUST_GPU_ARTIFACTS.write().unwrap().remove(handle); + RUST_GPU_ARTIFACTS.write().unwrap().remove(&handle); } } } diff --git a/src/entry_point_export.rs b/src/entry_point_export.rs index c0a1066..eec3506 100644 --- a/src/entry_point_export.rs +++ b/src/entry_point_export.rs @@ -10,7 +10,7 @@ use std::{ }; use bevy::{ - prelude::{default, info, CoreSet, Deref, DerefMut, IntoSystemConfig, NonSendMut, Plugin}, + prelude::{default, info, Deref, DerefMut, NonSendMut, Plugin, Update, Last, IntoSystemConfigs}, render::render_resource::ShaderDefVal, tasks::IoTaskPool, utils::HashMap, @@ -53,11 +53,11 @@ where fn build(&self, app: &mut bevy::prelude::App) { app.world.init_non_send_resource::(); - app.add_systems(( - EntryPointExport::create_export_containers_system.in_base_set(CoreSet::Update), - EntryPointExport::receive_entry_points_system.in_base_set(CoreSet::Last), + app.add_systems(Update, ( + EntryPointExport::create_export_containers_system, + )).add_systems(Last, ( + EntryPointExport::receive_entry_points_system, EntryPointExport::export_entry_points_system(self.writer.clone()) - .in_base_set(CoreSet::Last) .after(EntryPointExport::receive_entry_points_system), )); } diff --git a/src/plugin.rs b/src/plugin.rs index 980aaa1..c60653c 100644 --- a/src/plugin.rs +++ b/src/plugin.rs @@ -36,10 +36,10 @@ where F: Fn(PathBuf, EntryPoints) + Clone + Send + Sync + 'static, { fn build(&self, app: &mut bevy::prelude::App) { - app.add_plugin(BuilderOutputPlugin); + app.add_plugins(BuilderOutputPlugin); #[cfg(feature = "hot-rebuild")] - app.add_plugin(crate::prelude::EntryPointExportPlugin { + app.add_plugins(crate::prelude::EntryPointExportPlugin { writer: self.export_writer.clone(), }); } diff --git a/src/rust_gpu.rs b/src/rust_gpu.rs index ecce3e5..9941c1e 100644 --- a/src/rust_gpu.rs +++ b/src/rust_gpu.rs @@ -6,10 +6,10 @@ use bevy::{ asset::Asset, pbr::MaterialPipelineKey, prelude::{ - default, info, warn, AssetEvent, Assets, CoreSet, EventReader, Handle, Image, - IntoSystemConfig, Material, MaterialPlugin, Plugin, ResMut, + default, info, warn, AssetEvent, Assets, EventReader, Handle, Image, + Material, MaterialPlugin, Plugin, ResMut, PreUpdate, }, - reflect::TypeUuid, + reflect::{TypeUuid, Reflect}, render::render_resource::{ AsBindGroup, PreparedBindGroup, ShaderRef, SpecializedMeshPipelineError, }, @@ -44,12 +44,12 @@ where impl Plugin for RustGpuMaterialPlugin where - M: Material + RustGpuMaterial, + M: Material + RustGpuMaterial + bevy::prelude::FromReflect, M::Data: Clone + Eq + std::hash::Hash, { fn build(&self, app: &mut bevy::prelude::App) { - app.add_plugin(MaterialPlugin::>::default()); - app.add_system(reload_materials::.in_base_set(CoreSet::PreUpdate)); + app.add_plugins(MaterialPlugin::>::default()); + app.add_systems(PreUpdate, reload_materials::); } } @@ -63,7 +63,7 @@ where impl Default for RustGpuMaterial2dPlugin where - M: Material2d + RustGpuMaterial, + M: Material2d + RustGpuMaterial + bevy::prelude::FromReflect, { fn default() -> Self { RustGpuMaterial2dPlugin { @@ -74,12 +74,12 @@ where impl Plugin for RustGpuMaterial2dPlugin where - M: Material2d + RustGpuMaterial, + M: Material2d + RustGpuMaterial + bevy::prelude::FromReflect, M::Data: Clone + Eq + std::hash::Hash, { fn build(&self, app: &mut bevy::prelude::App) { - app.add_plugin(Material2dPlugin::>::default()); - app.add_system(reload_materials::.in_base_set(CoreSet::PreUpdate)); + app.add_plugins(Material2dPlugin::>::default()); + app.add_systems(PreUpdate, reload_materials::); } } @@ -152,7 +152,7 @@ where } /// Extends a `Material` with `rust-gpu` shader support. -#[derive(Debug, Default, Clone, TypeUuid)] +#[derive(Debug, Default, Clone, TypeUuid, Reflect)] #[uuid = "6d355e05-c567-4a29-a84a-362df79111de"] pub struct RustGpu { /// Base material. @@ -431,7 +431,7 @@ where impl Material for RustGpu where - M: Material + RustGpuMaterial, + M: Material + RustGpuMaterial + bevy::prelude::FromReflect, M::Data: Clone, { fn vertex_shader() -> bevy::render::render_resource::ShaderRef { @@ -497,7 +497,7 @@ where impl Material2d for RustGpu where - M: Material2d + RustGpuMaterial, + M: Material2d + RustGpuMaterial + bevy::prelude::FromReflect, M::Data: Clone, { fn vertex_shader() -> bevy::render::render_resource::ShaderRef { @@ -569,7 +569,7 @@ pub fn reload_materials( mut builder_output_events: EventReader>, mut materials: ResMut>>, ) where - M: Asset + RustGpuMaterial, + M: Asset + RustGpuMaterial + bevy::prelude::FromReflect, { for event in builder_output_events.iter() { if let AssetEvent::Created { handle } | AssetEvent::Modified { handle } = event {