Add new version of modor_graphics (#295)

modor-engine · Jun 2, 2024 · 9915bbc · 9915bbc
1 parent 60a4ce6
commit 9915bbc
Show file tree

Hide file tree

Showing 146 changed files with 6,991 additions and 468 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -65,7 +65,7 @@ jobs:
         run: sudo apt-get update && sudo apt-get install libudev-dev
         if: matrix.target == 'x86_64-unknown-linux-gnu'
       - name: Run clippy
-        run: cargo clippy --all-targets --target ${{ matrix.target }} -- -D warnings
+        run: cargo clippy --all-targets --no-deps --target ${{ matrix.target }} -- -D warnings
 
   test:
     strategy:
@@ -75,12 +75,10 @@ jobs:
           - name: Windows
             os: windows-2022
             target: x86_64-pc-windows-msvc
-            wgpu_backend: dx12
           - name: Linux
             os: ubuntu-22.04
             target: x86_64-unknown-linux-gnu
             command_prefix: xvfb-run --server-args="-screen 0 1920x1080x24"
-            wgpu_backend: vulkan
           - name: macOS
             os: macos-13
             target: x86_64-apple-darwin
@@ -119,8 +117,6 @@ jobs:
       - name: Test other
         run: ${{ matrix.command_prefix }} cargo test --no-fail-fast
         if: matrix.target != 'wasm32-unknown-unknown'
-        env:
-          WGPU_BACKEND: ${{ matrix.wgpu_backend }}
 
   coverage:
     runs-on: ubuntu-22.04
@@ -152,7 +148,6 @@ jobs:
         env:
           RUSTFLAGS: -Cinstrument-coverage -Clink-dead-code
           LLVM_PROFILE_FILE: "%m.profraw"
-          WGPU_BACKEND: vulkan
       - name: Generate HTML coverage report
         if: ${{ env.CODECOV_UPLOAD != 'true' }}
         run: bash -x .github/workflows/scripts/generate_coverage.sh html ./coverage/
@@ -201,7 +196,7 @@ jobs:
       - name: Install Linux general dependencies
         run: sudo apt-get update && sudo apt-get install libudev-dev
       - name: Generate documentation
-        run: cargo doc
+        run: cargo doc --no-deps
         env:
           RUSTDOCFLAGS: -Dwarnings
 

diff --git a/.github/workflows/scripts/install_graphic_dependencies_linux.sh b/.github/workflows/scripts/install_graphic_dependencies_linux.sh
@@ -1,5 +1,10 @@
+#!/bin/bash
+set -xeu
+
+VULKAN_SDK_VERSION="1.3.268"
+
 sudo apt-get update -y -qq
 wget -qO - https://packages.lunarg.com/lunarg-signing-key-pub.asc | sudo apt-key add -
-sudo wget -qO /etc/apt/sources.list.d/lunarg-vulkan-jammy.list https://packages.lunarg.com/vulkan/lunarg-vulkan-jammy.list
+sudo wget -qO /etc/apt/sources.list.d/lunarg-vulkan-$VULKAN_SDK_VERSION-jammy.list https://packages.lunarg.com/vulkan/$VULKAN_SDK_VERSION/lunarg-vulkan-$VULKAN_SDK_VERSION-jammy.list
 sudo apt-get update -y
-sudo apt install -y libegl1-mesa libgl1-mesa-dri libxcb-xfixes0-dev mesa-vulkan-drivers vulkan-sdk
+sudo apt install -y vulkan-sdk
diff --git a/Cargo.toml b/Cargo.toml
@@ -15,6 +15,7 @@ approx = "0.5"
 android-activity = { version = "0.5", features = ["native-activity"] }
 android_logger = "0.13"
 async-std = "1.12"
+bytemuck = { version = "1.15", features = ["derive"] }
 cargo-run-wasm = "0.3"
 console_error_panic_hook = "0.1"
 console_log = "1.0"
@@ -23,27 +24,36 @@ derivative = "2.2"
 fs_extra = "1.2"
 futures = "0.3"
 fxhash = "0.2"
+getrandom = { version = "*", features = ["js"] } # To fix this issue: https://github.com/rust-random/getrandom/issues/208
+gilrs = "0.10"
+image = "0.25"
 instant = "0.1"
 log = "0.4"
 pico-args = "0.5"
 pretty_env_logger = "0.5"
 proc-macro-crate = "3.0"
 proc-macro2 = "1.0"
+rand = "0.8"
 rapier2d = "0.18"
+regex = "1.10"
 reqwest = "0.12"
 quote = "1.0"
+spin_sleep = "1.2"
 syn = { version = "2.0", features = ["full"] }
 wasm-bindgen-futures = "0.4"
 wasm-bindgen-test = "0.3"
 web-sys = { version = "0.3", features = ["Location"] }
-
+wgpu = "0.19"
+winit = "0.29"
 modor = { version = "0.1.0", path = "crates/modor" }
 modor_derive = { version = "0.1.0", path = "crates/modor_derive" }
+modor_graphics = { version = "0.1.0", path = "crates/modor_graphics" }
 modor_input = { version = "0.1.0", path = "crates/modor_input" }
 modor_internal = { version = "0.1.0", path = "crates/modor_internal" }
 modor_jobs = { version = "0.1.0", path = "crates/modor_jobs" }
 modor_math = { version = "0.1.0", path = "crates/modor_math" }
 modor_physics = { version = "0.1.0", path = "crates/modor_physics" }
+modor_resources = { version = "0.1.0", path = "crates/modor_resources" }
 
 [workspace.lints.rust]
 anonymous_parameters = "warn"

diff --git a/PUBLISHED-CRATES b/PUBLISHED-CRATES
@@ -6,3 +6,4 @@ modor_physics
 modor_input
 modor_jobs
 modor_resources
+modor_graphics
diff --git a/crates/modor/src/app.rs b/crates/modor/src/app.rs
@@ -37,13 +37,13 @@ impl App {
         T: RootNode,
     {
         platform::init_logging(log_level);
-        debug!("initialize app...");
+        debug!("Initialize app...");
         let mut app = Self {
             root_indexes: FxHashMap::default(),
             roots: vec![],
         };
-        app.root::<T>();
-        debug!("app initialized");
+        app.get_mut::<T>();
+        debug!("App initialized");
         app
     }
 
@@ -53,7 +53,7 @@ impl App {
     ///
     /// Root nodes are updated in the order in which they are created.
     pub fn update(&mut self) {
-        debug!("run update app...");
+        debug!("Run update app...");
         for root_index in 0..self.roots.len() {
             let root = &mut self.roots[root_index];
             let mut value = root
@@ -64,7 +64,7 @@ impl App {
             update_fn(&mut *value, &mut self.ctx());
             self.roots[root_index].value = Some(value);
         }
-        debug!("app updated");
+        debug!("App updated");
     }
 
     /// Returns an update context.
@@ -77,7 +77,7 @@ impl App {
     /// Returns a mutable reference to a root node.
     ///
     /// The root node is created using [`RootNode::on_create`] if it doesn't exist.
-    pub fn root<T>(&mut self) -> &mut T
+    pub fn get_mut<T>(&mut self) -> &mut T
     where
         T: RootNode,
     {
@@ -101,9 +101,9 @@ impl App {
     where
         T: RootNode,
     {
-        debug!("create root node `{}`...", any::type_name::<T>());
+        debug!("Create root node `{}`...", any::type_name::<T>());
         let root = RootNodeData::new(T::on_create(&mut self.ctx()));
-        debug!("root node `{}` created", any::type_name::<T>());
+        debug!("Root node `{}` created", any::type_name::<T>());
         let index = self.roots.len();
         self.root_indexes.insert(type_id, index);
         self.roots.push(root);
@@ -117,7 +117,7 @@ impl App {
         self.roots[root_index]
             .value
             .as_mut()
-            .expect("internal error: root node already borrowed")
+            .unwrap_or_else(|| panic!("root node `{}` already borrowed", any::type_name::<T>()))
             .downcast_mut::<T>()
             .expect("internal error: misconfigured root node")
     }
@@ -132,14 +132,14 @@ pub struct Context<'a> {
 }
 
 impl Context<'_> {
-    /// Returns a mutable reference to a root node.
+    /// Returns a handle to a root node.
     ///
     /// The root node is created using [`RootNode::on_create`] if it doesn't exist.
     ///
     /// # Panics
     ///
     /// This will panic if root node `T` is currently updated.
-    pub fn root<T>(&mut self) -> RootNodeHandle<T>
+    pub fn handle<T>(&mut self) -> RootNodeHandle<T>
     where
         T: RootNode,
     {
@@ -148,6 +148,20 @@ impl Context<'_> {
             phantom: PhantomData,
         }
     }
+
+    /// Returns a mutable reference to a root node.
+    ///
+    /// The root node is created using [`RootNode::on_create`] if it doesn't exist.
+    ///
+    /// # Panics
+    ///
+    /// This will panic if root node `T` is currently updated.
+    pub fn get_mut<T>(&mut self) -> &mut T
+    where
+        T: RootNode,
+    {
+        self.handle::<T>().get_mut(self)
+    }
 }
 
 /// A handle to access a [`RootNode`].
@@ -176,7 +190,7 @@ where
         ctx.app.roots[self.index]
             .value
             .as_ref()
-            .expect("internal error: root node already borrowed")
+            .unwrap_or_else(|| panic!("root node `{}` already borrowed", any::type_name::<T>()))
             .downcast_ref::<T>()
             .expect("internal error: misconfigured root node")
     }

diff --git a/crates/modor/src/globals.rs b/crates/modor/src/globals.rs
@@ -43,7 +43,7 @@ where
 {
     /// Creates a new shared `value`.
     pub fn new(ctx: &mut Context<'_>, value: T) -> Self {
-        let globals = ctx.root::<Globals<T>>();
+        let globals = ctx.handle::<Globals<T>>();
         Self {
             ref_: GlobRef {
                 index: globals.get_mut(ctx).register(value).into(),
@@ -142,7 +142,7 @@ where
 /// # use modor::*;
 /// #
 /// fn access_glob(ctx: &mut Context<'_>, index: usize) -> &'static str {
-///     ctx.root::<Globals<&'static str>>().get(ctx)[index]
+///     ctx.get_mut::<Globals<&'static str>>()[index]
 /// }
 /// ```
 #[derive(Debug)]
@@ -282,7 +282,7 @@ impl Drop for Index {
     fn drop(&mut self) {
         match self.pool.deleted_indexes.lock() {
             Ok(mut indexes) => indexes.push(self.index),
-            Err(err) => error!("error: {err}"), // no-coverage (difficult to test poisoning)
+            Err(err) => error!("Error: {err}"), // no-coverage (difficult to test poisoning)
         }
     }
 }
diff --git a/crates/modor/src/lib.rs b/crates/modor/src/lib.rs
@@ -164,6 +164,9 @@ pub use modor_derive::Node;
 ///
 /// Both structs and enums are supported.
 ///
+/// Note that generic fields are not dynamically visited. In case a generic field should be visited,
+/// an explicit [`Node`] trait bound is necessary.
+///
 /// # Examples
 ///
 /// See [`modor`](crate).

diff --git a/crates/modor/tests/integration/app.rs b/crates/modor/tests/integration/app.rs
@@ -6,7 +6,7 @@ use modor_derive::{Node, RootNode, Visit};
 fn create_node_handle() {
     let mut app = App::new::<Root>(Level::Info);
     let mut ctx = app.ctx();
-    let handle = ctx.root::<Root>();
+    let handle = ctx.handle::<Root>();
     assert_eq!(handle.get(&ctx).value, 0);
     assert_eq!(handle.get_mut(&mut ctx).value, 0);
 }

diff --git a/crates/modor/tests/integration/globals.rs b/crates/modor/tests/integration/globals.rs
@@ -97,7 +97,7 @@ fn access_all_globals() {
     let mut ctx = app.ctx();
     let _glob1 = Glob::new(&mut ctx, "a");
     let _glob2 = Glob::new(&mut ctx, "b");
-    let globals = app.root::<Globals<&str>>();
+    let globals = app.get_mut::<Globals<&str>>();
     assert!(globals.deleted_items().is_empty());
     assert_eq!(globals.get(0), Some(&"a"));
     assert_eq!(globals.get(1), Some(&"b"));
@@ -116,7 +116,7 @@ fn access_all_globals_after_value_dropped() {
     let _glob2 = Glob::new(&mut ctx, "b");
     drop(glob1);
     app.update();
-    let globals = app.root::<Globals<&str>>();
+    let globals = app.get_mut::<Globals<&str>>();
     assert_eq!(globals.deleted_items(), [(0, "a")]);
     assert_eq!(globals.get(0), None);
     assert_eq!(globals.get(1), Some(&"b"));

diff --git a/crates/modor/tests/integration/node/box_node.rs b/crates/modor/tests/integration/node/box_node.rs
@@ -5,7 +5,7 @@ use modor::{App, Context, Node, RootNode, Visit};
 fn update_node() {
     let mut app = App::new::<Root>(Level::Info);
     app.update();
-    let container = app.root::<Container>();
+    let container = app.get_mut::<Container>();
     assert_eq!(container.0, ["InnerNode::on_enter", "InnerNode::on_exit"]);
 }
 
@@ -26,16 +26,10 @@ struct InnerNode;
 
 impl Node for InnerNode {
     fn on_enter(&mut self, ctx: &mut Context<'_>) {
-        ctx.root::<Container>()
-            .get_mut(ctx)
-            .0
-            .push("InnerNode::on_enter");
+        ctx.get_mut::<Container>().0.push("InnerNode::on_enter");
     }
 
     fn on_exit(&mut self, ctx: &mut Context<'_>) {
-        ctx.root::<Container>()
-            .get_mut(ctx)
-            .0
-            .push("InnerNode::on_exit");
+        ctx.get_mut::<Container>().0.push("InnerNode::on_exit");
     }
 }
diff --git a/crates/modor/tests/integration/node/const_node.rs b/crates/modor/tests/integration/node/const_node.rs
@@ -7,7 +7,7 @@ fn update_node() {
     app.update();
     app.update();
     app.update();
-    let container = app.root::<Container>();
+    let container = app.get_mut::<Container>();
     assert_eq!(container.0, ["InnerNode::on_enter", "InnerNode::on_exit"]);
 }
 
@@ -30,16 +30,10 @@ struct InnerNode(u32);
 
 impl Node for InnerNode {
     fn on_enter(&mut self, ctx: &mut Context<'_>) {
-        ctx.root::<Container>()
-            .get_mut(ctx)
-            .0
-            .push("InnerNode::on_enter");
+        ctx.get_mut::<Container>().0.push("InnerNode::on_enter");
     }
 
     fn on_exit(&mut self, ctx: &mut Context<'_>) {
-        ctx.root::<Container>()
-            .get_mut(ctx)
-            .0
-            .push("InnerNode::on_exit");
+        ctx.get_mut::<Container>().0.push("InnerNode::on_exit");
     }
 }
diff --git a/crates/modor/tests/integration/node/dyn_box_node.rs b/crates/modor/tests/integration/node/dyn_box_node.rs
@@ -5,7 +5,7 @@ use modor::{App, Context, Node, RootNode, Visit};
 fn update_node() {
     let mut app = App::new::<Root>(Level::Info);
     app.update();
-    let container = app.root::<Container>();
+    let container = app.get_mut::<Container>();
     assert_eq!(container.0, ["InnerNode::on_enter", "InnerNode::on_exit"]);
 }
 
@@ -26,16 +26,10 @@ struct InnerNode;
 
 impl Node for InnerNode {
     fn on_enter(&mut self, ctx: &mut Context<'_>) {
-        ctx.root::<Container>()
-            .get_mut(ctx)
-            .0
-            .push("InnerNode::on_enter");
+        ctx.get_mut::<Container>().0.push("InnerNode::on_enter");
     }
 
     fn on_exit(&mut self, ctx: &mut Context<'_>) {
-        ctx.root::<Container>()
-            .get_mut(ctx)
-            .0
-            .push("InnerNode::on_exit");
+        ctx.get_mut::<Container>().0.push("InnerNode::on_exit");
     }
 }