Skip to content

Commit

Permalink
Document that gizmo depth_bias has no effect in 2D (bevyengine#10074)
Browse files Browse the repository at this point in the history
  • Loading branch information
tim-blackbird authored Oct 11, 2023
1 parent e05a9f9 commit f8cbc73
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion crates/bevy_gizmos/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -155,14 +155,16 @@ pub struct GizmoConfig {
pub line_perspective: bool,
/// How closer to the camera than real geometry the line should be.
///
/// In 2D this setting has no effect and is effectively always -1.
///
/// Value between -1 and 1 (inclusive).
/// * 0 means that there is no change to the line position when rendering
/// * 1 means it is furthest away from camera as possible
/// * -1 means that it will always render in front of other things.
///
/// This is typically useful if you are drawing wireframes on top of polygons
/// and your wireframe is z-fighting (flickering on/off) with your main model.
/// You would set this value to a negative number close to 0.0.
/// You would set this value to a negative number close to 0.
pub depth_bias: f32,
/// Configuration for the [`AabbGizmo`].
pub aabb: AabbGizmoConfig,
Expand Down

0 comments on commit f8cbc73

Please sign in to comment.