mirror of
https://github.com/bevyengine/bevy
synced 2024-11-25 14:10: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>
150 lines
4.3 KiB
Rust
150 lines
4.3 KiB
Rust
//! This example showcases a 2D top-down camera with smooth player tracking.
|
|
//!
|
|
//! ## Controls
|
|
//!
|
|
//! | Key Binding | Action |
|
|
//! |:---------------------|:--------------|
|
|
//! | `W` | Move up |
|
|
//! | `S` | Move down |
|
|
//! | `A` | Move left |
|
|
//! | `D` | Move right |
|
|
|
|
use bevy::core_pipeline::bloom::Bloom;
|
|
use bevy::math::vec3;
|
|
use bevy::prelude::*;
|
|
use bevy::sprite::{MaterialMesh2dBundle, Mesh2dHandle};
|
|
|
|
/// Player movement speed factor.
|
|
const PLAYER_SPEED: f32 = 100.;
|
|
|
|
/// How quickly should the camera snap to the desired location.
|
|
const CAMERA_DECAY_RATE: f32 = 2.;
|
|
|
|
#[derive(Component)]
|
|
struct Player;
|
|
|
|
fn main() {
|
|
App::new()
|
|
.add_plugins(DefaultPlugins)
|
|
.add_systems(Startup, (setup_scene, setup_instructions, setup_camera))
|
|
.add_systems(Update, (move_player, update_camera).chain())
|
|
.run();
|
|
}
|
|
|
|
fn setup_scene(
|
|
mut commands: Commands,
|
|
mut meshes: ResMut<Assets<Mesh>>,
|
|
mut materials: ResMut<Assets<ColorMaterial>>,
|
|
) {
|
|
// World where we move the player
|
|
commands.spawn(MaterialMesh2dBundle {
|
|
mesh: Mesh2dHandle(meshes.add(Rectangle::new(1000., 700.))),
|
|
material: materials.add(Color::srgb(0.2, 0.2, 0.3)),
|
|
..default()
|
|
});
|
|
|
|
// Player
|
|
commands.spawn((
|
|
Player,
|
|
MaterialMesh2dBundle {
|
|
mesh: meshes.add(Circle::new(25.)).into(),
|
|
material: materials.add(Color::srgb(6.25, 9.4, 9.1)), // RGB values exceed 1 to achieve a bright color for the bloom effect
|
|
transform: Transform {
|
|
translation: vec3(0., 0., 2.),
|
|
..default()
|
|
},
|
|
..default()
|
|
},
|
|
));
|
|
}
|
|
|
|
fn setup_instructions(mut commands: Commands) {
|
|
commands.spawn(
|
|
TextBundle::from_section(
|
|
"Move the light with WASD.\nThe camera will smoothly track the light.",
|
|
TextStyle::default(),
|
|
)
|
|
.with_style(Style {
|
|
position_type: PositionType::Absolute,
|
|
bottom: Val::Px(12.0),
|
|
left: Val::Px(12.0),
|
|
..default()
|
|
}),
|
|
);
|
|
}
|
|
|
|
fn setup_camera(mut commands: Commands) {
|
|
commands.spawn((
|
|
Camera2dBundle {
|
|
camera: Camera {
|
|
hdr: true, // HDR is required for the bloom effect
|
|
..default()
|
|
},
|
|
..default()
|
|
},
|
|
Bloom::NATURAL,
|
|
));
|
|
}
|
|
|
|
/// Update the camera position by tracking the player.
|
|
fn update_camera(
|
|
mut camera: Query<&mut Transform, (With<Camera2d>, Without<Player>)>,
|
|
player: Query<&Transform, (With<Player>, Without<Camera2d>)>,
|
|
time: Res<Time>,
|
|
) {
|
|
let Ok(mut camera) = camera.get_single_mut() else {
|
|
return;
|
|
};
|
|
|
|
let Ok(player) = player.get_single() else {
|
|
return;
|
|
};
|
|
|
|
let Vec3 { x, y, .. } = player.translation;
|
|
let direction = Vec3::new(x, y, camera.translation.z);
|
|
|
|
// Applies a smooth effect to camera movement using stable interpolation
|
|
// between the camera position and the player position on the x and y axes.
|
|
camera
|
|
.translation
|
|
.smooth_nudge(&direction, CAMERA_DECAY_RATE, time.delta_seconds());
|
|
}
|
|
|
|
/// Update the player position with keyboard inputs.
|
|
/// Note that the approach used here is for demonstration purposes only,
|
|
/// as the point of this example is to showcase the camera tracking feature.
|
|
///
|
|
/// A more robust solution for player movement can be found in `examples/movement/physics_in_fixed_timestep.rs`.
|
|
fn move_player(
|
|
mut player: Query<&mut Transform, With<Player>>,
|
|
time: Res<Time>,
|
|
kb_input: Res<ButtonInput<KeyCode>>,
|
|
) {
|
|
let Ok(mut player) = player.get_single_mut() else {
|
|
return;
|
|
};
|
|
|
|
let mut direction = Vec2::ZERO;
|
|
|
|
if kb_input.pressed(KeyCode::KeyW) {
|
|
direction.y += 1.;
|
|
}
|
|
|
|
if kb_input.pressed(KeyCode::KeyS) {
|
|
direction.y -= 1.;
|
|
}
|
|
|
|
if kb_input.pressed(KeyCode::KeyA) {
|
|
direction.x -= 1.;
|
|
}
|
|
|
|
if kb_input.pressed(KeyCode::KeyD) {
|
|
direction.x += 1.;
|
|
}
|
|
|
|
// Progressively update the player's position over time. Normalize the
|
|
// direction vector to prevent it from exceeding a magnitude of 1 when
|
|
// moving diagonally.
|
|
let move_delta = direction.normalize_or_zero() * PLAYER_SPEED * time.delta_seconds();
|
|
player.translation += move_delta.extend(0.);
|
|
}
|