Document the uniform buffers

rerun-io · Mar 27, 2023 · dbd865e · dbd865e
1 parent 94cc46e
commit dbd865e
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 3 deletions.
diff --git a/crates/re_renderer/shader/depth_cloud.wgsl b/crates/re_renderer/shader/depth_cloud.wgsl
@@ -53,6 +53,8 @@ fn compute_point_data(quad_idx: i32) -> PointData {
 // ---
 
 /// Keep in sync with `DepthCloudInfoUBO` in `depth_cloud.rs`.
+///
+/// Same for all draw-phases.
 struct DepthCloudInfo {
     /// The extrinsincs of the camera used for the projection.
     world_from_obj: Mat4,
@@ -84,6 +86,9 @@ var<uniform> depth_cloud_info: DepthCloudInfo;
 @group(1) @binding(1)
 var depth_texture: texture_2d<f32>;
 
+/// Keep in sync with `DrawDataUniformBuffer` in `depth_cloud.rs`.
+///
+/// Changes between the opaque and outline draw-phases.
 struct DrawDataUniformBuffer {
     radius_boost_in_ui_points: f32,
     // In actuality there is way more padding than this since we align all our uniform buffers to

diff --git a/crates/re_renderer/src/renderer/depth_cloud.rs b/crates/re_renderer/src/renderer/depth_cloud.rs
@@ -38,8 +38,9 @@ use super::{
 mod gpu_data {
     use crate::wgpu_buffer_types;
 
-    // - Keep in sync with mirror in depth_cloud.wgsl.
-    // - See `DepthCloud` for documentation.
+    /// Uniform buffer that is constant across all draw phases.
+    ///
+    /// Keep in sync with mirror in `depth_cloud.wgsl.`
     #[repr(C, align(256))]
     #[derive(Clone, Copy, bytemuck::Pod, bytemuck::Zeroable)]
     pub struct DepthCloudInfoUBO {
@@ -100,7 +101,9 @@ mod gpu_data {
         }
     }
 
-    /// Uniform buffer that changes once per draw data rendering.
+    /// Uniform buffer that changes between the opaque and outline draw-phases.
+    ///
+    /// Keep in sync with mirror in `depth_cloud.wgsl.`
     #[repr(C, align(256))]
     #[derive(Clone, Copy, bytemuck::Pod, bytemuck::Zeroable)]
     pub struct DrawDataUniformBuffer {