 599e5e4e76
			
		
	
	
		599e5e4e76
		
			
		
	
	
	
	
		
			
			# Objective - As part of the migration process we need to a) see the end effect of the migration on user ergonomics b) check for serious perf regressions c) actually migrate the code - To accomplish this, I'm going to attempt to migrate all of the remaining user-facing usages of `LegacyColor` in one PR, being careful to keep a clean commit history. - Fixes #12056. ## Solution I've chosen to use the polymorphic `Color` type as our standard user-facing API. - [x] Migrate `bevy_gizmos`. - [x] Take `impl Into<Color>` in all `bevy_gizmos` APIs - [x] Migrate sprites - [x] Migrate UI - [x] Migrate `ColorMaterial` - [x] Migrate `MaterialMesh2D` - [x] Migrate fog - [x] Migrate lights - [x] Migrate StandardMaterial - [x] Migrate wireframes - [x] Migrate clear color - [x] Migrate text - [x] Migrate gltf loader - [x] Register color types for reflection - [x] Remove `LegacyColor` - [x] Make sure CI passes Incidental improvements to ease migration: - added `Color::srgba_u8`, `Color::srgba_from_array` and friends - added `set_alpha`, `is_fully_transparent` and `is_fully_opaque` to the `Alpha` trait - add and immediately deprecate (lol) `Color::rgb` and friends in favor of more explicit and consistent `Color::srgb` - standardized on white and black for most example text colors - added vector field traits to `LinearRgba`: ~~`Add`, `Sub`, `AddAssign`, `SubAssign`,~~ `Mul<f32>` and `Div<f32>`. Multiplications and divisions do not scale alpha. `Add` and `Sub` have been cut from this PR. - added `LinearRgba` and `Srgba` `RED/GREEN/BLUE` - added `LinearRgba_to_f32_array` and `LinearRgba::to_u32` ## Migration Guide Bevy's color types have changed! Wherever you used a `bevy::render::Color`, a `bevy::color::Color` is used instead. These are quite similar! Both are enums storing a color in a specific color space (or to be more precise, using a specific color model). However, each of the different color models now has its own type. TODO... - `Color::rgba`, `Color::rgb`, `Color::rbga_u8`, `Color::rgb_u8`, `Color::rgb_from_array` are now `Color::srgba`, `Color::srgb`, `Color::srgba_u8`, `Color::srgb_u8` and `Color::srgb_from_array`. - `Color::set_a` and `Color::a` is now `Color::set_alpha` and `Color::alpha`. These are part of the `Alpha` trait in `bevy_color`. - `Color::is_fully_transparent` is now part of the `Alpha` trait in `bevy_color` - `Color::r`, `Color::set_r`, `Color::with_r` and the equivalents for `g`, `b` `h`, `s` and `l` have been removed due to causing silent relatively expensive conversions. Convert your `Color` into the desired color space, perform your operations there, and then convert it back into a polymorphic `Color` enum. - `Color::hex` is now `Srgba::hex`. Call `.into` or construct a `Color::Srgba` variant manually to convert it. - `WireframeMaterial`, `ExtractedUiNode`, `ExtractedDirectionalLight`, `ExtractedPointLight`, `ExtractedSpotLight` and `ExtractedSprite` now store a `LinearRgba`, rather than a polymorphic `Color` - `Color::rgb_linear` and `Color::rgba_linear` are now `Color::linear_rgb` and `Color::linear_rgba` - The various CSS color constants are no longer stored directly on `Color`. Instead, they're defined in the `Srgba` color space, and accessed via `bevy::color::palettes::css`. Call `.into()` on them to convert them into a `Color` for quick debugging use, and consider using the much prettier `tailwind` palette for prototyping. - The `LIME_GREEN` color has been renamed to `LIMEGREEN` to comply with the standard naming. - Vector field arithmetic operations on `Color` (add, subtract, multiply and divide by a f32) have been removed. Instead, convert your colors into `LinearRgba` space, and perform your operations explicitly there. This is particularly relevant when working with emissive or HDR colors, whose color channel values are routinely outside of the ordinary 0 to 1 range. - `Color::as_linear_rgba_f32` has been removed. Call `LinearRgba::to_f32_array` instead, converting if needed. - `Color::as_linear_rgba_u32` has been removed. Call `LinearRgba::to_u32` instead, converting if needed. - Several other color conversion methods to transform LCH or HSL colors into float arrays or `Vec` types have been removed. Please reimplement these externally or open a PR to re-add them if you found them particularly useful. - Various methods on `Color` such as `rgb` or `hsl` to convert the color into a specific color space have been removed. Convert into `LinearRgba`, then to the color space of your choice. - Various implicitly-converting color value methods on `Color` such as `r`, `g`, `b` or `h` have been removed. Please convert it into the color space of your choice, then check these properties. - `Color` no longer implements `AsBindGroup`. Store a `LinearRgba` internally instead to avoid conversion costs. --------- Co-authored-by: Alice Cecile <alice.i.cecil@gmail.com> Co-authored-by: Afonso Lage <lage.afonso@gmail.com> Co-authored-by: Rob Parrett <robparrett@gmail.com> Co-authored-by: Zachary Harrold <zac@harrold.com.au>
		
			
				
	
	
		
			177 lines
		
	
	
		
			5.3 KiB
		
	
	
	
		
			Rust
		
	
	
	
	
	
			
		
		
	
	
			177 lines
		
	
	
		
			5.3 KiB
		
	
	
	
		
			Rust
		
	
	
	
	
	
| //! Demonstrates how to prevent meshes from casting/receiving shadows in a 3d scene.
 | |
| 
 | |
| use std::f32::consts::PI;
 | |
| 
 | |
| use bevy::{
 | |
|     color::palettes::basic::{BLUE, GREEN, RED},
 | |
|     pbr::{light_consts, CascadeShadowConfigBuilder, NotShadowCaster, NotShadowReceiver},
 | |
|     prelude::*,
 | |
| };
 | |
| 
 | |
| fn main() {
 | |
|     println!(
 | |
|         "Controls:
 | |
|     C      - toggle shadow casters (i.e. casters become not, and not casters become casters)
 | |
|     R      - toggle shadow receivers (i.e. receivers become not, and not receivers become receivers)
 | |
|     L      - switch between directional and point lights"
 | |
|     );
 | |
|     App::new()
 | |
|         .add_plugins(DefaultPlugins)
 | |
|         .add_systems(Startup, setup)
 | |
|         .add_systems(Update, (toggle_light, toggle_shadows))
 | |
|         .run();
 | |
| }
 | |
| 
 | |
| /// set up a 3D scene to test shadow biases and perspective projections
 | |
| fn setup(
 | |
|     mut commands: Commands,
 | |
|     mut meshes: ResMut<Assets<Mesh>>,
 | |
|     mut materials: ResMut<Assets<StandardMaterial>>,
 | |
| ) {
 | |
|     let spawn_plane_depth = 500.0f32;
 | |
|     let spawn_height = 2.0;
 | |
|     let sphere_radius = 0.25;
 | |
| 
 | |
|     let white_handle = materials.add(StandardMaterial {
 | |
|         base_color: Color::WHITE,
 | |
|         perceptual_roughness: 1.0,
 | |
|         ..default()
 | |
|     });
 | |
|     let sphere_handle = meshes.add(Sphere::new(sphere_radius));
 | |
| 
 | |
|     // sphere - initially a caster
 | |
|     commands.spawn(PbrBundle {
 | |
|         mesh: sphere_handle.clone(),
 | |
|         material: materials.add(Color::from(RED)),
 | |
|         transform: Transform::from_xyz(-1.0, spawn_height, 0.0),
 | |
|         ..default()
 | |
|     });
 | |
| 
 | |
|     // sphere - initially not a caster
 | |
|     commands.spawn((
 | |
|         PbrBundle {
 | |
|             mesh: sphere_handle,
 | |
|             material: materials.add(Color::from(BLUE)),
 | |
|             transform: Transform::from_xyz(1.0, spawn_height, 0.0),
 | |
|             ..default()
 | |
|         },
 | |
|         NotShadowCaster,
 | |
|     ));
 | |
| 
 | |
|     // floating plane - initially not a shadow receiver and not a caster
 | |
|     commands.spawn((
 | |
|         PbrBundle {
 | |
|             mesh: meshes.add(Plane3d::default().mesh().size(20.0, 20.0)),
 | |
|             material: materials.add(Color::from(GREEN)),
 | |
|             transform: Transform::from_xyz(0.0, 1.0, -10.0),
 | |
|             ..default()
 | |
|         },
 | |
|         NotShadowCaster,
 | |
|         NotShadowReceiver,
 | |
|     ));
 | |
| 
 | |
|     // lower ground plane - initially a shadow receiver
 | |
|     commands.spawn(PbrBundle {
 | |
|         mesh: meshes.add(Plane3d::default().mesh().size(20.0, 20.0)),
 | |
|         material: white_handle,
 | |
|         ..default()
 | |
|     });
 | |
| 
 | |
|     println!("Using DirectionalLight");
 | |
| 
 | |
|     commands.spawn(PointLightBundle {
 | |
|         transform: Transform::from_xyz(5.0, 5.0, 0.0),
 | |
|         point_light: PointLight {
 | |
|             intensity: 0.0,
 | |
|             range: spawn_plane_depth,
 | |
|             color: Color::WHITE,
 | |
|             shadows_enabled: true,
 | |
|             ..default()
 | |
|         },
 | |
|         ..default()
 | |
|     });
 | |
| 
 | |
|     commands.spawn(DirectionalLightBundle {
 | |
|         directional_light: DirectionalLight {
 | |
|             illuminance: light_consts::lux::OVERCAST_DAY,
 | |
|             shadows_enabled: true,
 | |
|             ..default()
 | |
|         },
 | |
|         transform: Transform::from_rotation(Quat::from_euler(
 | |
|             EulerRot::ZYX,
 | |
|             0.0,
 | |
|             PI / 2.,
 | |
|             -PI / 4.,
 | |
|         )),
 | |
|         cascade_shadow_config: CascadeShadowConfigBuilder {
 | |
|             first_cascade_far_bound: 7.0,
 | |
|             maximum_distance: 25.0,
 | |
|             ..default()
 | |
|         }
 | |
|         .into(),
 | |
|         ..default()
 | |
|     });
 | |
| 
 | |
|     // camera
 | |
|     commands.spawn(Camera3dBundle {
 | |
|         transform: Transform::from_xyz(-5.0, 5.0, 5.0)
 | |
|             .looking_at(Vec3::new(-1.0, 1.0, 0.0), Vec3::Y),
 | |
|         ..default()
 | |
|     });
 | |
| }
 | |
| 
 | |
| fn toggle_light(
 | |
|     input: Res<ButtonInput<KeyCode>>,
 | |
|     mut point_lights: Query<&mut PointLight>,
 | |
|     mut directional_lights: Query<&mut DirectionalLight>,
 | |
| ) {
 | |
|     if input.just_pressed(KeyCode::KeyL) {
 | |
|         for mut light in &mut point_lights {
 | |
|             light.intensity = if light.intensity == 0.0 {
 | |
|                 println!("Using PointLight");
 | |
|                 1_000_000.0 // Mini-sun point light
 | |
|             } else {
 | |
|                 0.0
 | |
|             };
 | |
|         }
 | |
|         for mut light in &mut directional_lights {
 | |
|             light.illuminance = if light.illuminance == 0.0 {
 | |
|                 println!("Using DirectionalLight");
 | |
|                 light_consts::lux::OVERCAST_DAY
 | |
|             } else {
 | |
|                 0.0
 | |
|             };
 | |
|         }
 | |
|     }
 | |
| }
 | |
| 
 | |
| fn toggle_shadows(
 | |
|     mut commands: Commands,
 | |
|     input: Res<ButtonInput<KeyCode>>,
 | |
|     mut queries: ParamSet<(
 | |
|         Query<Entity, (With<Handle<Mesh>>, With<NotShadowCaster>)>,
 | |
|         Query<Entity, (With<Handle<Mesh>>, With<NotShadowReceiver>)>,
 | |
|         Query<Entity, (With<Handle<Mesh>>, Without<NotShadowCaster>)>,
 | |
|         Query<Entity, (With<Handle<Mesh>>, Without<NotShadowReceiver>)>,
 | |
|     )>,
 | |
| ) {
 | |
|     if input.just_pressed(KeyCode::KeyC) {
 | |
|         println!("Toggling casters");
 | |
|         for entity in queries.p0().iter() {
 | |
|             commands.entity(entity).remove::<NotShadowCaster>();
 | |
|         }
 | |
|         for entity in queries.p2().iter() {
 | |
|             commands.entity(entity).insert(NotShadowCaster);
 | |
|         }
 | |
|     }
 | |
|     if input.just_pressed(KeyCode::KeyR) {
 | |
|         println!("Toggling receivers");
 | |
|         for entity in queries.p1().iter() {
 | |
|             commands.entity(entity).remove::<NotShadowReceiver>();
 | |
|         }
 | |
|         for entity in queries.p3().iter() {
 | |
|             commands.entity(entity).insert(NotShadowReceiver);
 | |
|         }
 | |
|     }
 | |
| }
 |