bevy_pbr2: Improvements to comments

Author: superdump

pipelined/bevy_pbr2/src/render/mesh_view_bind_group.wgsl

@@ -11,7 +11,7 @@ struct View {
 };
 
 struct PointLight {
-    // NOTE: .z.z .z.w .w.z .w.w
+    // NOTE: [2][2] [2][3] [3][2] [3][3]
     projection_lr: vec4<f32>;
     color_inverse_square_range: vec4<f32>;
     position_radius: vec4<f32>;
@@ -40,10 +40,12 @@ struct Lights {
     // NOTE: this array size must be kept in sync with the constants defined bevy_pbr2/src/render/light.rs
     directional_lights: array<DirectionalLight, 1u>;
     ambient_color: vec4<f32>;
-    cluster_dimensions: vec4<u32>; // x/y/z dimensions
-    cluster_factors: vec4<f32>; // xy are vec2<f32>(cluster_dimensions.xy) / vec2<f32>(view.width, view.height)
-                                // z is cluster_dimensions.z / log(far / near)
-                                // w is cluster_dimensions.z * log(near) / log(far / near)
+    // x/y/z dimensions
+    cluster_dimensions: vec4<u32>;
+    // xy are vec2<f32>(cluster_dimensions.xy) / vec2<f32>(view.width, view.height)
+    // z is cluster_dimensions.z / log(far / near)
+    // w is cluster_dimensions.z * log(near) / log(far / near)
+    cluster_factors: vec4<f32>;
     n_directional_lights: u32;
 };
 
@@ -54,13 +56,15 @@ struct PointLights {
 
 [[block]]
 struct ClusterLightIndexLists {
-    data: array<vec4<u32>, 1024u>; // each u32 contains 4 u8 indices into the PointLights array
+    // each u32 contains 4 u8 indices into the PointLights array
+    data: array<vec4<u32>, 1024u>;
 };
 
 [[block]]
 struct ClusterOffsetsAndCounts {
-    data: array<vec4<u32>, 1024u>; // each u32 contains a 24-bit index into ClusterLightIndexLists in the high 24 bits
-                             // and an 8-bit count of the number of lights in the low 8 bits
+    // each u32 contains a 24-bit index into ClusterLightIndexLists in the high 24 bits
+    // and an 8-bit count of the number of lights in the low 8 bits
+    data: array<vec4<u32>, 1024u>;
 };
 
 [[group(0), binding(0)]]

pipelined/bevy_pbr2/src/render/mod.rs

@@ -279,9 +279,9 @@ pub fn queue_meshes(
                                 draw_function: draw_opaque_pbr,
                                 pipeline: pipeline_id,
                                 // NOTE: Front-to-back ordering for opaque with ascending sort means near should have the
-                                //       lowest sort key and getting further away should increase. As we have
-                                //       -z in front of the camera, values in view space decrease away from the
-                                //       camera. Flipping the sign of mesh_z results in the correct front-to-back ordering
+                                // lowest sort key and getting further away should increase. As we have
+                                // -z in front of the camera, values in view space decrease away from the
+                                // camera. Flipping the sign of mesh_z results in the correct front-to-back ordering
                                 distance: -mesh_z,
                             });
                         }
@@ -291,9 +291,9 @@ pub fn queue_meshes(
                                 draw_function: draw_alpha_mask_pbr,
                                 pipeline: pipeline_id,
                                 // NOTE: Front-to-back ordering for alpha mask with ascending sort means near should have the
-                                //       lowest sort key and getting further away should increase. As we have
-                                //       -z in front of the camera, values in view space decrease away from the
-                                //       camera. Flipping the sign of mesh_z results in the correct front-to-back ordering
+                                // lowest sort key and getting further away should increase. As we have
+                                // -z in front of the camera, values in view space decrease away from the
+                                // camera. Flipping the sign of mesh_z results in the correct front-to-back ordering
                                 distance: -mesh_z,
                             });
                         }
@@ -303,9 +303,9 @@ pub fn queue_meshes(
                                 draw_function: draw_transparent_pbr,
                                 pipeline: pipeline_id,
                                 // NOTE: Back-to-front ordering for transparent with ascending sort means far should have the
-                                //       lowest sort key and getting closer should increase. As we have
-                                //       -z in front of the camera, the largest distance is -far with values increasing toward the
-                                //       camera. As such we can just use mesh_z as the distance
+                                // lowest sort key and getting closer should increase. As we have
+                                // -z in front of the camera, the largest distance is -far with values increasing toward the
+                                // camera. As such we can just use mesh_z as the distance
                                 distance: mesh_z,
                             });
                         }