# 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>
		
			
				
	
	
		
			104 lines
		
	
	
		
			3.4 KiB
		
	
	
	
		
			Rust
		
	
	
	
	
	
			
		
		
	
	
			104 lines
		
	
	
		
			3.4 KiB
		
	
	
	
		
			Rust
		
	
	
	
	
	
//! This example illustrates how to override the window scale factor imposed by the
 | 
						|
//! operating system.
 | 
						|
 | 
						|
use bevy::{prelude::*, window::WindowResolution};
 | 
						|
 | 
						|
fn main() {
 | 
						|
    App::new()
 | 
						|
        .add_plugins(DefaultPlugins.set(WindowPlugin {
 | 
						|
            primary_window: Some(Window {
 | 
						|
                resolution: WindowResolution::new(500., 300.).with_scale_factor_override(1.0),
 | 
						|
                ..default()
 | 
						|
            }),
 | 
						|
            ..default()
 | 
						|
        }))
 | 
						|
        .add_systems(Startup, setup)
 | 
						|
        .add_systems(
 | 
						|
            Update,
 | 
						|
            (display_override, toggle_override, change_scale_factor),
 | 
						|
        )
 | 
						|
        .run();
 | 
						|
}
 | 
						|
 | 
						|
fn setup(mut commands: Commands) {
 | 
						|
    // camera
 | 
						|
    commands.spawn(Camera2dBundle::default());
 | 
						|
    // root node
 | 
						|
    commands
 | 
						|
        .spawn(NodeBundle {
 | 
						|
            style: Style {
 | 
						|
                width: Val::Percent(100.0),
 | 
						|
                height: Val::Percent(100.0),
 | 
						|
                justify_content: JustifyContent::SpaceBetween,
 | 
						|
                ..default()
 | 
						|
            },
 | 
						|
            ..default()
 | 
						|
        })
 | 
						|
        .with_children(|parent| {
 | 
						|
            // left vertical fill (border)
 | 
						|
            parent
 | 
						|
                .spawn(NodeBundle {
 | 
						|
                    style: Style {
 | 
						|
                        width: Val::Px(200.0),
 | 
						|
                        height: Val::Percent(100.0),
 | 
						|
                        border: UiRect::all(Val::Px(2.0)),
 | 
						|
                        ..default()
 | 
						|
                    },
 | 
						|
                    background_color: Color::srgb(0.65, 0.65, 0.65).into(),
 | 
						|
                    ..default()
 | 
						|
                })
 | 
						|
                .with_children(|parent| {
 | 
						|
                    parent.spawn(
 | 
						|
                        TextBundle::from_section(
 | 
						|
                            "Example text",
 | 
						|
                            TextStyle {
 | 
						|
                                font_size: 30.0,
 | 
						|
                                ..default()
 | 
						|
                            },
 | 
						|
                        )
 | 
						|
                        .with_style(Style {
 | 
						|
                            align_self: AlignSelf::FlexEnd,
 | 
						|
                            ..default()
 | 
						|
                        }),
 | 
						|
                    );
 | 
						|
                });
 | 
						|
        });
 | 
						|
}
 | 
						|
 | 
						|
/// Set the title of the window to the current override
 | 
						|
fn display_override(mut windows: Query<&mut Window>) {
 | 
						|
    let mut window = windows.single_mut();
 | 
						|
 | 
						|
    window.title = format!(
 | 
						|
        "Scale override: {:?}",
 | 
						|
        window.resolution.scale_factor_override()
 | 
						|
    );
 | 
						|
}
 | 
						|
 | 
						|
/// This system toggles scale factor overrides when enter is pressed
 | 
						|
fn toggle_override(input: Res<ButtonInput<KeyCode>>, mut windows: Query<&mut Window>) {
 | 
						|
    let mut window = windows.single_mut();
 | 
						|
 | 
						|
    if input.just_pressed(KeyCode::Enter) {
 | 
						|
        let scale_factor_override = window.resolution.scale_factor_override();
 | 
						|
        window
 | 
						|
            .resolution
 | 
						|
            .set_scale_factor_override(scale_factor_override.xor(Some(1.0)));
 | 
						|
    }
 | 
						|
}
 | 
						|
 | 
						|
/// This system changes the scale factor override when up or down is pressed
 | 
						|
fn change_scale_factor(input: Res<ButtonInput<KeyCode>>, mut windows: Query<&mut Window>) {
 | 
						|
    let mut window = windows.single_mut();
 | 
						|
    let scale_factor_override = window.resolution.scale_factor_override();
 | 
						|
    if input.just_pressed(KeyCode::ArrowUp) {
 | 
						|
        window
 | 
						|
            .resolution
 | 
						|
            .set_scale_factor_override(scale_factor_override.map(|n| n + 1.0));
 | 
						|
    } else if input.just_pressed(KeyCode::ArrowDown) {
 | 
						|
        window
 | 
						|
            .resolution
 | 
						|
            .set_scale_factor_override(scale_factor_override.map(|n| (n - 1.0).max(1.0)));
 | 
						|
    }
 | 
						|
}
 |