From e23d7cf5019ac809c9906f6f72b3aa6bf2decb73 Mon Sep 17 00:00:00 2001 From: Edgar Geier Date: Mon, 16 Oct 2023 15:39:17 +0200 Subject: [PATCH] Explain usage of prepass shaders in docs for `Material` trait (#9025) # Objective - Fixes #8696. ## Solution - Added a paragraph describing the usage of the `prepass_vertex_shader` and `prepass_fragment_shader`. --- crates/bevy_pbr/src/material.rs | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/crates/bevy_pbr/src/material.rs b/crates/bevy_pbr/src/material.rs index 3674debfd4..4e1ded19b7 100644 --- a/crates/bevy_pbr/src/material.rs +++ b/crates/bevy_pbr/src/material.rs @@ -136,12 +136,18 @@ pub trait Material: Asset + AsBindGroup + Clone + Sized { /// Returns this material's prepass vertex shader. If [`ShaderRef::Default`] is returned, the default prepass vertex shader /// will be used. + /// + /// This is used for the various [prepasses](bevy_core_pipeline::prepass) as well as for generating the depth maps + /// required for shadow mapping. fn prepass_vertex_shader() -> ShaderRef { ShaderRef::Default } /// Returns this material's prepass fragment shader. If [`ShaderRef::Default`] is returned, the default prepass fragment shader /// will be used. + /// + /// This is used for the various [prepasses](bevy_core_pipeline::prepass) as well as for generating the depth maps + /// required for shadow mapping. #[allow(unused_variables)] fn prepass_fragment_shader() -> ShaderRef { ShaderRef::Default