Mirrors/bevy
2
0
Fork 0
mirror of https://github.com/bevyengine/bevy synced 2024-11-10 07:04:33 +00:00
Code Issues Projects Releases Packages Wiki Activity

Document that gizmo depth_bias has no effect in 2D (#10074)

Browse source
This commit is contained in:
ira 2023-10-11 08:23:03 +02:00 committed by GitHub
parent e05a9f9315
commit f8cbc735ba
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
crates/bevy_gizmos/src/lib.rs
View file

@ -155,6 +155,8 @@ pub struct GizmoConfig {
pub line_perspective: bool, pub line_perspective: bool,
/// How closer to the camera than real geometry the line should be. /// 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). /// Value between -1 and 1 (inclusive).
/// * 0 means that there is no change to the line position when rendering /// * 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 it is furthest away from camera as possible
@ -162,7 +164,7 @@ pub struct GizmoConfig {
/// ///
/// This is typically useful if you are drawing wireframes on top of polygons /// 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. /// 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, pub depth_bias: f32,
/// Configuration for the [`AabbGizmo`]. /// Configuration for the [`AabbGizmo`].
pub aabb: AabbGizmoConfig, pub aabb: AabbGizmoConfig,