 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>
		
			
				
	
	
		
			118 lines
		
	
	
		
			3.1 KiB
		
	
	
	
		
			Rust
		
	
	
	
	
	
			
		
		
	
	
			118 lines
		
	
	
		
			3.1 KiB
		
	
	
	
		
			Rust
		
	
	
	
	
	
| //! Test rendering of many gizmos.
 | |
| 
 | |
| use std::f32::consts::TAU;
 | |
| 
 | |
| use bevy::{
 | |
|     diagnostic::{DiagnosticsStore, FrameTimeDiagnosticsPlugin},
 | |
|     prelude::*,
 | |
|     window::{PresentMode, WindowResolution},
 | |
|     winit::{UpdateMode, WinitSettings},
 | |
| };
 | |
| 
 | |
| const SYSTEM_COUNT: u32 = 10;
 | |
| 
 | |
| fn main() {
 | |
|     let mut app = App::new();
 | |
|     app.add_plugins((
 | |
|         DefaultPlugins.set(WindowPlugin {
 | |
|             primary_window: Some(Window {
 | |
|                 title: "Many Debug Lines".to_string(),
 | |
|                 present_mode: PresentMode::AutoNoVsync,
 | |
|                 resolution: WindowResolution::new(1920.0, 1080.0).with_scale_factor_override(1.0),
 | |
|                 ..default()
 | |
|             }),
 | |
|             ..default()
 | |
|         }),
 | |
|         FrameTimeDiagnosticsPlugin,
 | |
|     ))
 | |
|     .insert_resource(WinitSettings {
 | |
|         focused_mode: UpdateMode::Continuous,
 | |
|         unfocused_mode: UpdateMode::Continuous,
 | |
|     })
 | |
|     .insert_resource(Config {
 | |
|         line_count: 50_000,
 | |
|         fancy: false,
 | |
|     })
 | |
|     .add_systems(Startup, setup)
 | |
|     .add_systems(Update, (input, ui_system));
 | |
| 
 | |
|     for _ in 0..SYSTEM_COUNT {
 | |
|         app.add_systems(Update, system);
 | |
|     }
 | |
| 
 | |
|     app.run();
 | |
| }
 | |
| 
 | |
| #[derive(Resource, Debug)]
 | |
| struct Config {
 | |
|     line_count: u32,
 | |
|     fancy: bool,
 | |
| }
 | |
| 
 | |
| fn input(mut config: ResMut<Config>, input: Res<ButtonInput<KeyCode>>) {
 | |
|     if input.just_pressed(KeyCode::ArrowUp) {
 | |
|         config.line_count += 10_000;
 | |
|     }
 | |
|     if input.just_pressed(KeyCode::ArrowDown) {
 | |
|         config.line_count = config.line_count.saturating_sub(10_000);
 | |
|     }
 | |
|     if input.just_pressed(KeyCode::Space) {
 | |
|         config.fancy = !config.fancy;
 | |
|     }
 | |
| }
 | |
| 
 | |
| fn system(config: Res<Config>, time: Res<Time>, mut draw: Gizmos) {
 | |
|     if !config.fancy {
 | |
|         for _ in 0..(config.line_count / SYSTEM_COUNT) {
 | |
|             draw.line(Vec3::NEG_Y, Vec3::Y, Color::BLACK);
 | |
|         }
 | |
|     } else {
 | |
|         for i in 0..(config.line_count / SYSTEM_COUNT) {
 | |
|             let angle = i as f32 / (config.line_count / SYSTEM_COUNT) as f32 * TAU;
 | |
| 
 | |
|             let vector = Vec2::from(angle.sin_cos()).extend(time.elapsed_seconds().sin());
 | |
|             let start_color = LinearRgba::rgb(vector.x, vector.z, 0.5);
 | |
|             let end_color = LinearRgba::rgb(-vector.z, -vector.y, 0.5);
 | |
| 
 | |
|             draw.line_gradient(vector, -vector, start_color, end_color);
 | |
|         }
 | |
|     }
 | |
| }
 | |
| 
 | |
| fn setup(mut commands: Commands) {
 | |
|     warn!(include_str!("warning_string.txt"));
 | |
| 
 | |
|     commands.spawn(Camera3dBundle {
 | |
|         transform: Transform::from_xyz(3., 1., 5.).looking_at(Vec3::ZERO, Vec3::Y),
 | |
|         ..default()
 | |
|     });
 | |
| 
 | |
|     commands.spawn(TextBundle::from_section(
 | |
|         "",
 | |
|         TextStyle {
 | |
|             font_size: 30.,
 | |
|             ..default()
 | |
|         },
 | |
|     ));
 | |
| }
 | |
| 
 | |
| fn ui_system(mut query: Query<&mut Text>, config: Res<Config>, diag: Res<DiagnosticsStore>) {
 | |
|     let mut text = query.single_mut();
 | |
| 
 | |
|     let Some(fps) = diag
 | |
|         .get(&FrameTimeDiagnosticsPlugin::FPS)
 | |
|         .and_then(|fps| fps.smoothed())
 | |
|     else {
 | |
|         return;
 | |
|     };
 | |
| 
 | |
|     text.sections[0].value = format!(
 | |
|         "Line count: {}\n\
 | |
|         FPS: {:.0}\n\n\
 | |
|         Controls:\n\
 | |
|         Up/Down: Raise or lower the line count.\n\
 | |
|         Spacebar: Toggle fancy mode.",
 | |
|         config.line_count, fps,
 | |
|     );
 | |
| }
 |