Clarify per-object binding dynamic offset's purpose in phase items

bevyengine · Jul 25, 2023 · 8c50fdb · 8c50fdb
1 parent 505af3e
commit 8c50fdb
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 0 deletions.
diff --git a/crates/bevy_core_pipeline/src/core_3d/mod.rs b/crates/bevy_core_pipeline/src/core_3d/mod.rs
@@ -136,6 +136,8 @@ impl Plugin for Core3dPlugin {
 
 pub struct Opaque3d {
  pub distance: f32,
+ // Per-object data may be bound at different dynamic offsets within a buffer. If it is, then
+ // each batch of per-object data starts at the same dynamic offset.
  pub per_object_binding_dynamic_offset: u32,
  pub pipeline: CachedRenderPipelineId,
  pub entity: Entity,
@@ -183,6 +185,8 @@ impl CachedRenderPipelinePhaseItem for Opaque3d {
 
 pub struct AlphaMask3d {
  pub distance: f32,
+ // Per-object data may be bound at different dynamic offsets within a buffer. If it is, then
+ // each batch of per-object data starts at the same dynamic offset.
  pub per_object_binding_dynamic_offset: u32,
  pub pipeline: CachedRenderPipelineId,
  pub entity: Entity,

diff --git a/crates/bevy_core_pipeline/src/prepass/mod.rs b/crates/bevy_core_pipeline/src/prepass/mod.rs
@@ -80,6 +80,8 @@ pub struct ViewPrepassTextures {
 /// Used to render all 3D meshes with materials that have no transparency.
 pub struct Opaque3dPrepass {
  pub distance: f32,
+ // Per-object data may be bound at different dynamic offsets within a buffer. If it is, then
+ // each batch of per-object data starts at the same dynamic offset.
  pub per_object_binding_dynamic_offset: u32,
  pub entity: Entity,
  pub pipeline_id: CachedRenderPipelineId,
@@ -132,6 +134,8 @@ impl CachedRenderPipelinePhaseItem for Opaque3dPrepass {
 /// Used to render all meshes with a material with an alpha mask.
 pub struct AlphaMask3dPrepass {
  pub distance: f32,
+ // Per-object data may be bound at different dynamic offsets within a buffer. If it is, then
+ // each batch of per-object data starts at the same dynamic offset.
  pub per_object_binding_dynamic_offset: u32,
  pub entity: Entity,
  pub pipeline_id: CachedRenderPipelineId,

diff --git a/crates/bevy_pbr/src/render/light.rs b/crates/bevy_pbr/src/render/light.rs
@@ -1666,6 +1666,8 @@ pub fn queue_shadows<M: Material>(
 
 pub struct Shadow {
  pub distance: f32,
+ // Per-object data may be bound at different dynamic offsets within a buffer. If it is, then
+ // each batch of per-object data starts at the same dynamic offset.
  pub per_object_binding_dynamic_offset: u32,
  pub entity: Entity,
  pub pipeline: CachedRenderPipelineId,