mirror of
https://github.com/bevyengine/bevy
synced 2024-11-26 06:30:19 +00:00
54006b107b
# Objective A big step in the migration to required components: meshes and materials! ## Solution As per the [selected proposal](https://hackmd.io/@bevy/required_components/%2Fj9-PnF-2QKK0on1KQ29UWQ): - Deprecate `MaterialMesh2dBundle`, `MaterialMeshBundle`, and `PbrBundle`. - Add `Mesh2d` and `Mesh3d` components, which wrap a `Handle<Mesh>`. - Add `MeshMaterial2d<M: Material2d>` and `MeshMaterial3d<M: Material>`, which wrap a `Handle<M>`. - Meshes *without* a mesh material should be rendered with a default material. The existence of a material is determined by `HasMaterial2d`/`HasMaterial3d`, which is required by `MeshMaterial2d`/`MeshMaterial3d`. This gets around problems with the generics. Previously: ```rust commands.spawn(MaterialMesh2dBundle { mesh: meshes.add(Circle::new(100.0)).into(), material: materials.add(Color::srgb(7.5, 0.0, 7.5)), transform: Transform::from_translation(Vec3::new(-200., 0., 0.)), ..default() }); ``` Now: ```rust commands.spawn(( Mesh2d(meshes.add(Circle::new(100.0))), MeshMaterial2d(materials.add(Color::srgb(7.5, 0.0, 7.5))), Transform::from_translation(Vec3::new(-200., 0., 0.)), )); ``` If the mesh material is missing, previously nothing was rendered. Now, it renders a white default `ColorMaterial` in 2D and a `StandardMaterial` in 3D (this can be overridden). Below, only every other entity has a material: ![Näyttökuva 2024-09-29 181746](https://github.com/user-attachments/assets/5c8be029-d2fe-4b8c-ae89-17a72ff82c9a) ![Näyttökuva 2024-09-29 181918](https://github.com/user-attachments/assets/58adbc55-5a1e-4c7d-a2c7-ed456227b909) Why white? This is still open for discussion, but I think white makes sense for a *default* material, while *invalid* asset handles pointing to nothing should have something like a pink material to indicate that something is broken (I don't handle that in this PR yet). This is kind of a mix of Godot and Unity: Godot just renders a white material for non-existent materials, while Unity renders nothing when no materials exist, but renders pink for invalid materials. I can also change the default material to pink if that is preferable though. ## Testing I ran some 2D and 3D examples to test if anything changed visually. I have not tested all examples or features yet however. If anyone wants to test more extensively, it would be appreciated! ## Implementation Notes - The relationship between `bevy_render` and `bevy_pbr` is weird here. `bevy_render` needs `Mesh3d` for its own systems, but `bevy_pbr` has all of the material logic, and `bevy_render` doesn't depend on it. I feel like the two crates should be refactored in some way, but I think that's out of scope for this PR. - I didn't migrate meshlets to required components yet. That can probably be done in a follow-up, as this is already a huge PR. - It is becoming increasingly clear to me that we really, *really* want to disallow raw asset handles as components. They caused me a *ton* of headache here already, and it took me a long time to find every place that queried for them or inserted them directly on entities, since there were no compiler errors for it. If we don't remove the `Component` derive, I expect raw asset handles to be a *huge* footgun for users as we transition to wrapper components, especially as handles as components have been the norm so far. I personally consider this to be a blocker for 0.15: we need to migrate to wrapper components for asset handles everywhere, and remove the `Component` derive. Also see https://github.com/bevyengine/bevy/issues/14124. --- ## Migration Guide Asset handles for meshes and mesh materials must now be wrapped in the `Mesh2d` and `MeshMaterial2d` or `Mesh3d` and `MeshMaterial3d` components for 2D and 3D respectively. Raw handles as components no longer render meshes. Additionally, `MaterialMesh2dBundle`, `MaterialMeshBundle`, and `PbrBundle` have been deprecated. Instead, use the mesh and material components directly. Previously: ```rust commands.spawn(MaterialMesh2dBundle { mesh: meshes.add(Circle::new(100.0)).into(), material: materials.add(Color::srgb(7.5, 0.0, 7.5)), transform: Transform::from_translation(Vec3::new(-200., 0., 0.)), ..default() }); ``` Now: ```rust commands.spawn(( Mesh2d(meshes.add(Circle::new(100.0))), MeshMaterial2d(materials.add(Color::srgb(7.5, 0.0, 7.5))), Transform::from_translation(Vec3::new(-200., 0., 0.)), )); ``` If the mesh material is missing, a white default material is now used. Previously, nothing was rendered if the material was missing. The `WithMesh2d` and `WithMesh3d` query filter type aliases have also been removed. Simply use `With<Mesh2d>` or `With<Mesh3d>`. --------- Co-authored-by: Tim Blackbird <justthecooldude@gmail.com> Co-authored-by: Carter Anderson <mcanders1@gmail.com>
188 lines
6.3 KiB
Rust
188 lines
6.3 KiB
Rust
//! Illustrates bloom post-processing in 2d.
|
|
|
|
use bevy::{
|
|
core_pipeline::{
|
|
bloom::{Bloom, BloomCompositeMode},
|
|
tonemapping::Tonemapping,
|
|
},
|
|
prelude::*,
|
|
};
|
|
|
|
fn main() {
|
|
App::new()
|
|
.add_plugins(DefaultPlugins)
|
|
.add_systems(Startup, setup)
|
|
.add_systems(Update, update_bloom_settings)
|
|
.run();
|
|
}
|
|
|
|
fn setup(
|
|
mut commands: Commands,
|
|
mut meshes: ResMut<Assets<Mesh>>,
|
|
mut materials: ResMut<Assets<ColorMaterial>>,
|
|
asset_server: Res<AssetServer>,
|
|
) {
|
|
commands.spawn((
|
|
Camera2dBundle {
|
|
camera: Camera {
|
|
hdr: true, // 1. HDR is required for bloom
|
|
..default()
|
|
},
|
|
tonemapping: Tonemapping::TonyMcMapface, // 2. Using a tonemapper that desaturates to white is recommended
|
|
..default()
|
|
},
|
|
Bloom::default(), // 3. Enable bloom for the camera
|
|
));
|
|
|
|
// Sprite
|
|
commands.spawn(SpriteBundle {
|
|
texture: asset_server.load("branding/bevy_bird_dark.png"),
|
|
sprite: Sprite {
|
|
color: Color::srgb(5.0, 5.0, 5.0), // 4. Put something bright in a dark environment to see the effect
|
|
custom_size: Some(Vec2::splat(160.0)),
|
|
..default()
|
|
},
|
|
..default()
|
|
});
|
|
|
|
// Circle mesh
|
|
commands.spawn((
|
|
Mesh2d(meshes.add(Circle::new(100.))),
|
|
// 4. Put something bright in a dark environment to see the effect
|
|
MeshMaterial2d(materials.add(Color::srgb(7.5, 0.0, 7.5))),
|
|
Transform::from_translation(Vec3::new(-200., 0., 0.)),
|
|
));
|
|
|
|
// Hexagon mesh
|
|
commands.spawn((
|
|
Mesh2d(meshes.add(RegularPolygon::new(100., 6))),
|
|
// 4. Put something bright in a dark environment to see the effect
|
|
MeshMaterial2d(materials.add(Color::srgb(6.25, 9.4, 9.1))),
|
|
Transform::from_translation(Vec3::new(200., 0., 0.)),
|
|
));
|
|
|
|
// UI
|
|
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_bloom_settings(
|
|
mut camera: Query<(Entity, Option<&mut Bloom>), With<Camera>>,
|
|
mut text: Query<&mut Text>,
|
|
mut commands: Commands,
|
|
keycode: Res<ButtonInput<KeyCode>>,
|
|
time: Res<Time>,
|
|
) {
|
|
let bloom = camera.single_mut();
|
|
let mut text = text.single_mut();
|
|
let text = &mut text.sections[0].value;
|
|
|
|
match bloom {
|
|
(entity, Some(mut bloom)) => {
|
|
*text = "Bloom (Toggle: Space)\n".to_string();
|
|
text.push_str(&format!("(Q/A) Intensity: {}\n", bloom.intensity));
|
|
text.push_str(&format!(
|
|
"(W/S) Low-frequency boost: {}\n",
|
|
bloom.low_frequency_boost
|
|
));
|
|
text.push_str(&format!(
|
|
"(E/D) Low-frequency boost curvature: {}\n",
|
|
bloom.low_frequency_boost_curvature
|
|
));
|
|
text.push_str(&format!(
|
|
"(R/F) High-pass frequency: {}\n",
|
|
bloom.high_pass_frequency
|
|
));
|
|
text.push_str(&format!(
|
|
"(T/G) Mode: {}\n",
|
|
match bloom.composite_mode {
|
|
BloomCompositeMode::EnergyConserving => "Energy-conserving",
|
|
BloomCompositeMode::Additive => "Additive",
|
|
}
|
|
));
|
|
text.push_str(&format!("(Y/H) Threshold: {}\n", bloom.prefilter.threshold));
|
|
text.push_str(&format!(
|
|
"(U/J) Threshold softness: {}\n",
|
|
bloom.prefilter.threshold_softness
|
|
));
|
|
|
|
if keycode.just_pressed(KeyCode::Space) {
|
|
commands.entity(entity).remove::<Bloom>();
|
|
}
|
|
|
|
let dt = time.delta_seconds();
|
|
|
|
if keycode.pressed(KeyCode::KeyA) {
|
|
bloom.intensity -= dt / 10.0;
|
|
}
|
|
if keycode.pressed(KeyCode::KeyQ) {
|
|
bloom.intensity += dt / 10.0;
|
|
}
|
|
bloom.intensity = bloom.intensity.clamp(0.0, 1.0);
|
|
|
|
if keycode.pressed(KeyCode::KeyS) {
|
|
bloom.low_frequency_boost -= dt / 10.0;
|
|
}
|
|
if keycode.pressed(KeyCode::KeyW) {
|
|
bloom.low_frequency_boost += dt / 10.0;
|
|
}
|
|
bloom.low_frequency_boost = bloom.low_frequency_boost.clamp(0.0, 1.0);
|
|
|
|
if keycode.pressed(KeyCode::KeyD) {
|
|
bloom.low_frequency_boost_curvature -= dt / 10.0;
|
|
}
|
|
if keycode.pressed(KeyCode::KeyE) {
|
|
bloom.low_frequency_boost_curvature += dt / 10.0;
|
|
}
|
|
bloom.low_frequency_boost_curvature =
|
|
bloom.low_frequency_boost_curvature.clamp(0.0, 1.0);
|
|
|
|
if keycode.pressed(KeyCode::KeyF) {
|
|
bloom.high_pass_frequency -= dt / 10.0;
|
|
}
|
|
if keycode.pressed(KeyCode::KeyR) {
|
|
bloom.high_pass_frequency += dt / 10.0;
|
|
}
|
|
bloom.high_pass_frequency = bloom.high_pass_frequency.clamp(0.0, 1.0);
|
|
|
|
if keycode.pressed(KeyCode::KeyG) {
|
|
bloom.composite_mode = BloomCompositeMode::Additive;
|
|
}
|
|
if keycode.pressed(KeyCode::KeyT) {
|
|
bloom.composite_mode = BloomCompositeMode::EnergyConserving;
|
|
}
|
|
|
|
if keycode.pressed(KeyCode::KeyH) {
|
|
bloom.prefilter.threshold -= dt;
|
|
}
|
|
if keycode.pressed(KeyCode::KeyY) {
|
|
bloom.prefilter.threshold += dt;
|
|
}
|
|
bloom.prefilter.threshold = bloom.prefilter.threshold.max(0.0);
|
|
|
|
if keycode.pressed(KeyCode::KeyJ) {
|
|
bloom.prefilter.threshold_softness -= dt / 10.0;
|
|
}
|
|
if keycode.pressed(KeyCode::KeyU) {
|
|
bloom.prefilter.threshold_softness += dt / 10.0;
|
|
}
|
|
bloom.prefilter.threshold_softness = bloom.prefilter.threshold_softness.clamp(0.0, 1.0);
|
|
}
|
|
|
|
(entity, None) => {
|
|
*text = "Bloom: Off (Toggle: Space)".to_string();
|
|
|
|
if keycode.just_pressed(KeyCode::Space) {
|
|
commands.entity(entity).insert(Bloom::default());
|
|
}
|
|
}
|
|
}
|
|
}
|