mirror of
https://github.com/bevyengine/bevy
synced 2024-11-25 22:20:20 +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>
89 lines
2.9 KiB
Rust
89 lines
2.9 KiB
Rust
//! Demonstrates fog volumes with voxel density textures.
|
|
//!
|
|
//! We render the Stanford bunny as a fog volume. Parts of the bunny become
|
|
//! lighter and darker as the camera rotates. This is physically-accurate
|
|
//! behavior that results from the scattering and absorption of the directional
|
|
//! light.
|
|
|
|
use bevy::{
|
|
math::vec3,
|
|
pbr::{FogVolume, VolumetricFog, VolumetricLight},
|
|
prelude::*,
|
|
};
|
|
|
|
/// Entry point.
|
|
fn main() {
|
|
App::new()
|
|
.add_plugins(DefaultPlugins.set(WindowPlugin {
|
|
primary_window: Some(Window {
|
|
title: "Bevy Fog Volumes Example".into(),
|
|
..default()
|
|
}),
|
|
..default()
|
|
}))
|
|
.insert_resource(AmbientLight::NONE)
|
|
.add_systems(Startup, setup)
|
|
.add_systems(Update, rotate_camera)
|
|
.run();
|
|
}
|
|
|
|
/// Spawns all the objects in the scene.
|
|
fn setup(mut commands: Commands, asset_server: Res<AssetServer>) {
|
|
// Spawn a fog volume with a voxelized version of the Stanford bunny.
|
|
commands
|
|
.spawn(SpatialBundle {
|
|
visibility: Visibility::Visible,
|
|
transform: Transform::from_xyz(0.0, 0.5, 0.0),
|
|
..default()
|
|
})
|
|
.insert(FogVolume {
|
|
density_texture: Some(asset_server.load("volumes/bunny.ktx2")),
|
|
density_factor: 1.0,
|
|
// Scatter as much of the light as possible, to brighten the bunny
|
|
// up.
|
|
scattering: 1.0,
|
|
..default()
|
|
});
|
|
|
|
// Spawn a bright directional light that illuminates the fog well.
|
|
commands
|
|
.spawn(DirectionalLightBundle {
|
|
transform: Transform::from_xyz(1.0, 1.0, -0.3).looking_at(vec3(0.0, 0.5, 0.0), Vec3::Y),
|
|
directional_light: DirectionalLight {
|
|
shadows_enabled: true,
|
|
illuminance: 32000.0,
|
|
..default()
|
|
},
|
|
..default()
|
|
})
|
|
// Make sure to add this for the light to interact with the fog.
|
|
.insert(VolumetricLight);
|
|
|
|
// Spawn a camera.
|
|
commands
|
|
.spawn(Camera3dBundle {
|
|
transform: Transform::from_xyz(-0.75, 1.0, 2.0)
|
|
.looking_at(vec3(0.0, 0.0, 0.0), Vec3::Y),
|
|
camera: Camera {
|
|
hdr: true,
|
|
..default()
|
|
},
|
|
..default()
|
|
})
|
|
.insert(VolumetricFog {
|
|
// Make this relatively high in order to increase the fog quality.
|
|
step_count: 64,
|
|
// Disable ambient light.
|
|
ambient_intensity: 0.0,
|
|
..default()
|
|
});
|
|
}
|
|
|
|
/// Rotates the camera a bit every frame.
|
|
fn rotate_camera(mut cameras: Query<&mut Transform, With<Camera3d>>) {
|
|
for mut camera_transform in cameras.iter_mut() {
|
|
*camera_transform =
|
|
Transform::from_translation(Quat::from_rotation_y(0.01) * camera_transform.translation)
|
|
.looking_at(vec3(0.0, 0.5, 0.0), Vec3::Y);
|
|
}
|
|
}
|