# 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>
		
			
				
	
	
		
			145 lines
		
	
	
		
			4.7 KiB
		
	
	
	
		
			Rust
		
	
	
	
	
	
			
		
		
	
	
			145 lines
		
	
	
		
			4.7 KiB
		
	
	
	
		
			Rust
		
	
	
	
	
	
//! This example demonstrates text wrapping and use of the `LineBreakOn` property.
 | 
						|
 | 
						|
use argh::FromArgs;
 | 
						|
use bevy::prelude::*;
 | 
						|
use bevy::text::BreakLineOn;
 | 
						|
use bevy::window::WindowResolution;
 | 
						|
use bevy::winit::WinitSettings;
 | 
						|
 | 
						|
#[derive(FromArgs, Resource)]
 | 
						|
/// `text_wrap_debug` demonstrates text wrapping and use of the `LineBreakOn` property
 | 
						|
struct Args {
 | 
						|
    #[argh(option)]
 | 
						|
    /// window scale factor
 | 
						|
    scale_factor: Option<f32>,
 | 
						|
 | 
						|
    #[argh(option, default = "1.")]
 | 
						|
    /// ui scale factor
 | 
						|
    ui_scale: f32,
 | 
						|
}
 | 
						|
 | 
						|
fn main() {
 | 
						|
    // `from_env` panics on the web
 | 
						|
    #[cfg(not(target_arch = "wasm32"))]
 | 
						|
    let args: Args = argh::from_env();
 | 
						|
    #[cfg(target_arch = "wasm32")]
 | 
						|
    let args = Args::from_args(&[], &[]).unwrap();
 | 
						|
 | 
						|
    let window = if let Some(scale_factor) = args.scale_factor {
 | 
						|
        Window {
 | 
						|
            resolution: WindowResolution::default().with_scale_factor_override(scale_factor),
 | 
						|
            ..Default::default()
 | 
						|
        }
 | 
						|
    } else {
 | 
						|
        Window::default()
 | 
						|
    };
 | 
						|
 | 
						|
    App::new()
 | 
						|
        .add_plugins(DefaultPlugins.set(WindowPlugin {
 | 
						|
            primary_window: Some(window),
 | 
						|
            ..Default::default()
 | 
						|
        }))
 | 
						|
        .insert_resource(WinitSettings::desktop_app())
 | 
						|
        .insert_resource(UiScale(args.ui_scale))
 | 
						|
        .add_systems(Startup, spawn)
 | 
						|
        .run();
 | 
						|
}
 | 
						|
 | 
						|
fn spawn(mut commands: Commands, asset_server: Res<AssetServer>) {
 | 
						|
    commands.spawn(Camera2dBundle::default());
 | 
						|
 | 
						|
    let text_style = TextStyle {
 | 
						|
        font: asset_server.load("fonts/FiraSans-Bold.ttf"),
 | 
						|
        font_size: 14.0,
 | 
						|
        ..default()
 | 
						|
    };
 | 
						|
 | 
						|
    let root = commands
 | 
						|
        .spawn(NodeBundle {
 | 
						|
            style: Style {
 | 
						|
                width: Val::Percent(100.),
 | 
						|
                height: Val::Percent(100.),
 | 
						|
                flex_direction: FlexDirection::Column,
 | 
						|
                ..Default::default()
 | 
						|
            },
 | 
						|
            background_color: Color::BLACK.into(),
 | 
						|
            ..Default::default()
 | 
						|
        })
 | 
						|
        .id();
 | 
						|
 | 
						|
    for linebreak_behavior in [
 | 
						|
        BreakLineOn::AnyCharacter,
 | 
						|
        BreakLineOn::WordBoundary,
 | 
						|
        BreakLineOn::NoWrap,
 | 
						|
    ] {
 | 
						|
        let row_id = commands
 | 
						|
            .spawn(NodeBundle {
 | 
						|
                style: Style {
 | 
						|
                    flex_direction: FlexDirection::Row,
 | 
						|
                    justify_content: JustifyContent::SpaceAround,
 | 
						|
                    align_items: AlignItems::Center,
 | 
						|
                    width: Val::Percent(100.),
 | 
						|
                    height: Val::Percent(50.),
 | 
						|
                    ..Default::default()
 | 
						|
                },
 | 
						|
                ..Default::default()
 | 
						|
            })
 | 
						|
            .id();
 | 
						|
 | 
						|
        let justifications = vec![
 | 
						|
            JustifyContent::Center,
 | 
						|
            JustifyContent::FlexStart,
 | 
						|
            JustifyContent::FlexEnd,
 | 
						|
            JustifyContent::SpaceAround,
 | 
						|
            JustifyContent::SpaceBetween,
 | 
						|
            JustifyContent::SpaceEvenly,
 | 
						|
        ];
 | 
						|
 | 
						|
        for (i, justification) in justifications.into_iter().enumerate() {
 | 
						|
            let c = 0.3 + i as f32 * 0.1;
 | 
						|
            let column_id = commands
 | 
						|
                .spawn(NodeBundle {
 | 
						|
                    style: Style {
 | 
						|
                        justify_content: justification,
 | 
						|
                        flex_direction: FlexDirection::Column,
 | 
						|
                        width: Val::Percent(16.),
 | 
						|
                        height: Val::Percent(95.),
 | 
						|
                        overflow: Overflow::clip_x(),
 | 
						|
                        ..Default::default()
 | 
						|
                    },
 | 
						|
                    background_color: Color::srgb(0.5, c, 1.0 - c).into(),
 | 
						|
                    ..Default::default()
 | 
						|
                })
 | 
						|
                .id();
 | 
						|
 | 
						|
            let messages = [
 | 
						|
                format!("JustifyContent::{justification:?}"),
 | 
						|
                format!("LineBreakOn::{linebreak_behavior:?}"),
 | 
						|
                "Line 1\nLine 2\nLine 3".to_string(),
 | 
						|
                "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas auctor, nunc ac faucibus fringilla.".to_string(),
 | 
						|
            ];
 | 
						|
 | 
						|
            for (j, message) in messages.into_iter().enumerate() {
 | 
						|
                let text = Text {
 | 
						|
                    sections: vec![TextSection {
 | 
						|
                        value: message.clone(),
 | 
						|
                        style: text_style.clone(),
 | 
						|
                    }],
 | 
						|
                    justify: JustifyText::Left,
 | 
						|
                    linebreak_behavior,
 | 
						|
                };
 | 
						|
                let text_id = commands
 | 
						|
                    .spawn(TextBundle {
 | 
						|
                        text,
 | 
						|
                        background_color: Color::srgb(0.8 - j as f32 * 0.2, 0., 0.).into(),
 | 
						|
                        ..Default::default()
 | 
						|
                    })
 | 
						|
                    .id();
 | 
						|
                commands.entity(column_id).add_child(text_id);
 | 
						|
            }
 | 
						|
            commands.entity(row_id).add_child(column_id);
 | 
						|
        }
 | 
						|
        commands.entity(root).add_child(row_id);
 | 
						|
    }
 | 
						|
}
 |