mirror of
https://github.com/bevyengine/bevy
synced 2025-02-18 06:58:34 +00:00
# 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>
224 lines
7.2 KiB
Rust
224 lines
7.2 KiB
Rust
//! Shows various text layout options.
|
|
|
|
use bevy::{
|
|
color::palettes::{basic::RED, css::*},
|
|
diagnostic::{DiagnosticsStore, FrameTimeDiagnosticsPlugin},
|
|
prelude::*,
|
|
window::{PresentMode, WindowPlugin},
|
|
};
|
|
|
|
fn main() {
|
|
App::new()
|
|
.add_plugins((
|
|
DefaultPlugins.set(WindowPlugin {
|
|
primary_window: Some(Window {
|
|
present_mode: PresentMode::AutoNoVsync,
|
|
..default()
|
|
}),
|
|
..default()
|
|
}),
|
|
FrameTimeDiagnosticsPlugin,
|
|
))
|
|
.add_systems(Startup, infotext_system)
|
|
.add_systems(Update, change_text_system)
|
|
.run();
|
|
}
|
|
|
|
#[derive(Component)]
|
|
struct TextChanges;
|
|
|
|
fn infotext_system(mut commands: Commands, asset_server: Res<AssetServer>) {
|
|
let font = asset_server.load("fonts/FiraSans-Bold.ttf");
|
|
commands.spawn(Camera2dBundle::default());
|
|
let root_uinode = commands
|
|
.spawn(NodeBundle {
|
|
style: Style {
|
|
width: Val::Percent(100.),
|
|
height: Val::Percent(100.),
|
|
justify_content: JustifyContent::SpaceBetween,
|
|
|
|
..default()
|
|
},
|
|
..default()
|
|
})
|
|
.id();
|
|
|
|
let left_column = commands.spawn(NodeBundle {
|
|
style: Style {
|
|
flex_direction: FlexDirection::Column,
|
|
justify_content: JustifyContent::SpaceBetween,
|
|
align_items: AlignItems::Start,
|
|
flex_grow: 1.,
|
|
margin: UiRect::axes(Val::Px(15.), Val::Px(5.)),
|
|
..default()
|
|
},
|
|
..default()
|
|
}).with_children(|builder| {
|
|
builder.spawn(
|
|
TextBundle::from_section(
|
|
"This is\ntext with\nline breaks\nin the top left.",
|
|
TextStyle {
|
|
font: font.clone(),
|
|
font_size: 30.0,
|
|
..default()
|
|
},
|
|
)
|
|
);
|
|
builder.spawn(TextBundle::from_section(
|
|
"This text is right-justified. The `JustifyText` component controls the horizontal alignment of the lines of multi-line text relative to each other, and does not affect the text node's position in the UI layout.", TextStyle {
|
|
font: font.clone(),
|
|
font_size: 30.0,
|
|
color: YELLOW.into(),
|
|
},
|
|
)
|
|
.with_text_justify(JustifyText::Right)
|
|
.with_style(Style {
|
|
max_width: Val::Px(300.),
|
|
..default()
|
|
})
|
|
);
|
|
builder.spawn(
|
|
TextBundle::from_section(
|
|
"This\ntext has\nline breaks and also a set width in the bottom left.",
|
|
TextStyle {
|
|
font: font.clone(),
|
|
font_size: 30.0,
|
|
color: WHITE.into(),
|
|
},
|
|
)
|
|
.with_style(Style {
|
|
max_width: Val::Px(300.),
|
|
..default()
|
|
})
|
|
);
|
|
}).id();
|
|
|
|
let right_column = commands.spawn(NodeBundle {
|
|
style: Style {
|
|
flex_direction: FlexDirection::Column,
|
|
justify_content: JustifyContent::SpaceBetween,
|
|
align_items: AlignItems::End,
|
|
flex_grow: 1.,
|
|
margin: UiRect::axes(Val::Px(15.), Val::Px(5.)),
|
|
..default()
|
|
},
|
|
..default()
|
|
}).with_children(|builder| {
|
|
|
|
builder.spawn(TextBundle::from_section(
|
|
"This text is very long, has a limited width, is center-justified, is positioned in the top right and is also colored pink.",
|
|
TextStyle {
|
|
font: font.clone(),
|
|
font_size: 40.0,
|
|
color: Color::srgb(0.8, 0.2, 0.7),
|
|
},
|
|
)
|
|
.with_text_justify(JustifyText::Center)
|
|
.with_style(Style {
|
|
max_width: Val::Px(400.),
|
|
..default()
|
|
})
|
|
);
|
|
|
|
builder.spawn(
|
|
TextBundle::from_section(
|
|
"This text is left-justified and is vertically positioned to distribute the empty space equally above and below it.",
|
|
TextStyle {
|
|
font: font.clone(),
|
|
font_size: 35.0,
|
|
color: YELLOW.into(),
|
|
},
|
|
)
|
|
.with_text_justify(JustifyText::Left)
|
|
.with_style(Style {
|
|
max_width: Val::Px(300.),
|
|
..default()
|
|
}),
|
|
);
|
|
|
|
builder.spawn((
|
|
TextBundle::from_sections([
|
|
TextSection::new(
|
|
"This text changes in the bottom right",
|
|
TextStyle {
|
|
font: font.clone(),
|
|
font_size: 25.0,
|
|
color: Color::WHITE,
|
|
},
|
|
),
|
|
TextSection::new(
|
|
"\nThis text changes in the bottom right - ",
|
|
TextStyle {
|
|
font: font.clone(),
|
|
font_size: 25.0,
|
|
color: RED.into(),
|
|
},
|
|
),
|
|
TextSection::from_style(TextStyle {
|
|
font: font.clone(),
|
|
font_size: 25.0,
|
|
color: ORANGE_RED.into(),
|
|
}),
|
|
TextSection::new(
|
|
" fps, ",
|
|
TextStyle {
|
|
font: font.clone(),
|
|
font_size: 25.0,
|
|
color: YELLOW.into(),
|
|
},
|
|
),
|
|
TextSection::from_style(TextStyle {
|
|
font: font.clone(),
|
|
font_size: 25.0,
|
|
color: GREEN.into(),
|
|
}),
|
|
TextSection::new(
|
|
" ms/frame",
|
|
TextStyle {
|
|
font: font.clone(),
|
|
font_size: 25.0,
|
|
color: BLUE.into(),
|
|
},
|
|
),
|
|
]),
|
|
TextChanges,
|
|
));
|
|
})
|
|
.id();
|
|
|
|
commands
|
|
.entity(root_uinode)
|
|
.push_children(&[left_column, right_column]);
|
|
}
|
|
|
|
fn change_text_system(
|
|
time: Res<Time>,
|
|
diagnostics: Res<DiagnosticsStore>,
|
|
mut query: Query<&mut Text, With<TextChanges>>,
|
|
) {
|
|
for mut text in &mut query {
|
|
let mut fps = 0.0;
|
|
if let Some(fps_diagnostic) = diagnostics.get(&FrameTimeDiagnosticsPlugin::FPS) {
|
|
if let Some(fps_smoothed) = fps_diagnostic.smoothed() {
|
|
fps = fps_smoothed;
|
|
}
|
|
}
|
|
|
|
let mut frame_time = time.delta_seconds_f64();
|
|
if let Some(frame_time_diagnostic) =
|
|
diagnostics.get(&FrameTimeDiagnosticsPlugin::FRAME_TIME)
|
|
{
|
|
if let Some(frame_time_smoothed) = frame_time_diagnostic.smoothed() {
|
|
frame_time = frame_time_smoothed;
|
|
}
|
|
}
|
|
|
|
text.sections[0].value = format!(
|
|
"This text changes in the bottom right - {fps:.1} fps, {frame_time:.3} ms/frame",
|
|
);
|
|
|
|
text.sections[2].value = format!("{fps:.1}");
|
|
|
|
text.sections[4].value = format!("{frame_time:.3}");
|
|
}
|
|
}
|