Improve READMEs and examples

Author: michidk

.github/images/examples/brdf.png

@@ -11,44 +11,48 @@ The goal is to build a somewhat usable game engine and a demo using it. While we
 ## Features
 
 Currently implemented features are:
-- Scene comprised of Entities and Components
-- Debug UI Layer with Frame stats, Scene Graph, Component Inspectors and Profiler
-- BRDF shading
-- Deferred rendering
+
+- A scene graph with entities and components
+- Vulkan rendering
+- BRDF shading and lighting
+- Deferred rendering and post-processing effects
+- Debug UI Layer with frame stats, scene graph and component inspectors
 - `.obj` parser
 - Runs on both Linux and Windows
 
 ## Screenshots
 
 BRDF testing:
 
-![brdf testing](./.github/images/examples/brdf.png)
+![brdf testing](/.github/images/examples/brdf.png)
 
 Debug UI:
 
-![debug ui](./.github/images/examples/debug-ui.png)
+![debug ui](/.github/images/examples/debug-ui.png)
+
+Custom meshes:
+![custom meshes](/.github/images/examples/suzanne.png)
 
 ## Workspace
 
 | Folder | Description | Readme |
 | ---- | ----------- | - |
-| [crates/engine](crates/engine) | Main engine library | This one |
-| [crates/ve_asset](crates/ve_asset) | Utility that converts files into our custom format | [here](./crates/ve_asset/README.md) |
-| [crates/ve_format](crates/ve_format) | Stores some shared structs | [here](./crates/ve_format/README.md) |
-| [crates/ve_shader_reflect](crates/ve_shader_reflect) | Retrieves metadata from compiled shaders to feed into the material pipeline | [here](./crates/ve_shader_reflect/README.md) |
-
+| [crates/engine](/crates/engine) | Main engine library | This one |
+| [crates/ve_asset](/crates/ve_asset) | Utility that converts files into our custom format | [here](./crates/ve_asset/README.md) |
+| [crates/ve_format](/crates/ve_format) | Stores some shared structs | [here](./crates/ve_format/README.md) |
+| [crates/ve_shader_reflect](/crates/ve_shader_reflect) | Retrieves metadata from compiled shaders to feed into the material pipeline | [here](/crates/ve_shader_reflect/README.md) |
 
 
 ## Examples
 
 Examples are in the [crates/engine/examples](crates/engine/examples) folder. They can be run with `cargo +nightly run --example <name>`.
 | Name | Description |
 | ---- | ----------- |
-| minimal | Displays a triangle using vertex colors |
-| brdf | Renders a couple of spheres using physically-based rendering |
-| mesh | Loads and renders a custom mesh |
-| textured_material | Creates a texture at runtime and renders it onto a quad |
-| components | Shows off the engine's component system |
+| [minimal](/crates/engine/examples/minimal/) | Displays a triangle using vertex colors |
+| [brdf](/crates/engine/examples/brdf/) | Renders a couple of spheres using physically-based rendering |
+| [mesh](/crates/engine/examples/mesh/) | Loads and renders a custom mesh |
+| [textured_material](/crates/engine/examples/textured_material/) | Creates a texture at runtime and renders it onto a quad |
+| [components](/crates/engine/examples/components/) | Shows off the engine's component system |
 
 ## Building
 

.github/images/examples/suzanne.png

@@ -1,5 +1,5 @@
-# Mesh Example
+# BRDF Example
 
-This example renders a custom mesh loaded from a `.obj` file.
+This example renders a few spheres with different material properties using physically-based rendering.
 
-![triangle](/.github/images/examples/mesh.png)
+![brdf](/.github/images/examples/brdf.png)

.github/images/examples/textured_material.png

@@ -11,7 +11,8 @@ use vulkan_engine::{
     scene::{
         component::{
             camera_component::CameraComponent, debug_movement_component::DebugMovementComponent,
-            light_component::LightComponent, renderer::RendererComponent, Component,
+            light_component::LightComponent, renderer::RendererComponent,
+            rotation_component::RotationComponent, Component,
         },
         entity::Entity,
         light::{DirectionalLight, PointLight},
@@ -193,42 +194,3 @@ fn setup(engine: &mut Engine) {
 
     scene.load();
 }
-
-#[derive(Debug)]
-struct RotationComponent {
-    entity: Weak<Entity>,
-    rotation_speed: Cell<f32>,
-}
-
-impl Component for RotationComponent {
-    fn create(entity: &Rc<Entity>) -> Rc<Self>
-    where
-        Self: Sized,
-    {
-        Rc::new(Self {
-            entity: Rc::downgrade(entity),
-            rotation_speed: Cell::new(30.0),
-        })
-    }
-
-    fn load(&self) {}
-
-    fn start(&self) {}
-
-    fn update(&self, _: &Input, delta: f32) {
-        if let Some(entity) = self.entity.upgrade() {
-            let mut transform = entity.transform.borrow_mut();
-
-            let mut rotation = transform.rotation;
-            rotation = Quaternion::axis_angle(
-                Vec3::new(0.0, 0.0, 1.0),
-                self.rotation_speed.get().to_radians() * delta,
-            ) * rotation;
-            transform.rotation = rotation;
-        }
-    }
-
-    fn inspector_name(&self) -> &'static str {
-        "TimeOfDayComponent"
-    }
-}

README.md

@@ -0,0 +1,5 @@
+# Components Example
+
+This example shows the component system in action.
+
+![debug ui](/.github/images/examples/debug-ui.png)

assets/models/donut.vem

@@ -1,5 +1,5 @@
-# BRDF Example
+# Mesh Example
 
-This example renders a few spheres with different material properties using physically-based rendering.
+This example renders a custom mesh loaded from a `.vem` file. This file was generated from an `.obj` file using `ve_assets` and the following command: `ve_asset ".\suzanne.obj" -o .\assets\models\suzanne.vem`.
 
-![triangle](/.github/images/examples/brdf.png)
+![suzanne](/.github/images/examples/suzanne.png)

assets/models/suzanne.vem

@@ -8,6 +8,7 @@ use vulkan_engine::{
         component::{
             camera_component::CameraComponent, debug_movement_component::DebugMovementComponent,
             light_component::LightComponent, renderer::RendererComponent,
+            rotation_component::RotationComponent,
         },
         light::{DirectionalLight, PointLight},
         material::MaterialPipeline,
@@ -67,8 +68,8 @@ fn setup(engine: &mut Engine) {
     brdf_material0.set_float("metallic", 0.0).unwrap();
     brdf_material0.set_float("roughness", 0.1).unwrap();
 
-    let mesh_data = ve_format::mesh::MeshData::from_file(Path::new("./assets/models/cube.vem"))
-        .expect("Model cube.vem not found!");
+    let mesh_data = ve_format::mesh::MeshData::from_file(Path::new("./assets/models/suzanne.vem"))
+        .expect("Model suzanne.vem not found!");
 
     let mesh = Mesh::bake(
         mesh_data,
@@ -83,13 +84,19 @@ fn setup(engine: &mut Engine) {
     };
 
     let entity = scene.new_entity_with_transform(
-        "Cube".to_string(),
+        "Suzanne".to_string(),
         Transform {
-            position: Vec3::new(0.0, 0.0, 5.0),
-            rotation: Quaternion::axis_angle(Vec3::new(1.0, 0.0, 0.0), 0.0f32.to_radians()),
+            position: Vec3::new(0.0, 0.0, 0.0),
+            rotation: Quaternion::axis_angle(Vec3::new(0.0, 1.0, 0.0), -180.0f32.to_radians()),
             scale: Vec3::new(1.0, 1.0, 1.0),
         },
     );
+
+    entity
+        .new_component::<RotationComponent>()
+        .axis
+        .set(Vec3::new(0.0, 1.0, 0.0));
+
     let comp = entity.new_component::<RendererComponent>();
     *comp.model.borrow_mut() = Some(Rc::new(model));
 
@@ -109,7 +116,10 @@ fn setup(engine: &mut Engine) {
             "DirLight1".to_string(),
             Transform {
                 position: Vec3::zero(),
-                rotation: Quaternion::axis_angle(Vec3::new(1.0, 0.0, 0.0), -90.0f32.to_radians()),
+                rotation: Quaternion::axis_angle(
+                    Vec3::new(-41.0, -20.0, 0.0),
+                    -90.0f32.to_radians(),
+                ),
                 scale: Vec3::one(),
             },
         )
@@ -123,25 +133,6 @@ fn setup(engine: &mut Engine) {
             .into(),
         );
 
-    scene
-        .new_entity_with_transform(
-            "DirLight2".to_string(),
-            Transform {
-                position: Vec3::zero(),
-                rotation: Quaternion::axis_angle(Vec3::new(1.0, 0.0, 0.0), 90.0f32.to_radians()),
-                scale: Vec3::one(),
-            },
-        )
-        .new_component::<LightComponent>()
-        .light
-        .set(
-            DirectionalLight {
-                direction: Vec4::zero(),
-                illuminance: Vec4::new(1.6, 1.6, 1.6, 0.0),
-            }
-            .into(),
-        );
-
     scene
         .new_entity_with_transform(
             "PointLight White 1".to_string(),
@@ -196,43 +187,6 @@ fn setup(engine: &mut Engine) {
             }
             .into(),
         );
-    scene
-        .new_entity_with_transform(
-            "PointLight White 4".to_string(),
-            Transform {
-                position: Vec3::new(0.1, -3.0, -3.0),
-                rotation: Quaternion::identity(),
-                scale: Vec3::one(),
-            },
-        )
-        .new_component::<LightComponent>()
-        .light
-        .set(
-            PointLight {
-                position: Vec4::zero(),
-                luminous_flux: Vec4::new(100.0, 100.0, 100.0, 0.0),
-            }
-            .into(),
-        );
-
-    scene
-        .new_entity_with_transform(
-            "PointLight Red".to_string(),
-            Transform {
-                position: Vec3::new(0.0, 0.0, -3.0),
-                rotation: Quaternion::identity(),
-                scale: Vec3::one(),
-            },
-        )
-        .new_component::<LightComponent>()
-        .light
-        .set(
-            PointLight {
-                position: Vec4::zero(),
-                luminous_flux: Vec4::new(100.0, 0.0, 0.0, 0.0),
-            }
-            .into(),
-        );
 
     scene.load();
 }

crates/engine/examples/brdf/README.md

@@ -0,0 +1,5 @@
+# Textured Material Example
+
+This example is a minimal working example that displays a textured triangle (the texture is created at runtime).
+
+![textured material](/.github/images/examples/textured_material.png)

crates/engine/examples/brdf/main.rs

@@ -2,6 +2,7 @@ pub mod camera_component;
 pub mod debug_movement_component;
 pub mod light_component;
 pub mod renderer;
+pub mod rotation_component;
 
 use std::{fmt::Debug, rc::Rc};
 

crates/engine/examples/components/README.md

@@ -0,0 +1,58 @@
+use std::{
+    cell::Cell,
+    rc::{Rc, Weak},
+};
+
+use egui::Slider;
+use gfx_maths::{Quaternion, Vec3};
+
+use crate::{core::input::Input, scene::entity::Entity};
+
+use super::Component;
+
+#[derive(Debug)]
+pub struct RotationComponent {
+    entity: Weak<Entity>,
+    pub rotation_speed: Cell<f32>,
+    pub axis: Cell<Vec3>,
+}
+
+impl Component for RotationComponent {
+    fn create(entity: &Rc<Entity>) -> Rc<Self>
+    where
+        Self: Sized,
+    {
+        Rc::new(Self {
+            entity: Rc::downgrade(entity),
+            rotation_speed: Cell::new(30.0),
+            axis: Cell::new(Vec3::new(0.0, 0.0, 1.0)),
+        })
+    }
+
+    fn load(&self) {}
+
+    fn start(&self) {}
+
+    fn update(&self, _: &Input, delta: f32) {
+        if let Some(entity) = self.entity.upgrade() {
+            let mut transform = entity.transform.borrow_mut();
+
+            let mut rotation = transform.rotation;
+            rotation = Quaternion::axis_angle(
+                self.axis.get(),
+                self.rotation_speed.get().to_radians() * delta,
+            ) * rotation;
+            transform.rotation = rotation;
+        }
+    }
+
+    fn inspector_name(&self) -> &'static str {
+        "RotationComponent"
+    }
+
+    fn render_inspector(&self, ui: &mut egui::Ui) {
+        let mut rot_speed = self.rotation_speed.get();
+        ui.add(Slider::new(&mut rot_speed, -360.0..=360.0).text("Rotation Speed"));
+        self.rotation_speed.set(rot_speed);
+    }
+}

crates/engine/examples/mesh/README.md

@@ -26,9 +26,9 @@ Currently, this utility supports the following file formats:
 
 ## Meta
 
-Formats like `.obj` have to be parsed with different settings, e.g., depending on the software it was made with. These settings can be set in `.toml` files that are named the same as the corresponding file. These metadata can also be set for a whole folder in a `<file_extension>.toml` file.
+Formats like `.obj` have to be parsed with different settings, e.g., depending on the software it was made with. These settings can be set in `.toml` files that are named the same as the corresponding file. This metadata can also be set for a whole folder in a `<file_extension>.toml` file.
 
-E.g. the meta-file for the `.obj` file type, looks like this:
+The meta-file for the `.obj` file type looks like this:
 
 ```toml
 calculate_normals = false