Now handling the extraction of ViewRenderPhases; refactored PhaseItemExt; added a derive macro for creating PhaseItem newtypes; fix the example.

Author: momoluna444

assets/shaders/custom_mesh_pass_material.wgsl

@@ -1,7 +1,18 @@
-#import bevy_pbr::mesh_functions::{get_world_from_local, mesh_position_local_to_clip}
+#import bevy_pbr::{
+    mesh_functions::{get_world_from_local, mesh_position_local_to_clip}
+    
+}
+
+//forward_io::{Vertex, VertexOutput, FragmentOutput},
+
+// struct OutlineMaterial {
+//     outline_color: vec4<f32>,
+// }
+// @group(#{MATERIAL_BIND_GROUP}) @binding(100)
+// var<uniform> outline_material: OutlineMaterial;
+@group(#{MATERIAL_BIND_GROUP}) @binding(100) var<uniform> outline_color: vec4<f32>;
 
-@group(#{MATERIAL_BIND_GROUP}) @binding(0) var<uniform> color: vec4<f32>;  
-@group(#{MATERIAL_BIND_GROUP}) @binding(1) var<uniform> outline_color: vec4<f32>;
+const OUTLINE_WIDTH = 0.1;
 
 struct Vertex {
     @builtin(instance_index) instance_index: u32,
@@ -15,14 +26,18 @@ struct VertexOutput {
 @vertex
 fn vertex(vertex: Vertex) -> VertexOutput {
     var out: VertexOutput;
+
+    // This only works when the mesh is at the origin.
+    let expanded_position = vertex.position * (1 + OUTLINE_WIDTH);
+
     out.clip_position = mesh_position_local_to_clip(
         get_world_from_local(vertex.instance_index),
-        vec4<f32>(vertex.position, 1.0),
+        vec4<f32>(expanded_position, 1.0),
     );
     return out;
 }
 
 @fragment
 fn fragment(input: VertexOutput) -> @location(0) vec4<f32> {
-    return color;
+    return outline_color;
 }

assets/shaders/custom_mesh_pass_outline_material.wgsl

@@ -167,8 +167,8 @@ impl Plugin for Core3dPlugin {
             .init_resource::<ViewBinnedRenderPhases<AlphaMask3dDeferred>>()
             .init_resource::<ViewSortedRenderPhases<Transmissive3d>>()
             .init_resource::<ViewSortedRenderPhases<Transparent3d>>()
-            .add_systems(ExtractSchedule, extract_core_3d_camera_phases)
-            .add_systems(ExtractSchedule, extract_camera_prepass_phase)
+            // .add_systems(ExtractSchedule, extract_core_3d_camera_phases)
+            // .add_systems(ExtractSchedule, extract_camera_prepass_phase)
             .add_systems(
                 Render,
                 (

crates/bevy_core_pipeline/src/core_3d/mod.rs

@@ -34,6 +34,7 @@ use bevy_asset::UntypedAssetId;
 use bevy_ecs::prelude::*;
 use bevy_math::Mat4;
 use bevy_reflect::{std_traits::ReflectDefault, Reflect};
+use bevy_render::extract_component::ExtractComponent;
 use bevy_render::mesh::allocator::SlabId;
 use bevy_render::render_phase::PhaseItemBatchSetKey;
 use bevy_render::sync_world::MainEntity;
@@ -53,27 +54,27 @@ pub const NORMAL_PREPASS_FORMAT: TextureFormat = TextureFormat::Rgb10a2Unorm;
 pub const MOTION_VECTOR_PREPASS_FORMAT: TextureFormat = TextureFormat::Rg16Float;
 
 /// If added to a [`bevy_camera::Camera3d`] then depth values will be copied to a separate texture available to the main pass.
-#[derive(Component, Default, Reflect, Clone)]
+#[derive(Component, Default, Reflect, Clone, ExtractComponent)]
 #[reflect(Component, Default, Clone)]
 pub struct DepthPrepass;
 
 /// If added to a [`bevy_camera::Camera3d`] then vertex world normals will be copied to a separate texture available to the main pass.
 /// Normals will have normal map textures already applied.
-#[derive(Component, Default, Reflect, Clone)]
+#[derive(Component, Default, Reflect, Clone, ExtractComponent)]
 #[reflect(Component, Default, Clone)]
 pub struct NormalPrepass;
 
 /// If added to a [`bevy_camera::Camera3d`] then screen space motion vectors will be copied to a separate texture available to the main pass.
 ///
 /// Motion vectors are stored in the range -1,1, with +x right and +y down.
 /// A value of (1.0,1.0) indicates a pixel moved from the top left corner to the bottom right corner of the screen.
-#[derive(Component, Default, Reflect, Clone)]
+#[derive(Component, Default, Reflect, Clone, ExtractComponent)]
 #[reflect(Component, Default, Clone)]
 pub struct MotionVectorPrepass;
 
 /// If added to a [`bevy_camera::Camera3d`] then deferred materials will be rendered to the deferred gbuffer texture and will be available to subsequent passes.
 /// Note the default deferred lighting plugin also requires `DepthPrepass` to work correctly.
-#[derive(Component, Default, Reflect)]
+#[derive(Component, Default, Reflect, Clone, ExtractComponent)]
 #[reflect(Component, Default)]
 pub struct DeferredPrepass;
 

crates/bevy_core_pipeline/src/prepass/mod.rs

@@ -4,14 +4,17 @@ use bevy_core_pipeline::core_3d::{Opaque3dBatchSetKey, Opaque3dBinKey};
 use bevy_ecs::entity::Entity;
 use bevy_render::{
     render_phase::{
-        BinnedPhaseItem, BinnedRenderPhase, BinnedRenderPhasePlugin, CachedRenderPipelinePhaseItem,
-        DrawFunctionId, PhaseItem, PhaseItemExtraIndex, ViewBinnedRenderPhases,
+        BinnedPhaseItem, CachedRenderPipelinePhaseItem, DrawFunctionId, PhaseItem,
+        PhaseItemExtraIndex,
     },
     render_resource::CachedRenderPipelineId,
     sync_world::MainEntity,
 };
 
-use crate::{MeshPass, MeshPipeline, PhaseContext, PhaseItemExt, PhaseItems, RenderPhaseType};
+use crate::{
+    BinnedPhaseFamily, MeshPass, NoExtractCondition, PIEPhase, PhaseContext, PhaseItemExt,
+    PhaseItems, RenderPhaseType,
+};
 
 const DUMMY_PHASE_ERROR: &str = "Dummy phase should never be instantiated.";
 
@@ -23,11 +26,10 @@ macro_rules! define_dummy_phase {
             // Important: It must be empty to ensure it does not match any material.
             const PHASE_TYPES: RenderPhaseType = RenderPhaseType::empty();
 
-            type RenderPhase = BinnedRenderPhase<Self>;
-            type RenderPhases = ViewBinnedRenderPhases<Self>;
-            type PhasePlugin = BinnedRenderPhasePlugin<Self, MeshPipeline>;
+            type PhaseFamily = BinnedPhaseFamily<Self>;
+            type ExtractCondition = NoExtractCondition;
 
-            fn queue(_render_phase: &mut Self::RenderPhase, _context: &PhaseContext) {
+            fn queue(_render_phase: &mut PIEPhase<Self>, _context: &PhaseContext) {
                 panic!("{}", DUMMY_PHASE_ERROR)
             }
         }
@@ -96,10 +98,10 @@ where
     P: MeshPass,
     PIE: PhaseItemExt,
 {
-    type Phase1 = PIE;
-    type Phase2 = DummyPhase2<P>;
-    type Phase3 = DummyPhase3<P>;
-    type Phase4 = DummyPhase4<P>;
+    type PIE1 = PIE;
+    type PIE2 = DummyPhase2<P>;
+    type PIE3 = DummyPhase3<P>;
+    type PIE4 = DummyPhase4<P>;
 
     fn count() -> usize {
         1
@@ -111,10 +113,10 @@ where
     P: MeshPass,
     PIE1: PhaseItemExt,
 {
-    type Phase1 = PIE1;
-    type Phase2 = DummyPhase2<P>;
-    type Phase3 = DummyPhase3<P>;
-    type Phase4 = DummyPhase4<P>;
+    type PIE1 = PIE1;
+    type PIE2 = DummyPhase2<P>;
+    type PIE3 = DummyPhase3<P>;
+    type PIE4 = DummyPhase4<P>;
 
     fn count() -> usize {
         1
@@ -127,10 +129,10 @@ where
     PIE1: PhaseItemExt,
     PIE2: PhaseItemExt,
 {
-    type Phase1 = PIE1;
-    type Phase2 = PIE2;
-    type Phase3 = DummyPhase3<P>;
-    type Phase4 = DummyPhase4<P>;
+    type PIE1 = PIE1;
+    type PIE2 = PIE2;
+    type PIE3 = DummyPhase3<P>;
+    type PIE4 = DummyPhase4<P>;
 
     fn count() -> usize {
         2
@@ -144,10 +146,10 @@ where
     PIE2: PhaseItemExt,
     PIE3: PhaseItemExt,
 {
-    type Phase1 = PIE1;
-    type Phase2 = PIE2;
-    type Phase3 = PIE3;
-    type Phase4 = DummyPhase4<P>;
+    type PIE1 = PIE1;
+    type PIE2 = PIE2;
+    type PIE3 = PIE3;
+    type PIE4 = DummyPhase4<P>;
 
     fn count() -> usize {
         3
@@ -162,10 +164,10 @@ where
     PIE3: PhaseItemExt,
     PIE4: PhaseItemExt,
 {
-    type Phase1 = PIE1;
-    type Phase2 = PIE2;
-    type Phase3 = PIE3;
-    type Phase4 = PIE4;
+    type PIE1 = PIE1;
+    type PIE2 = PIE2;
+    type PIE3 = PIE3;
+    type PIE4 = PIE4;
 
     fn count() -> usize {
         4

crates/bevy_pbr/src/dummy_phase.rs

@@ -16,7 +16,7 @@ use bevy_render::{
 };
 use bevy_shader::ShaderRef;
 
-use crate::{Material, MaterialPipeline, MaterialPipelineKey, MeshPipeline, MeshPipelineKey};
+use crate::{DeferredPass, MainPass, Material, MaterialPipeline, MaterialPipelineKey, MeshPass, MeshPipeline, MeshPipelineKey, PassId, PassShaders, Prepass, ShaderSet};
 
 pub struct MaterialExtensionPipeline {
     pub mesh_pipeline: MeshPipeline,
@@ -25,12 +25,27 @@ pub struct MaterialExtensionPipeline {
 pub struct MaterialExtensionKey<E: MaterialExtension> {
     pub mesh_key: MeshPipelineKey,
     pub bind_group_data: E::Data,
+    pub pass_id: PassId,
 }
 
 /// A subset of the `Material` trait for defining extensions to a base `Material`, such as the builtin `StandardMaterial`.
 ///
 /// A user type implementing the trait should be used as the `E` generic param in an `ExtendedMaterial` struct.
 pub trait MaterialExtension: Asset + AsBindGroup + Clone + Sized {
+    /// Returns this material's shaders for supported passes.
+    ///
+    /// When the traditional shader method is used, the corresponding pass's shader in the [`PassShaders`] will be ignored.
+    /// Currently, only [`MainPass`], [`DeferredPass`] and [`Prepass`] are supported out of the box.
+    fn shaders() -> PassShaders {
+        let mut pass_shaders = PassShaders::default();
+        pass_shaders.extend([
+            (Prepass::id(), ShaderSet::default()),
+            (DeferredPass::id(), ShaderSet::default()),
+            (MainPass::id(), ShaderSet::default()),
+        ]);
+        pass_shaders
+    }
+
     /// Returns this material's vertex shader. If [`ShaderRef::Default`] is returned, the base material mesh vertex shader
     /// will be used.
     fn vertex_shader() -> ShaderRef {
@@ -309,6 +324,10 @@ impl<B: Material, E: MaterialExtension> AsBindGroup for ExtendedMaterial<B, E> {
 }
 
 impl<B: Material, E: MaterialExtension> Material for ExtendedMaterial<B, E> {
+    fn shaders() -> PassShaders {
+        E::shaders()
+    }
+
     fn vertex_shader() -> ShaderRef {
         match E::vertex_shader() {
             ShaderRef::Default => B::vertex_shader(),
@@ -412,6 +431,7 @@ impl<B: Material, E: MaterialExtension> Material for ExtendedMaterial<B, E> {
         let base_key = MaterialPipelineKey::<B> {
             mesh_key: key.mesh_key,
             bind_group_data: key.bind_group_data.base,
+            pass_id: key.pass_id,
         };
         B::specialize(pipeline, descriptor, layout, base_key)?;
 
@@ -425,6 +445,7 @@ impl<B: Material, E: MaterialExtension> Material for ExtendedMaterial<B, E> {
             MaterialExtensionKey {
                 mesh_key: key.mesh_key,
                 bind_group_data: key.bind_group_data.extension,
+                pass_id: key.pass_id,
             },
         )
     }