Mirrors/bevy
2
0
Fork 0
mirror of https://github.com/bevyengine/bevy synced 2024-11-21 20:23:28 +00:00
Code Issues Projects Releases Packages Wiki Activity

Minor docs fixes (#16347)

Browse source 
Happened upon a few stray characters while reading about picking.
This commit is contained in:
Rich Churcher 2024-11-14 09:42:53 +13:00 committed by GitHub
parent db1915a1f0
commit bf9971f239
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 6 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
crates/bevy_picking/src/backend.rs
View file

@ -6,10 +6,10 @@
//! detail. //! detail.
//! //!
//! Because `bevy_picking` is very loosely coupled with its backends, you can mix and match as //! Because `bevy_picking` is very loosely coupled with its backends, you can mix and match as
//! many backends as you want. For example, You could use the `rapier` backend to raycast against //! many backends as you want. For example, you could use the `rapier` backend to raycast against
//! physics objects, a picking shader backend to pick non-physics meshes, and the `bevy_ui` backend //! physics objects, a picking shader backend to pick non-physics meshes, and the `bevy_ui` backend
//! for your UI. The [`PointerHits`]s produced by these various backends will be combined, sorted, //! for your UI. The [`PointerHits`] instances produced by these various backends will be combined,
//! and used as a homogeneous input for the picking systems that consume these events. //! sorted, and used as a homogeneous input for the picking systems that consume these events.
//! //!
//! ## Implementation //! ## Implementation
//! //!
@ -22,7 +22,7 @@
//! //!
//! - Backends do not need to consider the [`PickingBehavior`](crate::PickingBehavior) component, though they may //! - Backends do not need to consider the [`PickingBehavior`](crate::PickingBehavior) component, though they may
//! use it for optimization purposes. For example, a backend that traverses a spatial hierarchy //! use it for optimization purposes. For example, a backend that traverses a spatial hierarchy
//! may want to early exit if it intersects an entity that blocks lower entities from being //! may want to exit early if it intersects an entity that blocks lower entities from being
//! picked. //! picked.
//! //!
//! ### Raycasting Backends //! ### Raycasting Backends
@ -49,9 +49,8 @@ pub mod prelude {
/// An event produced by a picking backend after it has run its hit tests, describing the entities /// An event produced by a picking backend after it has run its hit tests, describing the entities
/// under a pointer. /// under a pointer.
/// ///
/// Some backends may only support providing the topmost entity; this is a valid limitation of some /// Some backends may only support providing the topmost entity; this is a valid limitation. For
/// backends. For example, a picking shader might only have data on the topmost rendered output from /// example, a picking shader might only have data on the topmost rendered output from its buffer.
/// its buffer.
/// ///
/// Note that systems reading these events in [`PreUpdate`](bevy_app) will not report ordering /// Note that systems reading these events in [`PreUpdate`](bevy_app) will not report ordering
/// ambiguities with picking backends. Take care to ensure such systems are explicitly ordered /// ambiguities with picking backends. Take care to ensure such systems are explicitly ordered