-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
# Objective - Closes #8008 ## Solution - Add a skybox plugin that renders a fullscreen triangle, and then modifies the vertices in a vertex shader to enforce that it renders as a skybox background. - Skybox is run at the end of MainOpaquePass3dNode. - In the future, it would be nice to get something like bevy_atmosphere built-in, and have a default skybox+environment map light. --- ## Changelog - Added `Skybox`. - `EnvironmentMapLight` now renders in the correct orientation. ## Migration Guide - Flip `EnvironmentMapLight` maps if needed to match how they previously rendered (which was backwards). --------- Co-authored-by: Robert Swain <robert.swain@gmail.com> Co-authored-by: robtfm <50659922+robtfm@users.noreply.github.com>
- Loading branch information
3 people
authored
Apr 2, 2023
1 parent
7a9e77c
commit f0f5d79
Showing
8 changed files
with
349 additions
and
129 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,238 @@ | ||
| use bevy_app::{App, Plugin}; | ||
| use bevy_asset::{load_internal_asset, Handle, HandleUntyped}; | ||
| use bevy_ecs::{ | ||
| prelude::{Component, Entity}, | ||
| query::With, | ||
| schedule::IntoSystemConfigs, | ||
| system::{Commands, Query, Res, ResMut, Resource}, | ||
| }; | ||
| use bevy_reflect::TypeUuid; | ||
| use bevy_render::{ | ||
| extract_component::{ExtractComponent, ExtractComponentPlugin}, | ||
| render_asset::RenderAssets, | ||
| render_resource::{ | ||
| BindGroup, BindGroupDescriptor, BindGroupEntry, BindGroupLayout, BindGroupLayoutDescriptor, | ||
| BindGroupLayoutEntry, BindingResource, BindingType, BlendState, BufferBindingType, | ||
| CachedRenderPipelineId, ColorTargetState, ColorWrites, CompareFunction, DepthBiasState, | ||
| DepthStencilState, FragmentState, MultisampleState, PipelineCache, PrimitiveState, | ||
| RenderPipelineDescriptor, SamplerBindingType, Shader, ShaderStages, ShaderType, | ||
| SpecializedRenderPipeline, SpecializedRenderPipelines, StencilFaceState, StencilState, | ||
| TextureFormat, TextureSampleType, TextureViewDimension, VertexState, | ||
| }, | ||
| renderer::RenderDevice, | ||
| texture::{BevyDefault, Image}, | ||
| view::{ExtractedView, Msaa, ViewTarget, ViewUniform, ViewUniforms}, | ||
| Render, RenderApp, RenderSet, | ||
| }; | ||
|
|
||
| const SKYBOX_SHADER_HANDLE: HandleUntyped = | ||
| HandleUntyped::weak_from_u64(Shader::TYPE_UUID, 55594763423201); | ||
|
|
||
| pub struct SkyboxPlugin; | ||
|
|
||
| impl Plugin for SkyboxPlugin { | ||
| fn build(&self, app: &mut App) { | ||
| load_internal_asset!(app, SKYBOX_SHADER_HANDLE, "skybox.wgsl", Shader::from_wgsl); | ||
|
|
||
| app.add_plugin(ExtractComponentPlugin::<Skybox>::default()); | ||
|
|
||
| let render_app = match app.get_sub_app_mut(RenderApp) { | ||
| Ok(render_app) => render_app, | ||
| Err(_) => return, | ||
| }; | ||
|
|
||
| let render_device = render_app.world.resource::<RenderDevice>().clone(); | ||
|
|
||
| render_app | ||
| .insert_resource(SkyboxPipeline::new(&render_device)) | ||
| .init_resource::<SpecializedRenderPipelines<SkyboxPipeline>>() | ||
| .add_systems( | ||
| Render, | ||
| ( | ||
| prepare_skybox_pipelines.in_set(RenderSet::Prepare), | ||
| queue_skybox_bind_groups.in_set(RenderSet::Queue), | ||
| ), | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| /// Adds a skybox to a 3D camera, based on a cubemap texture. | ||
| /// | ||
| /// Note that this component does not (currently) affect the scene's lighting. | ||
| /// To do so, use `EnvironmentMapLight` alongside this component. | ||
| /// | ||
| /// See also <https://en.wikipedia.org/wiki/Skybox_(video_games)>. | ||
| #[derive(Component, ExtractComponent, Clone)] | ||
| pub struct Skybox(pub Handle<Image>); | ||
|
|
||
| #[derive(Resource)] | ||
| struct SkyboxPipeline { | ||
| bind_group_layout: BindGroupLayout, | ||
| } | ||
|
|
||
| impl SkyboxPipeline { | ||
| fn new(render_device: &RenderDevice) -> Self { | ||
| let bind_group_layout_descriptor = BindGroupLayoutDescriptor { | ||
| label: Some("skybox_bind_group_layout"), | ||
| entries: &[ | ||
| BindGroupLayoutEntry { | ||
| binding: 0, | ||
| visibility: ShaderStages::FRAGMENT, | ||
| ty: BindingType::Texture { | ||
| sample_type: TextureSampleType::Float { filterable: true }, | ||
| view_dimension: TextureViewDimension::Cube, | ||
| multisampled: false, | ||
| }, | ||
| count: None, | ||
| }, | ||
| BindGroupLayoutEntry { | ||
| binding: 1, | ||
| visibility: ShaderStages::FRAGMENT, | ||
| ty: BindingType::Sampler(SamplerBindingType::Filtering), | ||
| count: None, | ||
| }, | ||
| BindGroupLayoutEntry { | ||
| binding: 2, | ||
| visibility: ShaderStages::VERTEX_FRAGMENT, | ||
| ty: BindingType::Buffer { | ||
| ty: BufferBindingType::Uniform, | ||
| has_dynamic_offset: true, | ||
| min_binding_size: Some(ViewUniform::min_size()), | ||
| }, | ||
| count: None, | ||
| }, | ||
| ], | ||
| }; | ||
|
|
||
| Self { | ||
| bind_group_layout: render_device | ||
| .create_bind_group_layout(&bind_group_layout_descriptor), | ||
| } | ||
| } | ||
| } | ||
|
|
||
| #[derive(PartialEq, Eq, Hash, Clone, Copy)] | ||
| struct SkyboxPipelineKey { | ||
| hdr: bool, | ||
| samples: u32, | ||
| } | ||
|
|
||
| impl SpecializedRenderPipeline for SkyboxPipeline { | ||
| type Key = SkyboxPipelineKey; | ||
|
|
||
| fn specialize(&self, key: Self::Key) -> RenderPipelineDescriptor { | ||
| RenderPipelineDescriptor { | ||
| label: Some("skybox_pipeline".into()), | ||
| layout: vec![self.bind_group_layout.clone()], | ||
| push_constant_ranges: Vec::new(), | ||
| vertex: VertexState { | ||
| shader: SKYBOX_SHADER_HANDLE.typed(), | ||
| shader_defs: Vec::new(), | ||
| entry_point: "skybox_vertex".into(), | ||
| buffers: Vec::new(), | ||
| }, | ||
| primitive: PrimitiveState::default(), | ||
| depth_stencil: Some(DepthStencilState { | ||
| format: TextureFormat::Depth32Float, | ||
| depth_write_enabled: false, | ||
| depth_compare: CompareFunction::GreaterEqual, | ||
| stencil: StencilState { | ||
| front: StencilFaceState::IGNORE, | ||
| back: StencilFaceState::IGNORE, | ||
| read_mask: 0, | ||
| write_mask: 0, | ||
| }, | ||
| bias: DepthBiasState { | ||
| constant: 0, | ||
| slope_scale: 0.0, | ||
| clamp: 0.0, | ||
| }, | ||
| }), | ||
| multisample: MultisampleState { | ||
| count: key.samples, | ||
| mask: !0, | ||
| alpha_to_coverage_enabled: false, | ||
| }, | ||
| fragment: Some(FragmentState { | ||
| shader: SKYBOX_SHADER_HANDLE.typed(), | ||
| shader_defs: Vec::new(), | ||
| entry_point: "skybox_fragment".into(), | ||
| targets: vec![Some(ColorTargetState { | ||
| format: if key.hdr { | ||
| ViewTarget::TEXTURE_FORMAT_HDR | ||
| } else { | ||
| TextureFormat::bevy_default() | ||
| }, | ||
| blend: Some(BlendState::REPLACE), | ||
| write_mask: ColorWrites::ALL, | ||
| })], | ||
| }), | ||
| } | ||
| } | ||
| } | ||
|
|
||
| #[derive(Component)] | ||
| pub struct SkyboxPipelineId(pub CachedRenderPipelineId); | ||
|
|
||
| fn prepare_skybox_pipelines( | ||
| mut commands: Commands, | ||
| pipeline_cache: Res<PipelineCache>, | ||
| mut pipelines: ResMut<SpecializedRenderPipelines<SkyboxPipeline>>, | ||
| pipeline: Res<SkyboxPipeline>, | ||
| msaa: Res<Msaa>, | ||
| views: Query<(Entity, &ExtractedView), With<Skybox>>, | ||
| ) { | ||
| for (entity, view) in &views { | ||
| let pipeline_id = pipelines.specialize( | ||
| &pipeline_cache, | ||
| &pipeline, | ||
| SkyboxPipelineKey { | ||
| hdr: view.hdr, | ||
| samples: msaa.samples(), | ||
| }, | ||
| ); | ||
|
|
||
| commands | ||
| .entity(entity) | ||
| .insert(SkyboxPipelineId(pipeline_id)); | ||
| } | ||
| } | ||
|
|
||
| #[derive(Component)] | ||
| pub struct SkyboxBindGroup(pub BindGroup); | ||
|
|
||
| fn queue_skybox_bind_groups( | ||
| mut commands: Commands, | ||
| pipeline: Res<SkyboxPipeline>, | ||
| view_uniforms: Res<ViewUniforms>, | ||
| images: Res<RenderAssets<Image>>, | ||
| render_device: Res<RenderDevice>, | ||
| views: Query<(Entity, &Skybox)>, | ||
| ) { | ||
| for (entity, skybox) in &views { | ||
| if let (Some(skybox), Some(view_uniforms)) = | ||
| (images.get(&skybox.0), view_uniforms.uniforms.binding()) | ||
| { | ||
| let bind_group = render_device.create_bind_group(&BindGroupDescriptor { | ||
| label: Some("skybox_bind_group"), | ||
| layout: &pipeline.bind_group_layout, | ||
| entries: &[ | ||
| BindGroupEntry { | ||
| binding: 0, | ||
| resource: BindingResource::TextureView(&skybox.texture_view), | ||
| }, | ||
| BindGroupEntry { | ||
| binding: 1, | ||
| resource: BindingResource::Sampler(&skybox.sampler), | ||
| }, | ||
| BindGroupEntry { | ||
| binding: 2, | ||
| resource: view_uniforms, | ||
| }, | ||
| ], | ||
| }); | ||
|
|
||
| commands.entity(entity).insert(SkyboxBindGroup(bind_group)); | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.