 54006b107b
			
		
	
	
		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:   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>
		
			
				
	
	
		
			121 lines
		
	
	
		
			3.8 KiB
		
	
	
	
		
			Rust
		
	
	
	
	
	
			
		
		
	
	
			121 lines
		
	
	
		
			3.8 KiB
		
	
	
	
		
			Rust
		
	
	
	
	
	
| //! Demonstrates how to rotate the skybox and the environment map simultaneously.
 | |
| 
 | |
| use std::f32::consts::PI;
 | |
| 
 | |
| use bevy::{
 | |
|     color::palettes::css::{GOLD, WHITE},
 | |
|     core_pipeline::{tonemapping::Tonemapping::AcesFitted, Skybox},
 | |
|     prelude::*,
 | |
|     render::texture::ImageLoaderSettings,
 | |
| };
 | |
| 
 | |
| /// Entry point.
 | |
| pub fn main() {
 | |
|     App::new()
 | |
|         .add_plugins(DefaultPlugins)
 | |
|         .add_systems(Startup, setup)
 | |
|         .add_systems(Update, rotate_skybox_and_environment_map)
 | |
|         .run();
 | |
| }
 | |
| 
 | |
| /// Initializes the scene.
 | |
| fn setup(
 | |
|     mut commands: Commands,
 | |
|     mut meshes: ResMut<Assets<Mesh>>,
 | |
|     mut materials: ResMut<Assets<StandardMaterial>>,
 | |
|     asset_server: Res<AssetServer>,
 | |
| ) {
 | |
|     let sphere_mesh = create_sphere_mesh(&mut meshes);
 | |
|     spawn_sphere(&mut commands, &mut materials, &asset_server, &sphere_mesh);
 | |
|     spawn_light(&mut commands);
 | |
|     spawn_camera(&mut commands, &asset_server);
 | |
| }
 | |
| 
 | |
| /// Rotate the skybox and the environment map per frame.
 | |
| fn rotate_skybox_and_environment_map(
 | |
|     mut environments: Query<(&mut Skybox, &mut EnvironmentMapLight)>,
 | |
|     time: Res<Time>,
 | |
| ) {
 | |
|     let now = time.elapsed_seconds();
 | |
|     let rotation = Quat::from_rotation_y(0.2 * now);
 | |
|     for (mut skybox, mut environment_map) in environments.iter_mut() {
 | |
|         skybox.rotation = rotation;
 | |
|         environment_map.rotation = rotation;
 | |
|     }
 | |
| }
 | |
| 
 | |
| /// Generates a sphere.
 | |
| fn create_sphere_mesh(meshes: &mut Assets<Mesh>) -> Handle<Mesh> {
 | |
|     // We're going to use normal maps, so make sure we've generated tangents, or
 | |
|     // else the normal maps won't show up.
 | |
| 
 | |
|     let mut sphere_mesh = Sphere::new(1.0).mesh().build();
 | |
|     sphere_mesh
 | |
|         .generate_tangents()
 | |
|         .expect("Failed to generate tangents");
 | |
|     meshes.add(sphere_mesh)
 | |
| }
 | |
| 
 | |
| /// Spawn a regular object with a clearcoat layer. This looks like car paint.
 | |
| fn spawn_sphere(
 | |
|     commands: &mut Commands,
 | |
|     materials: &mut Assets<StandardMaterial>,
 | |
|     asset_server: &AssetServer,
 | |
|     sphere_mesh: &Handle<Mesh>,
 | |
| ) {
 | |
|     commands.spawn((
 | |
|         Mesh3d(sphere_mesh.clone()),
 | |
|         MeshMaterial3d(materials.add(StandardMaterial {
 | |
|             clearcoat: 1.0,
 | |
|             clearcoat_perceptual_roughness: 0.3,
 | |
|             clearcoat_normal_texture: Some(asset_server.load_with_settings(
 | |
|                 "textures/ScratchedGold-Normal.png",
 | |
|                 |settings: &mut ImageLoaderSettings| settings.is_srgb = false,
 | |
|             )),
 | |
|             metallic: 0.9,
 | |
|             perceptual_roughness: 0.1,
 | |
|             base_color: GOLD.into(),
 | |
|             ..default()
 | |
|         })),
 | |
|         Transform::from_xyz(0.0, 0.0, 0.0).with_scale(Vec3::splat(1.25)),
 | |
|     ));
 | |
| }
 | |
| 
 | |
| /// Spawns a light.
 | |
| fn spawn_light(commands: &mut Commands) {
 | |
|     commands.spawn(PointLight {
 | |
|         color: WHITE.into(),
 | |
|         intensity: 100000.0,
 | |
|         ..default()
 | |
|     });
 | |
| }
 | |
| 
 | |
| /// Spawns a camera with associated skybox and environment map.
 | |
| fn spawn_camera(commands: &mut Commands, asset_server: &AssetServer) {
 | |
|     commands
 | |
|         .spawn(Camera3dBundle {
 | |
|             camera: Camera {
 | |
|                 hdr: true,
 | |
|                 ..default()
 | |
|             },
 | |
|             projection: Projection::Perspective(PerspectiveProjection {
 | |
|                 fov: 27.0 / 180.0 * PI,
 | |
|                 ..default()
 | |
|             }),
 | |
|             transform: Transform::from_xyz(0.0, 0.0, 10.0),
 | |
|             tonemapping: AcesFitted,
 | |
|             ..default()
 | |
|         })
 | |
|         .insert(Skybox {
 | |
|             brightness: 5000.0,
 | |
|             image: asset_server.load("environment_maps/pisa_specular_rgb9e5_zstd.ktx2"),
 | |
|             ..default()
 | |
|         })
 | |
|         .insert(EnvironmentMapLight {
 | |
|             diffuse_map: asset_server.load("environment_maps/pisa_diffuse_rgb9e5_zstd.ktx2"),
 | |
|             specular_map: asset_server.load("environment_maps/pisa_specular_rgb9e5_zstd.ktx2"),
 | |
|             intensity: 2000.0,
 | |
|             ..default()
 | |
|         });
 | |
| }
 |