Skip to content

Commit

Permalink
Centralize view z calculation in phase type constructors
Browse files Browse the repository at this point in the history
  • Loading branch information
@superdump
superdump committed May 2, 2022
1 parent a511971 commit 1002493
Show file tree
Hide file tree
Showing 10 changed files with 179 additions and 123 deletions.
1 change: 1 addition & 0 deletions crates/bevy_core_pipeline/Cargo.toml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ trace = []
bevy_app = { path = "../bevy_app", version = "0.8.0-dev" }
bevy_asset = { path = "../bevy_asset", version = "0.8.0-dev" }
bevy_ecs = { path = "../bevy_ecs", version = "0.8.0-dev" }
bevy_math = { path = "../bevy_math", version = "0.8.0-dev" }
bevy_render = { path = "../bevy_render", version = "0.8.0-dev" }
bevy_utils = { path = "../bevy_utils", version = "0.8.0-dev" }

127 changes: 110 additions & 17 deletions crates/bevy_core_pipeline/src/lib.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ pub mod prelude {
pub use crate::ClearColor;
}

use bevy_math::Mat4;
use bevy_utils::HashMap;

pub use clear_pass::*;
Expand Down Expand Up @@ -196,12 +197,32 @@ impl Plugin for CorePipelinePlugin {
}

pub struct Transparent2d {
pub sort_key: FloatOrd,
pub entity: Entity,
pub pipeline: CachedRenderPipelineId,
pub draw_function: DrawFunctionId,
sort_key: FloatOrd,
entity: Entity,
pipeline: CachedRenderPipelineId,
draw_function: DrawFunctionId,
/// Range in the vertex buffer of this item
pub batch_range: Option<Range<u32>>,
batch_range: Option<Range<u32>>,
}

impl Transparent2d {
// NOTE: This method exists for API consistency with the other phases defined below
#[inline]
pub fn new(
entity: Entity,
pipeline: CachedRenderPipelineId,
draw_function: DrawFunctionId,
sort_key: f32,
batch_range: Option<Range<u32>>,
) -> Self {
Self {
sort_key: FloatOrd(sort_key),
entity,
pipeline,
draw_function,
batch_range,
}
}
}

impl PhaseItem for Transparent2d {
Expand Down Expand Up @@ -243,10 +264,34 @@ impl BatchedPhaseItem for Transparent2d {
}

pub struct Opaque3d {
pub distance: f32,
pub pipeline: CachedRenderPipelineId,
pub entity: Entity,
pub draw_function: DrawFunctionId,
distance: f32,
pipeline: CachedRenderPipelineId,
entity: Entity,
draw_function: DrawFunctionId,
}

impl Opaque3d {
#[inline]
pub fn from_mesh_transform(
entity: Entity,
pipeline: CachedRenderPipelineId,
draw_function: DrawFunctionId,
inverse_view: &Mat4,
mesh_transform: &Mat4,
) -> Self {
Self {
// NOTE: row 2 of the inverse view transform dotted with column 3 of the mesh transform
// gives the z component of translation of the mesh in view space
// 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
// results in the correct front-to-back ordering
distance: -inverse_view.row(2).dot(mesh_transform.col(3)),
pipeline,
entity,
draw_function,
}
}
}

impl PhaseItem for Opaque3d {
Expand Down Expand Up @@ -278,10 +323,34 @@ impl CachedRenderPipelinePhaseItem for Opaque3d {
}

pub struct AlphaMask3d {
pub distance: f32,
pub pipeline: CachedRenderPipelineId,
pub entity: Entity,
pub draw_function: DrawFunctionId,
distance: f32,
pipeline: CachedRenderPipelineId,
entity: Entity,
draw_function: DrawFunctionId,
}

impl AlphaMask3d {
#[inline]
pub fn from_mesh_transform(
entity: Entity,
pipeline: CachedRenderPipelineId,
draw_function: DrawFunctionId,
inverse_view: &Mat4,
mesh_transform: &Mat4,
) -> Self {
Self {
// NOTE: row 2 of the inverse view transform dotted with column 3 of the mesh transform
// gives the z component of translation of the mesh in view space
// 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 results in the correct front-to-back ordering
distance: -inverse_view.row(2).dot(mesh_transform.col(3)),
pipeline,
entity,
draw_function,
}
}
}

impl PhaseItem for AlphaMask3d {
Expand Down Expand Up @@ -313,10 +382,34 @@ impl CachedRenderPipelinePhaseItem for AlphaMask3d {
}

pub struct Transparent3d {
pub distance: f32,
pub pipeline: CachedRenderPipelineId,
pub entity: Entity,
pub draw_function: DrawFunctionId,
distance: f32,
pipeline: CachedRenderPipelineId,
entity: Entity,
draw_function: DrawFunctionId,
}

impl Transparent3d {
#[inline]
pub fn from_mesh_transform(
entity: Entity,
pipeline: CachedRenderPipelineId,
draw_function: DrawFunctionId,
inverse_view: &Mat4,
mesh_transform: &Mat4,
) -> Self {
Self {
// NOTE: row 2 of the inverse view transform dotted with column 3 of the mesh transform
// gives the z component of translation of the mesh in view space
// 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 view z as it is
distance: inverse_view.row(2).dot(mesh_transform.col(3)),
pipeline,
entity,
draw_function,
}
}
}

impl PhaseItem for Transparent3d {
Expand Down
55 changes: 21 additions & 34 deletions crates/bevy_pbr/src/material.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -340,7 +340,6 @@ pub fn queue_material_meshes<M: SpecializedMaterial>(
.unwrap();

let inverse_view_matrix = view.transform.compute_matrix().inverse();
let inverse_view_row_2 = inverse_view_matrix.row(2);
let msaa_key = MeshPipelineKey::from_msaa_samples(msaa.samples);

for visible_entity in &visible_entities.entities {
Expand Down Expand Up @@ -376,45 +375,33 @@ pub fn queue_material_meshes<M: SpecializedMaterial>(
}
};

// NOTE: row 2 of the inverse view matrix dotted with column 3 of the model matrix
// gives the z component of translation of the mesh in view space
let mesh_z = inverse_view_row_2.dot(mesh_uniform.transform.col(3));
match alpha_mode {
AlphaMode::Opaque => {
opaque_phase.add(Opaque3d {
entity: *visible_entity,
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
distance: -mesh_z,
});
opaque_phase.add(Opaque3d::from_mesh_transform(
*visible_entity,
pipeline_id,
draw_opaque_pbr,
&inverse_view_matrix,
&mesh_uniform.transform,
));
}
AlphaMode::Mask(_) => {
alpha_mask_phase.add(AlphaMask3d {
entity: *visible_entity,
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
distance: -mesh_z,
});
alpha_mask_phase.add(AlphaMask3d::from_mesh_transform(
*visible_entity,
pipeline_id,
draw_alpha_mask_pbr,
&inverse_view_matrix,
&mesh_uniform.transform,
));
}
AlphaMode::Blend => {
transparent_phase.add(Transparent3d {
entity: *visible_entity,
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
distance: mesh_z,
});
transparent_phase.add(Transparent3d::from_mesh_transform(
*visible_entity,
pipeline_id,
draw_transparent_pbr,
&inverse_view_matrix,
&mesh_uniform.transform,
));
}
}
}
Expand Down
14 changes: 6 additions & 8 deletions crates/bevy_pbr/src/wireframe.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,6 @@ fn queue_wireframes(
let msaa_key = MeshPipelineKey::from_msaa_samples(msaa.samples);
for (view, mut opaque_phase) in views.iter_mut() {
let inverse_view_matrix = view.transform.compute_matrix().inverse();
let inverse_view_row_2 = inverse_view_matrix.row(2);

let add_render_phase =
|(entity, mesh_handle, mesh_uniform): (Entity, &Handle<Mesh>, &MeshUniform)| {
Expand All @@ -143,14 +142,13 @@ fn queue_wireframes(
return;
}
};
opaque_phase.add(Opaque3d {
opaque_phase.add(Opaque3d::from_mesh_transform(
entity,
pipeline: pipeline_id,
draw_function: draw_custom,
// NOTE: row 2 of the inverse view matrix dotted with column 3 of the model matrix
// gives the z component of translation of the mesh in view space
distance: inverse_view_row_2.dot(mesh_uniform.transform.col(3)),
});
pipeline_id,
draw_custom,
&inverse_view_matrix,
&mesh_uniform.transform,
));
}
};

Expand Down
19 changes: 7 additions & 12 deletions crates/bevy_sprite/src/mesh2d/material.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -347,18 +347,13 @@ pub fn queue_material2d_meshes<M: SpecializedMaterial2d>(
};

let mesh_z = mesh2d_uniform.transform.w_axis.z;
transparent_phase.add(Transparent2d {
entity: *visible_entity,
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
sort_key: FloatOrd(mesh_z),
// This material is not batched
batch_range: None,
});
transparent_phase.add(Transparent2d::new(
*visible_entity,
pipeline_id,
draw_transparent_pbr,
mesh_z,
None,
));
}
}
}
Expand Down
24 changes: 12 additions & 12 deletions crates/bevy_sprite/src/render/mod.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -497,7 +497,7 @@ pub fn queue_sprites(
});

// These items will be sorted by depth with other phase items
let sort_key = FloatOrd(extracted_sprite.transform.translation.z);
let sort_key = extracted_sprite.transform.translation.z;

// Store the vertex data and add the item to the render phase
if current_batch.colored {
Expand All @@ -512,13 +512,13 @@ pub fn queue_sprites(
colored_index += QUAD_INDICES.len() as u32;
let item_end = colored_index;

transparent_phase.add(Transparent2d {
draw_function: draw_sprite_function,
pipeline: colored_pipeline,
entity: current_batch_entity,
transparent_phase.add(Transparent2d::new(
current_batch_entity,
colored_pipeline,
draw_sprite_function,
sort_key,
batch_range: Some(item_start..item_end),
});
Some(item_start..item_end),
));
} else {
for i in QUAD_INDICES.iter() {
sprite_meta.vertices.push(SpriteVertex {
Expand All @@ -530,13 +530,13 @@ pub fn queue_sprites(
index += QUAD_INDICES.len() as u32;
let item_end = index;

transparent_phase.add(Transparent2d {
draw_function: draw_sprite_function,
transparent_phase.add(Transparent2d::new(
current_batch_entity,
pipeline,
entity: current_batch_entity,
draw_sprite_function,
sort_key,
batch_range: Some(item_start..item_end),
});
Some(item_start..item_end),
));
}
}
}
Expand Down
14 changes: 7 additions & 7 deletions examples/2d/mesh2d_manual.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -330,16 +330,16 @@ pub fn queue_colored_mesh2d(
pipelines.specialize(&mut pipeline_cache, &colored_mesh2d_pipeline, mesh2d_key);

let mesh_z = mesh2d_uniform.transform.w_axis.z;
transparent_phase.add(Transparent2d {
entity: *visible_entity,
draw_function: draw_colored_mesh2d,
pipeline: pipeline_id,
transparent_phase.add(Transparent2d::new(
*visible_entity,
pipeline_id,
draw_colored_mesh2d,
// The 2d render items are sorted according to their z value before rendering,
// in order to get correct transparency
sort_key: FloatOrd(mesh_z),
mesh_z,
// This material is not batched
batch_range: None,
});
None,
));
}
}
}
Expand Down
Loading

0 comments on commit 1002493

Please sign in to comment.