Description

In order for other people to use hotham, they're going to need to build it on their machine!

TODO

• [x] Verify clean build on Windows
• [x] Verify clean build on Linux
• [x] Verify clean build on macOS

Description

Clippy will probably get mad.

TODO

• [X] Incorporate Clippy
• [X] Too Many Arguments problems
• [X] Non Send Fields in Send Type problem
• [X] Type Complexity Problems
• [X] Remove commented references to Clippy in code

Problems

Clippy: Too Many Arguments

1. panel.rs add_panel_to_world (10/7)

  --> hotham/src/components/panel.rs:79:1                                                                                                                                                                       
   |                                                                                                                                                                                                            
79 | / pub fn add_panel_to_world(                                                                                                                                                                               
80 | |     text: &str,                                                                                                                                                                                          
81 | |     width: u32,                                                                                                                                                                                          
82 | |     height: u32,                                                                                                                                                                                         
...  |                                                                                                                                                                                                          
89 | |     world: &mut World,                                                                                                                                                                                   
90 | | ) -> Entity {                                                                                                                                                                                            
   | |___________^                                                                                                                                                                                              
   |                                                                                                                                                                                                            

2. gltf_loader.rs load_node (8/7)

  --> hotham/src/gltf_loader.rs:88:1                                                                                                                                                                            
   |                                                                                                                                                                                                            
88 | / fn load_node(                                                                                                                                                                                            
89 | |     node_data: &gltf::Node,                                                                                                                                                                              
90 | |     gltf_buffer: &[u8],                                                                                                                                                                                  
91 | |     vulkan_context: &VulkanContext,                                                                                                                                                                      
...  |                                                                                                                                                                                                          
96 | |     images: &[gltf::image::Data],                                                                                                                                                                        
97 | | ) -> Result<()> {                                                                                                                                                                                        
   | |_______________^                                                                                                                                                                                          
   |                                                                                                                                                                                                            

3. image.rs new (8/7)

warning: this function has too many arguments (8/7)                                                                                                                                                             
  --> hotham/src/image.rs:17:5                                                                                                                                                                                  
   |                                                                                                                                                                                                            
17 | /     pub fn new(                                                                                                                                                                                          
18 | |         handle: vk::Image,                                                                                                                                                                               
19 | |         view: vk::ImageView,                                                                                                                                                                             
20 | |         device_memory: vk::DeviceMemory,                                                                                                                                                                 
...  |                                                                                                                                                                                                          
25 | |         layer_count: u32,                                                                                                                                                                                
26 | |     ) -> Self {                                                                                                                                                                                          
   | |_____________^                                                                                                                                                                                            
   |                                                                                                                                                                                                            

4. vulkan_context.rs create_texture_image (9/7)

   --> hotham/src/resources/vulkan_context.rs:467:5                                                                                                                                                          
    |                                                                                                                                                                                                           
467 | /     pub fn create_texture_image(                                                                                                                                                                        
468 | |         &self,                                                                                                                                                                                          
469 | |         name: &str,                                                                                                                                                                                     
470 | |         image_buf: &[u8], // Clippy &Vec<u8>, ptr_arg for texture.rs                                                                                                                                    
...   |                                                                                                                                                                                                         
476 | |         offsets: Vec<vk::DeviceSize>,
477 | |     ) -> Result<(Image, vk::Sampler)> {
    | |_____________________________________^
    |

5. vulkan_context.rs create_textures_descriptor_sets (8/7)

   --> hotham/src/resources/vulkan_context.rs:802:5
    |
802 | /     pub fn create_textures_descriptor_sets(
803 | |         &self,
804 | |         set_layout: vk::DescriptorSetLayout,
805 | |         material_name: &str,
...   |
810 | |         emissive_map: &Texture,
811 | |     ) -> VkResult<Vec<vk::DescriptorSet>> {
    | |_________________________________________^

Clippy: Type Complexity

warning: very complex type used. Consider factoring parts into type definitions

1. texture.rs

   --> hotham/src/texture.rs:183:6
    |
183 | ) -> Result<(Vec<u8>, u32, u32, vk::Format, u32, u32, Vec<vk::DeviceSize>)> {
    |      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    |

2. vertex.rs

  --> hotham/src/vertex.rs:35:12
   |
35 |           t: (
   |  ____________^
36 | |             Vector3<f32>,
37 | |             Vector3<f32>,
38 | |             Vector2<f32>,
...  |
41 | |             Vector4<f32>,
42 | |         ),
   | |_________^
   |

3. mod.rs

  --> examples/crab-saber/src/systems/mod.rs:15:9
   |
15 |         PreparedQuery<With<Visible, With<Cube, (&'a Colour, &'a RigidBody, &'a Collider)>>>,
   |         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
   |

Clippy: Non Send Fields in Send Type

1. audio_context.rs impl Send for AudioContext

warning: this implementation is unsound, as some fields in `AudioContext` are `!Send`                                                                                                                           
  --> hotham/src/resources/audio_context.rs:97:1                                                                                                                                                                
   |                                                                                                                                                                                                            
97 | unsafe impl Send for AudioContext {}                                                                                                                                                                       
   | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^                                                                                                                                                                       
   |                                                                                                                                                                                                            
   = note: `#[warn(clippy::non_send_fields_in_send_ty)]` on by default                                                                                                                                          
note: the type of field `stream` is `!Send`                                                                                                                                                                     
  --> hotham/src/resources/audio_context.rs:22:5                                                                                                                                                                
   |                                                                                                                                                                                                            
22 |     pub stream: Arc<Mutex<Stream>>,                                                                                                                                                                        
   |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^                                                                                                                                                                         
   = help: use a thread-safe type that implements `Send`                                                                                                                                                        

Background

Currently things in hotham look terrible. Let's fix that!

Research

• [x] Real-Time Rendering, Fourth Edition
• [x] Sascha's Implementation
• [x] Real Shading in Unreal
• [x] Substance's PBR guide
• [x] LearnOpenGL - PBR
• [x] Moving Frostbite to PBR

TODO

• [x] Write an integration test for rendering_system that takes a path to a gltf file and outputs the render to a file
• [x] Import @SaschaWillems PBR shaders

RenderContext

• [x] Update descriptor sets
  • [x] Update SceneSet
  • [x] Update MeshSet
  • [x] Add MaterialSet
• [x] Add Material struct
• [x] Update PushConsts
• [x] Update Pipeline
• [x] Add SceneParams
• [x] Update scene UBO -> can we stick with push constants for vertex shader?
• [x] Investigate handling of non-skinned entities

Mesh

• [x] Add Vec<Primitive>
• [x] Push VertexBuffer and IndexBuffer into Primitive
• [x] Add Material to Primitive
• [x] Add all material bindings
• [x] Add texture_descriptor_set to Primitive

renderer_system

• [x] Bind to correct descriptor sets
• [x] Multiview

gltf_importer

• [x] Update Vertex
• [x] Import correct Vertex attributes
• [x] Import correct images
• [x] Create Material

Test models

• [x] Broken helmet model correctly
• [x] Sponza correctly
• [x] THE GLORIOUS MCRN DONAGER correctly

Description

One of the most important things when releasing complex software is providing examples. Not only does it provide users with a transparent way to see "how" to do things with the software, it gives users confidence in "what" can be done with the software.

Since Hotham is first and foremost a VR game engine, we need to prove that we can make VR games with it. What better game to make than Beat Saber?

This will require careful planning - it'd be very easy to get derailed and stuck in the weeds here. Beat Saber is a big and complex game, but there should be a way to cut it down to its simplest elements and recreate them.

TODO

Research

• [x] Play the game and break down all its elements systematically
• [x] Look for other examples of people cloning the game - what did they leave in, what did they out?

Assets

• [x] Create a "bill of materials" - what will need to be included in the game?
• [x] Acquire/build assets

Programming

• [x] Sketch out a rough shape of what the code would look like
• [x] Identify missing engine features
• [x] #94
• [x] Implement Saber System
• [x] Implement Game System
• [x] #105
• [ ] Implement #93
• [ ] Implement #52

Makes the implementation of all kinds of locomotion a lot simpler - just transform the Room in space.

Should work for teleportation as well as more granular kinds.

Includes systems for correcting the views (update_views_with_room_transform) and for adding the Room entity & parenting Hands (add_room).

Closes #295

Background

Shared memory between CPU and GPU needs to be handled carefully:

07-12 18:40:02.018 11598 11675 I VrApi   : FPS=62/72,Prd=40ms,Tear=0,Early=0,Stale=20,VSnc=0,Lat=-1,Fov=0,CPU4/GPU=2/3,1171/490MHz,OC=FF,TA=0/0/0,SP=N/N/N,Mem=1804MHz,Free=560MB,PLS=0,Temp=31.0C/0.0C,TW=1.05ms,App=13.52ms,GD=0.00ms,CPU&GPU=20.85ms,LCnt=1,GPU%=0.96,CPU%=0.07(W0.10),DSF=1.00
07-12 18:40:02.069 11598 11624 I RustStdoutStderr: Adding Damaged Helmet to world
07-12 18:40:02.069 11598 11624 I RustStdoutStderr: [HOTHAM_STRESS_TEST] There are now 237 models
07-12 18:40:02.400 11598 11625 W Adreno-GSL: <gsl_ldd_control:556>: ioctl fd 56 code 0xc040094a (IOCTL_KGSL_GPU_COMMAND) failed: errno 71 Protocol error
07-12 18:40:02.400 11598 11625 W Adreno-GSL: <log_gpu_snapshot:464>: panel.gpuSnapshotPath is not set.not generating user snapshot
07-12 18:40:02.458 11598 11625 W Adreno-GSL: <gsl_ldd_control:556>: ioctl fd 56 code 0xc040094a (IOCTL_KGSL_GPU_COMMAND) failed: errno 35 Resource deadlock would occur
07-12 18:40:02.458 11598 11625 W Adreno-GSL: <log_gpu_snapshot:464>: panel.gpuSnapshotPath is not set.not generating user snapshot

• Rename transforms to LocalTransform and GlobalTransform
• Rename related systems.
• ~~Add update_global_transforms_system that calls update_transform_matrix_system and update_parent_transform_matrix_system. This is because they don't make much sense to run separately.~~

At present our frustum culling is both slow and incorrect.

An optimisation was made by @kanerogers to create a virtual frustum incorporating both cameras, but this has not proven to be correct. In addition, the underlying isVisible function in the compute shader is extremely expensive, and should, if possible, be reduced to a plane intersection check.

Background

After the upgrade of the glTF importer and the new rendering backend, the hands animation is no longer working. This is somewhat understandable as the way hands were being animated was a big hack.

glTF animation is well defined, but for some reason when exporting the default Oculus hands from Unity, the animations are completely mangled: instead of giving us keyframes between two states (hand open and hand closed) we get two animations, each with a single keyframe. We work around this by just creating a single animation and use each state (open and closed) as a keyframe.

TODO

• [ ] Should we just get better models with correct animations?

Changes:

• added a struct to store inputs over frames, so we can apply multiple directional movement to the camera
• added last_frame_time to the state so I can smooth the camera movement

Possible Todo's:

• Move camera in rotation direction, for full 3D movement, maybe something similar to unity?
• Might be worth adding test but probably not that much value?

Description

Our CI is good, but it could be better.

The complex thing here is #164, which we'll handle in a separate issue.

TODO

• [x] Add caching
• [ ] Add clippy
• [ ] Separate test from check

This is a subset of the krperf branch with several fixes added to fix stuff that was broken. There is at least one problem remaining: The desktop version of the helmet model has ambient occlusion stored in a separate texture but the support for that is dropped. This breaks the pbr rendering test.

This follows #413 and replaces #411.

Before merging:

• [ ] Update helmet model to fix ambient occlusion on desktop.
• [ ] Ensure render tests pass, updating images as needed.

What happened?

Attempting to run the device simulator on my linux setup fails every time. My setup is as follows:

OS: Ubuntu 22.04.1
Kernel: 5.15.0-56-generic
WM: i3
Compositor: picom
CPU: 13th Gen Intel i7-13700KF (24) @ 5.300GHz
GPU: NVIDIA GeForce RTX 3070 Ti
Memory: 2370MiB / 31913MiB

I am using the master branch of hotham, whose Cargo.toml files state a version of 0.2.0.

When running the hotham_crab_saber bin, in release mode, the window is created but closes before the first frame renders. The error printed is below.

Version

latest

In which Hotham component are you seeing the problem on?

Simulator

What VR System are you seeing the problem on?

None

What OS are you seeing the problem on?

Linux

Relevant log output

[HOTHAM_POLL_EVENT] State is now IDLE
[HOTHAM_POLL_EVENT] State is now READY
[HOTHAM_SIMULATOR] Beginning session: Session(42)
[HOTHAM_POLL_EVENT] State is now SYNCHRONIZED
[HOTHAM_POLL_EVENT] State is now FOCUSED
[HOTHAM_DRAW_GUI] Updating font texture..
[HOTHAM_VULKAN] Creating staging buffer..
[HOTHAM_VULKAN] Allocated 2097152 bits of buffer memory: 0x5626e5065dd0
[HOTHAM_VULKAN] ..done!
[HOTHAM_VULKAN] Copying buffer to image..
[HOTHAM_VULKAN] ..done! Transitioning image layout..
[HOTHAM_VULKAN] ..done! Freeing staging buffer..
[HOTHAM_VULKAN] ..done!
[HOTHAM_DRAW_GUI] Done!
[HOTHAM_SIMULATOR] !ERROR RENDERING FRAME! ERROR_OUT_OF_DATE_KHR
[HOTHAM_SIMULATOR] Destroy called..
[HOTHAM_SIMULATOR] Closed called!
[HOTHAM_SIMULATOR] Closed called!
[HOTHAM_SIMULATOR] Closed called!
[HOTHAM_SIMULATOR] All things are now destroyed
Error: OpenXRError(ERROR_VALIDATION_FAILURE)

When I tried de-duplicating this code by passing more parameters, it showed clearly in the many helmets stress test. This time, there is no significant difference! See dedup.txt vs main.txt.

I have also run test_rendering_pbr and it passes with no changes in the images.

~Almost working as it should. There is a problem with specular highlight that I am trying to pin down at the moment.~

~I also made a convenience thing for updating the pbr rendering tests if UPDATE_IMAGES env var is truthy. That might belong in a separate PR.~

I have fixed several issues with the spotlights and I think this is starting to look good enough now. There is a difference with rendering reflections of spotlights on very shiny surfaces. The new code is more likely to show a reflection of the spotlight but it it flickers. This is visible in the normal tangents test scene but not on the helmet.

I ran the many helmets benchmark but was surprised to see no difference in performance. Perhaps the bottleneck is somewhere else?