From bc4c7fd28c947f4129eeb06a03dba8331a79c4d0 Mon Sep 17 00:00:00 2001 From: Bruce Mitchener Date: Mon, 16 Oct 2023 23:54:41 +0700 Subject: [PATCH] Improve linking within `RenderSet` docs. --- crates/bevy_render/src/lib.rs | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/crates/bevy_render/src/lib.rs b/crates/bevy_render/src/lib.rs index 0011101740e45..7f013c0a4fb28 100644 --- a/crates/bevy_render/src/lib.rs +++ b/crates/bevy_render/src/lib.rs @@ -92,19 +92,19 @@ pub enum RenderSet { /// Queue drawable entities as phase items in [`RenderPhase`](crate::render_phase::RenderPhase)s /// ready for sorting Queue, - /// A sub-set within Queue where mesh entity queue systems are executed. Ensures `prepare_assets::` is completed. + /// A sub-set within [`Queue`](RenderSet::Queue) where mesh entity queue systems are executed. Ensures `prepare_assets::` is completed. QueueMeshes, - // TODO: This could probably be moved in favor of a system ordering abstraction in Render or Queue + // TODO: This could probably be moved in favor of a system ordering abstraction in `Render` or `Queue` /// Sort the [`RenderPhases`](render_phase::RenderPhase) here. PhaseSort, /// Prepare render resources from extracted data for the GPU based on their sorted order. /// Create [`BindGroups`](crate::render_resource::BindGroup) that depend on those data. Prepare, - /// A sub-set within Prepare for initializing buffers, textures and uniforms for use in bind groups. + /// A sub-set within [`Prepare`](RenderSet::Prepare) for initializing buffers, textures and uniforms for use in bind groups. PrepareResources, /// The copy of [`apply_deferred`] that runs between [`PrepareResources`](RenderSet::PrepareResources) and ['PrepareBindGroups'](RenderSet::PrepareBindGroups). PrepareResourcesFlush, - /// A sub-set within Prepare for constructing bind groups, or other data that relies on render resources prepared in [`PrepareResources`](RenderSet::PrepareResources). + /// A sub-set within [`Prepare`](RenderSet::Prepare) for constructing bind groups, or other data that relies on render resources prepared in [`PrepareResources`](RenderSet::PrepareResources). PrepareBindGroups, /// The copy of [`apply_deferred`] that runs immediately after [`Prepare`](RenderSet::Prepare). PrepareFlush, @@ -127,7 +127,7 @@ impl Render { /// Sets up the base structure of the rendering [`Schedule`]. /// /// The sets defined in this enum are configured to run in order, - /// and a copy of [`apply_deferred`] is inserted into each `*Flush` set. + /// and a copy of [`apply_deferred`] is inserted into each [`*Flush` set](RenderSet). pub fn base_schedule() -> Schedule { use RenderSet::*;