Skip to content

Commit f8cbc73

Browse files
Document that gizmo depth_bias has no effect in 2D (#10074)
1 parent e05a9f9 commit f8cbc73

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

crates/bevy_gizmos/src/lib.rs

+3-1
Original file line numberDiff line numberDiff line change
@@ -155,14 +155,16 @@ pub struct GizmoConfig {
155155
pub line_perspective: bool,
156156
/// How closer to the camera than real geometry the line should be.
157157
///
158+
/// In 2D this setting has no effect and is effectively always -1.
159+
///
158160
/// Value between -1 and 1 (inclusive).
159161
/// * 0 means that there is no change to the line position when rendering
160162
/// * 1 means it is furthest away from camera as possible
161163
/// * -1 means that it will always render in front of other things.
162164
///
163165
/// This is typically useful if you are drawing wireframes on top of polygons
164166
/// and your wireframe is z-fighting (flickering on/off) with your main model.
165-
/// You would set this value to a negative number close to 0.0.
167+
/// You would set this value to a negative number close to 0.
166168
pub depth_bias: f32,
167169
/// Configuration for the [`AabbGizmo`].
168170
pub aabb: AabbGizmoConfig,

0 commit comments

Comments
 (0)