mirror of
https://github.com/bevyengine/bevy
synced 2024-11-26 22:50:19 +00:00
afbbbd7335
# Objective The names of numerous rendering components in Bevy are inconsistent and a bit confusing. Relevant names include: - `AutoExposureSettings` - `AutoExposureSettingsUniform` - `BloomSettings` - `BloomUniform` (no `Settings`) - `BloomPrefilterSettings` - `ChromaticAberration` (no `Settings`) - `ContrastAdaptiveSharpeningSettings` - `DepthOfFieldSettings` - `DepthOfFieldUniform` (no `Settings`) - `FogSettings` - `SmaaSettings`, `Fxaa`, `TemporalAntiAliasSettings` (really inconsistent??) - `ScreenSpaceAmbientOcclusionSettings` - `ScreenSpaceReflectionsSettings` - `VolumetricFogSettings` Firstly, there's a lot of inconsistency between `Foo`/`FooSettings` and `FooUniform`/`FooSettingsUniform` and whether names are abbreviated or not. Secondly, the `Settings` post-fix seems unnecessary and a bit confusing semantically, since it makes it seem like the component is mostly just auxiliary configuration instead of the core *thing* that actually enables the feature. This will be an even bigger problem once bundles like `TemporalAntiAliasBundle` are deprecated in favor of required components, as users will expect a component named `TemporalAntiAlias` (or similar), not `TemporalAntiAliasSettings`. ## Solution Drop the `Settings` post-fix from the component names, and change some names to be more consistent. - `AutoExposure` - `AutoExposureUniform` - `Bloom` - `BloomUniform` - `BloomPrefilter` - `ChromaticAberration` - `ContrastAdaptiveSharpening` - `DepthOfField` - `DepthOfFieldUniform` - `DistanceFog` - `Smaa`, `Fxaa`, `TemporalAntiAliasing` (note: we might want to change to `Taa`, see "Discussion") - `ScreenSpaceAmbientOcclusion` - `ScreenSpaceReflections` - `VolumetricFog` I kept the old names as deprecated type aliases to make migration a bit less painful for users. We should remove them after the next release. (And let me know if I should just... not add them at all) I also added some very basic docs for a few types where they were missing, like on `Fxaa` and `DepthOfField`. ## Discussion - `TemporalAntiAliasing` is still inconsistent with `Smaa` and `Fxaa`. Consensus [on Discord](https://discord.com/channels/691052431525675048/743663924229963868/1280601167209955431) seemed to be that renaming to `Taa` would probably be fine, but I think it's a bit more controversial, and it would've required renaming a lot of related types like `TemporalAntiAliasNode`, `TemporalAntiAliasBundle`, and `TemporalAntiAliasPlugin`, so I think it's better to leave to a follow-up. - I think `Fog` should probably have a more specific name like `DistanceFog` considering it seems to be distinct from `VolumetricFog`. ~~This should probably be done in a follow-up though, so I just removed the `Settings` post-fix for now.~~ (done) --- ## Migration Guide Many rendering components have been renamed for improved consistency and clarity. - `AutoExposureSettings` → `AutoExposure` - `BloomSettings` → `Bloom` - `BloomPrefilterSettings` → `BloomPrefilter` - `ContrastAdaptiveSharpeningSettings` → `ContrastAdaptiveSharpening` - `DepthOfFieldSettings` → `DepthOfField` - `FogSettings` → `DistanceFog` - `SmaaSettings` → `Smaa` - `TemporalAntiAliasSettings` → `TemporalAntiAliasing` - `ScreenSpaceAmbientOcclusionSettings` → `ScreenSpaceAmbientOcclusion` - `ScreenSpaceReflectionsSettings` → `ScreenSpaceReflections` - `VolumetricFogSettings` → `VolumetricFog` --------- Co-authored-by: Carter Anderson <mcanders1@gmail.com>
191 lines
5.8 KiB
Rust
191 lines
5.8 KiB
Rust
//! A scene showcasing screen space ambient occlusion.
|
|
|
|
use bevy::{
|
|
core_pipeline::experimental::taa::{TemporalAntiAliasBundle, TemporalAntiAliasPlugin},
|
|
pbr::{
|
|
ScreenSpaceAmbientOcclusion, ScreenSpaceAmbientOcclusionBundle,
|
|
ScreenSpaceAmbientOcclusionQualityLevel,
|
|
},
|
|
prelude::*,
|
|
render::camera::TemporalJitter,
|
|
};
|
|
use std::f32::consts::PI;
|
|
|
|
fn main() {
|
|
App::new()
|
|
.insert_resource(AmbientLight {
|
|
brightness: 1000.,
|
|
..default()
|
|
})
|
|
.add_plugins((DefaultPlugins, TemporalAntiAliasPlugin))
|
|
.add_systems(Startup, setup)
|
|
.add_systems(Update, update)
|
|
.run();
|
|
}
|
|
|
|
fn setup(
|
|
mut commands: Commands,
|
|
mut meshes: ResMut<Assets<Mesh>>,
|
|
mut materials: ResMut<Assets<StandardMaterial>>,
|
|
) {
|
|
commands
|
|
.spawn(Camera3dBundle {
|
|
camera: Camera {
|
|
hdr: true,
|
|
..default()
|
|
},
|
|
transform: Transform::from_xyz(-2.0, 2.0, -2.0).looking_at(Vec3::ZERO, Vec3::Y),
|
|
msaa: Msaa::Off,
|
|
..default()
|
|
})
|
|
.insert(ScreenSpaceAmbientOcclusionBundle::default())
|
|
.insert(TemporalAntiAliasBundle::default());
|
|
|
|
let material = materials.add(StandardMaterial {
|
|
base_color: Color::srgb(0.5, 0.5, 0.5),
|
|
perceptual_roughness: 1.0,
|
|
reflectance: 0.0,
|
|
..default()
|
|
});
|
|
commands.spawn(PbrBundle {
|
|
mesh: meshes.add(Cuboid::default()),
|
|
material: material.clone(),
|
|
transform: Transform::from_xyz(0.0, 0.0, 1.0),
|
|
..default()
|
|
});
|
|
commands.spawn(PbrBundle {
|
|
mesh: meshes.add(Cuboid::default()),
|
|
material: material.clone(),
|
|
transform: Transform::from_xyz(0.0, -1.0, 0.0),
|
|
..default()
|
|
});
|
|
commands.spawn(PbrBundle {
|
|
mesh: meshes.add(Cuboid::default()),
|
|
material,
|
|
transform: Transform::from_xyz(1.0, 0.0, 0.0),
|
|
..default()
|
|
});
|
|
commands.spawn((
|
|
PbrBundle {
|
|
mesh: meshes.add(Sphere::new(0.4).mesh().uv(72, 36)),
|
|
material: materials.add(StandardMaterial {
|
|
base_color: Color::srgb(0.4, 0.4, 0.4),
|
|
perceptual_roughness: 1.0,
|
|
reflectance: 0.0,
|
|
..default()
|
|
}),
|
|
..default()
|
|
},
|
|
SphereMarker,
|
|
));
|
|
|
|
commands.spawn(DirectionalLightBundle {
|
|
directional_light: DirectionalLight {
|
|
shadows_enabled: true,
|
|
..default()
|
|
},
|
|
transform: Transform::from_rotation(Quat::from_euler(
|
|
EulerRot::ZYX,
|
|
0.0,
|
|
PI * -0.15,
|
|
PI * -0.15,
|
|
)),
|
|
..default()
|
|
});
|
|
|
|
commands.spawn(
|
|
TextBundle::from_section("", TextStyle::default()).with_style(Style {
|
|
position_type: PositionType::Absolute,
|
|
bottom: Val::Px(12.0),
|
|
left: Val::Px(12.0),
|
|
..default()
|
|
}),
|
|
);
|
|
}
|
|
|
|
fn update(
|
|
camera: Query<
|
|
(
|
|
Entity,
|
|
Option<&ScreenSpaceAmbientOcclusion>,
|
|
Option<&TemporalJitter>,
|
|
),
|
|
With<Camera>,
|
|
>,
|
|
mut text: Query<&mut Text>,
|
|
mut sphere: Query<&mut Transform, With<SphereMarker>>,
|
|
mut commands: Commands,
|
|
keycode: Res<ButtonInput<KeyCode>>,
|
|
time: Res<Time>,
|
|
) {
|
|
let mut sphere = sphere.single_mut();
|
|
sphere.translation.y = (time.elapsed_seconds() / 1.7).sin() * 0.7;
|
|
|
|
let (camera_entity, ssao, temporal_jitter) = camera.single();
|
|
|
|
let mut commands = commands
|
|
.entity(camera_entity)
|
|
.insert_if(
|
|
ScreenSpaceAmbientOcclusion {
|
|
quality_level: ScreenSpaceAmbientOcclusionQualityLevel::Low,
|
|
},
|
|
|| keycode.just_pressed(KeyCode::Digit2),
|
|
)
|
|
.insert_if(
|
|
ScreenSpaceAmbientOcclusion {
|
|
quality_level: ScreenSpaceAmbientOcclusionQualityLevel::Medium,
|
|
},
|
|
|| keycode.just_pressed(KeyCode::Digit3),
|
|
)
|
|
.insert_if(
|
|
ScreenSpaceAmbientOcclusion {
|
|
quality_level: ScreenSpaceAmbientOcclusionQualityLevel::High,
|
|
},
|
|
|| keycode.just_pressed(KeyCode::Digit4),
|
|
)
|
|
.insert_if(
|
|
ScreenSpaceAmbientOcclusion {
|
|
quality_level: ScreenSpaceAmbientOcclusionQualityLevel::Ultra,
|
|
},
|
|
|| keycode.just_pressed(KeyCode::Digit5),
|
|
);
|
|
if keycode.just_pressed(KeyCode::Digit1) {
|
|
commands = commands.remove::<ScreenSpaceAmbientOcclusion>();
|
|
}
|
|
if keycode.just_pressed(KeyCode::Space) {
|
|
if temporal_jitter.is_some() {
|
|
commands.remove::<TemporalJitter>();
|
|
} else {
|
|
commands.insert(TemporalJitter::default());
|
|
}
|
|
}
|
|
|
|
let mut text = text.single_mut();
|
|
let text = &mut text.sections[0].value;
|
|
text.clear();
|
|
|
|
let (o, l, m, h, u) = match ssao.map(|s| s.quality_level) {
|
|
None => ("*", "", "", "", ""),
|
|
Some(ScreenSpaceAmbientOcclusionQualityLevel::Low) => ("", "*", "", "", ""),
|
|
Some(ScreenSpaceAmbientOcclusionQualityLevel::Medium) => ("", "", "*", "", ""),
|
|
Some(ScreenSpaceAmbientOcclusionQualityLevel::High) => ("", "", "", "*", ""),
|
|
Some(ScreenSpaceAmbientOcclusionQualityLevel::Ultra) => ("", "", "", "", "*"),
|
|
_ => unreachable!(),
|
|
};
|
|
|
|
text.push_str("SSAO Quality:\n");
|
|
text.push_str(&format!("(1) {o}Off{o}\n"));
|
|
text.push_str(&format!("(2) {l}Low{l}\n"));
|
|
text.push_str(&format!("(3) {m}Medium{m}\n"));
|
|
text.push_str(&format!("(4) {h}High{h}\n"));
|
|
text.push_str(&format!("(5) {u}Ultra{u}\n\n"));
|
|
|
|
text.push_str("Temporal Antialiasing:\n");
|
|
text.push_str(match temporal_jitter {
|
|
Some(_) => "(Space) Enabled",
|
|
None => "(Space) Disabled",
|
|
});
|
|
}
|
|
|
|
#[derive(Component)]
|
|
struct SphereMarker;
|