use crate::{ config::{GizmoLineJoint, GizmoLineStyle, GizmoMeshConfig}, line_gizmo_vertex_buffer_layouts, line_joint_gizmo_vertex_buffer_layouts, DrawLineGizmo, DrawLineJointGizmo, GizmoRenderSystem, GpuLineGizmo, LineGizmo, LineGizmoUniformBindgroupLayout, SetLineGizmoBindGroup, LINE_JOINT_SHADER_HANDLE, LINE_SHADER_HANDLE, }; use bevy_app::{App, Plugin}; use bevy_asset::Handle; use bevy_core_pipeline::{ core_3d::{Transparent3d, CORE_3D_DEPTH_FORMAT}, prepass::{DeferredPrepass, DepthPrepass, MotionVectorPrepass, NormalPrepass}, }; use bevy_ecs::{ prelude::Entity, query::Has, schedule::{IntoSystemConfigs, IntoSystemSetConfigs}, system::{Query, Res, ResMut, Resource}, world::{FromWorld, World}, }; use bevy_pbr::{MeshPipeline, MeshPipelineKey, SetMeshViewBindGroup}; use bevy_render::{ render_asset::{prepare_assets, RenderAssets}, render_phase::{ AddRenderCommand, DrawFunctions, PhaseItemExtraIndex, SetItemPipeline, ViewSortedRenderPhases, }, render_resource::*, texture::BevyDefault, view::{ExtractedView, Msaa, RenderLayers, ViewTarget}, Render, RenderApp, RenderSet, }; use bevy_utils::tracing::error; pub struct LineGizmo3dPlugin; impl Plugin for LineGizmo3dPlugin { fn build(&self, app: &mut App) { let Some(render_app) = app.get_sub_app_mut(RenderApp) else { return; }; render_app .add_render_command::() .add_render_command::() .init_resource::>() .init_resource::>() .configure_sets( Render, GizmoRenderSystem::QueueLineGizmos3d .in_set(RenderSet::Queue) .ambiguous_with(bevy_pbr::queue_material_meshes::), ) .add_systems( Render, (queue_line_gizmos_3d, queue_line_joint_gizmos_3d) .in_set(GizmoRenderSystem::QueueLineGizmos3d) .after(prepare_assets::), ); } fn finish(&self, app: &mut App) { let Some(render_app) = app.get_sub_app_mut(RenderApp) else { return; }; render_app.init_resource::(); render_app.init_resource::(); } } #[derive(Clone, Resource)] struct LineGizmoPipeline { mesh_pipeline: MeshPipeline, uniform_layout: BindGroupLayout, } impl FromWorld for LineGizmoPipeline { fn from_world(render_world: &mut World) -> Self { LineGizmoPipeline { mesh_pipeline: render_world.resource::().clone(), uniform_layout: render_world .resource::() .layout .clone(), } } } #[derive(PartialEq, Eq, Hash, Clone)] struct LineGizmoPipelineKey { view_key: MeshPipelineKey, strip: bool, perspective: bool, line_style: GizmoLineStyle, } impl SpecializedRenderPipeline for LineGizmoPipeline { type Key = LineGizmoPipelineKey; fn specialize(&self, key: Self::Key) -> RenderPipelineDescriptor { let mut shader_defs = vec![ #[cfg(feature = "webgl")] "SIXTEEN_BYTE_ALIGNMENT".into(), ]; if key.perspective { shader_defs.push("PERSPECTIVE".into()); } let format = if key.view_key.contains(MeshPipelineKey::HDR) { ViewTarget::TEXTURE_FORMAT_HDR } else { TextureFormat::bevy_default() }; let view_layout = self .mesh_pipeline .get_view_layout(key.view_key.into()) .clone(); let layout = vec![view_layout, self.uniform_layout.clone()]; let fragment_entry_point = match key.line_style { GizmoLineStyle::Solid => "fragment_solid", GizmoLineStyle::Dotted => "fragment_dotted", }; RenderPipelineDescriptor { vertex: VertexState { shader: LINE_SHADER_HANDLE, entry_point: "vertex".into(), shader_defs: shader_defs.clone(), buffers: line_gizmo_vertex_buffer_layouts(key.strip), }, fragment: Some(FragmentState { shader: LINE_SHADER_HANDLE, shader_defs, entry_point: fragment_entry_point.into(), targets: vec![Some(ColorTargetState { format, blend: Some(BlendState::ALPHA_BLENDING), write_mask: ColorWrites::ALL, })], }), layout, primitive: PrimitiveState::default(), depth_stencil: Some(DepthStencilState { format: CORE_3D_DEPTH_FORMAT, depth_write_enabled: true, depth_compare: CompareFunction::Greater, stencil: StencilState::default(), bias: DepthBiasState::default(), }), multisample: MultisampleState { count: key.view_key.msaa_samples(), mask: !0, alpha_to_coverage_enabled: false, }, label: Some("LineGizmo Pipeline".into()), push_constant_ranges: vec![], } } } #[derive(Clone, Resource)] struct LineJointGizmoPipeline { mesh_pipeline: MeshPipeline, uniform_layout: BindGroupLayout, } impl FromWorld for LineJointGizmoPipeline { fn from_world(render_world: &mut World) -> Self { LineJointGizmoPipeline { mesh_pipeline: render_world.resource::().clone(), uniform_layout: render_world .resource::() .layout .clone(), } } } #[derive(PartialEq, Eq, Hash, Clone)] struct LineJointGizmoPipelineKey { view_key: MeshPipelineKey, perspective: bool, joints: GizmoLineJoint, } impl SpecializedRenderPipeline for LineJointGizmoPipeline { type Key = LineJointGizmoPipelineKey; fn specialize(&self, key: Self::Key) -> RenderPipelineDescriptor { let mut shader_defs = vec![ #[cfg(feature = "webgl")] "SIXTEEN_BYTE_ALIGNMENT".into(), ]; if key.perspective { shader_defs.push("PERSPECTIVE".into()); } let format = if key.view_key.contains(MeshPipelineKey::HDR) { ViewTarget::TEXTURE_FORMAT_HDR } else { TextureFormat::bevy_default() }; let view_layout = self .mesh_pipeline .get_view_layout(key.view_key.into()) .clone(); let layout = vec![view_layout, self.uniform_layout.clone()]; if key.joints == GizmoLineJoint::None { error!("There is no entry point for line joints with GizmoLineJoints::None. Please consider aborting the drawing process before reaching this stage."); }; let entry_point = match key.joints { GizmoLineJoint::Miter => "vertex_miter", GizmoLineJoint::Round(_) => "vertex_round", GizmoLineJoint::None | GizmoLineJoint::Bevel => "vertex_bevel", }; RenderPipelineDescriptor { vertex: VertexState { shader: LINE_JOINT_SHADER_HANDLE, entry_point: entry_point.into(), shader_defs: shader_defs.clone(), buffers: line_joint_gizmo_vertex_buffer_layouts(), }, fragment: Some(FragmentState { shader: LINE_JOINT_SHADER_HANDLE, shader_defs, entry_point: "fragment".into(), targets: vec![Some(ColorTargetState { format, blend: Some(BlendState::ALPHA_BLENDING), write_mask: ColorWrites::ALL, })], }), layout, primitive: PrimitiveState::default(), depth_stencil: Some(DepthStencilState { format: CORE_3D_DEPTH_FORMAT, depth_write_enabled: true, depth_compare: CompareFunction::Greater, stencil: StencilState::default(), bias: DepthBiasState::default(), }), multisample: MultisampleState { count: key.view_key.msaa_samples(), mask: !0, alpha_to_coverage_enabled: false, }, label: Some("LineJointGizmo Pipeline".into()), push_constant_ranges: vec![], } } } type DrawLineGizmo3d = ( SetItemPipeline, SetMeshViewBindGroup<0>, SetLineGizmoBindGroup<1>, DrawLineGizmo, ); type DrawLineJointGizmo3d = ( SetItemPipeline, SetMeshViewBindGroup<0>, SetLineGizmoBindGroup<1>, DrawLineJointGizmo, ); #[allow(clippy::too_many_arguments)] fn queue_line_gizmos_3d( draw_functions: Res>, pipeline: Res, mut pipelines: ResMut>, pipeline_cache: Res, line_gizmos: Query<(Entity, &Handle, &GizmoMeshConfig)>, line_gizmo_assets: Res>, mut transparent_render_phases: ResMut>, mut views: Query<( Entity, &ExtractedView, &Msaa, Option<&RenderLayers>, ( Has, Has, Has, Has, ), )>, ) { let draw_function = draw_functions.read().get_id::().unwrap(); for ( view_entity, view, msaa, render_layers, (normal_prepass, depth_prepass, motion_vector_prepass, deferred_prepass), ) in &mut views { let Some(transparent_phase) = transparent_render_phases.get_mut(&view_entity) else { continue; }; let render_layers = render_layers.unwrap_or_default(); let mut view_key = MeshPipelineKey::from_msaa_samples(msaa.samples()) | MeshPipelineKey::from_hdr(view.hdr); if normal_prepass { view_key |= MeshPipelineKey::NORMAL_PREPASS; } if depth_prepass { view_key |= MeshPipelineKey::DEPTH_PREPASS; } if motion_vector_prepass { view_key |= MeshPipelineKey::MOTION_VECTOR_PREPASS; } if deferred_prepass { view_key |= MeshPipelineKey::DEFERRED_PREPASS; } for (entity, handle, config) in &line_gizmos { if !config.render_layers.intersects(render_layers) { continue; } let Some(line_gizmo) = line_gizmo_assets.get(handle) else { continue; }; let pipeline = pipelines.specialize( &pipeline_cache, &pipeline, LineGizmoPipelineKey { view_key, strip: line_gizmo.strip, perspective: config.line_perspective, line_style: config.line_style, }, ); transparent_phase.add(Transparent3d { entity, draw_function, pipeline, distance: 0., batch_range: 0..1, extra_index: PhaseItemExtraIndex::NONE, }); } } } #[allow(clippy::too_many_arguments)] fn queue_line_joint_gizmos_3d( draw_functions: Res>, pipeline: Res, mut pipelines: ResMut>, pipeline_cache: Res, line_gizmos: Query<(Entity, &Handle, &GizmoMeshConfig)>, line_gizmo_assets: Res>, mut transparent_render_phases: ResMut>, mut views: Query<( Entity, &ExtractedView, &Msaa, Option<&RenderLayers>, ( Has, Has, Has, Has, ), )>, ) { let draw_function = draw_functions .read() .get_id::() .unwrap(); for ( view_entity, view, msaa, render_layers, (normal_prepass, depth_prepass, motion_vector_prepass, deferred_prepass), ) in &mut views { let Some(transparent_phase) = transparent_render_phases.get_mut(&view_entity) else { continue; }; let render_layers = render_layers.unwrap_or_default(); let mut view_key = MeshPipelineKey::from_msaa_samples(msaa.samples()) | MeshPipelineKey::from_hdr(view.hdr); if normal_prepass { view_key |= MeshPipelineKey::NORMAL_PREPASS; } if depth_prepass { view_key |= MeshPipelineKey::DEPTH_PREPASS; } if motion_vector_prepass { view_key |= MeshPipelineKey::MOTION_VECTOR_PREPASS; } if deferred_prepass { view_key |= MeshPipelineKey::DEFERRED_PREPASS; } for (entity, handle, config) in &line_gizmos { if !config.render_layers.intersects(render_layers) { continue; } let Some(line_gizmo) = line_gizmo_assets.get(handle) else { continue; }; if !line_gizmo.strip || line_gizmo.joints == GizmoLineJoint::None { continue; } let pipeline = pipelines.specialize( &pipeline_cache, &pipeline, LineJointGizmoPipelineKey { view_key, perspective: config.line_perspective, joints: line_gizmo.joints, }, ); transparent_phase.add(Transparent3d { entity, draw_function, pipeline, distance: 0., batch_range: 0..1, extra_index: PhaseItemExtraIndex::NONE, }); } } }