# 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>
		
			
				
	
	
		
			195 lines
		
	
	
		
			5.9 KiB
		
	
	
	
		
			Rust
		
	
	
	
	
	
			
		
		
	
	
			195 lines
		
	
	
		
			5.9 KiB
		
	
	
	
		
			Rust
		
	
	
	
	
	
//! A scene showcasing screen space ambient occlusion.
 | 
						|
 | 
						|
use bevy::{
 | 
						|
    core_pipeline::experimental::taa::{TemporalAntiAliasBundle, TemporalAntiAliasPlugin},
 | 
						|
    pbr::{
 | 
						|
        ScreenSpaceAmbientOcclusionBundle, ScreenSpaceAmbientOcclusionQualityLevel,
 | 
						|
        ScreenSpaceAmbientOcclusionSettings,
 | 
						|
    },
 | 
						|
    prelude::*,
 | 
						|
    render::camera::TemporalJitter,
 | 
						|
};
 | 
						|
use std::f32::consts::PI;
 | 
						|
 | 
						|
fn main() {
 | 
						|
    App::new()
 | 
						|
        .insert_resource(AmbientLight {
 | 
						|
            brightness: 1000.,
 | 
						|
            ..default()
 | 
						|
        })
 | 
						|
        .add_plugins((DefaultPlugins, TemporalAntiAliasPlugin))
 | 
						|
        .add_systems(Startup, setup)
 | 
						|
        .add_systems(Update, update)
 | 
						|
        .run();
 | 
						|
}
 | 
						|
 | 
						|
fn setup(
 | 
						|
    mut commands: Commands,
 | 
						|
    mut meshes: ResMut<Assets<Mesh>>,
 | 
						|
    mut materials: ResMut<Assets<StandardMaterial>>,
 | 
						|
    asset_server: Res<AssetServer>,
 | 
						|
) {
 | 
						|
    commands
 | 
						|
        .spawn(Camera3dBundle {
 | 
						|
            camera: Camera {
 | 
						|
                hdr: true,
 | 
						|
                ..default()
 | 
						|
            },
 | 
						|
            transform: Transform::from_xyz(-2.0, 2.0, -2.0).looking_at(Vec3::ZERO, Vec3::Y),
 | 
						|
            ..default()
 | 
						|
        })
 | 
						|
        .insert(ScreenSpaceAmbientOcclusionBundle::default())
 | 
						|
        .insert(TemporalAntiAliasBundle::default());
 | 
						|
 | 
						|
    let material = materials.add(StandardMaterial {
 | 
						|
        base_color: Color::srgb(0.5, 0.5, 0.5),
 | 
						|
        perceptual_roughness: 1.0,
 | 
						|
        reflectance: 0.0,
 | 
						|
        ..default()
 | 
						|
    });
 | 
						|
    commands.spawn(PbrBundle {
 | 
						|
        mesh: meshes.add(Cuboid::default()),
 | 
						|
        material: material.clone(),
 | 
						|
        transform: Transform::from_xyz(0.0, 0.0, 1.0),
 | 
						|
        ..default()
 | 
						|
    });
 | 
						|
    commands.spawn(PbrBundle {
 | 
						|
        mesh: meshes.add(Cuboid::default()),
 | 
						|
        material: material.clone(),
 | 
						|
        transform: Transform::from_xyz(0.0, -1.0, 0.0),
 | 
						|
        ..default()
 | 
						|
    });
 | 
						|
    commands.spawn(PbrBundle {
 | 
						|
        mesh: meshes.add(Cuboid::default()),
 | 
						|
        material,
 | 
						|
        transform: Transform::from_xyz(1.0, 0.0, 0.0),
 | 
						|
        ..default()
 | 
						|
    });
 | 
						|
    commands.spawn((
 | 
						|
        PbrBundle {
 | 
						|
            mesh: meshes.add(Sphere::new(0.4).mesh().uv(72, 36)),
 | 
						|
            material: materials.add(StandardMaterial {
 | 
						|
                base_color: Color::srgb(0.4, 0.4, 0.4),
 | 
						|
                perceptual_roughness: 1.0,
 | 
						|
                reflectance: 0.0,
 | 
						|
                ..default()
 | 
						|
            }),
 | 
						|
            ..default()
 | 
						|
        },
 | 
						|
        SphereMarker,
 | 
						|
    ));
 | 
						|
 | 
						|
    commands.spawn(DirectionalLightBundle {
 | 
						|
        directional_light: DirectionalLight {
 | 
						|
            shadows_enabled: true,
 | 
						|
            ..default()
 | 
						|
        },
 | 
						|
        transform: Transform::from_rotation(Quat::from_euler(
 | 
						|
            EulerRot::ZYX,
 | 
						|
            0.0,
 | 
						|
            PI * -0.15,
 | 
						|
            PI * -0.15,
 | 
						|
        )),
 | 
						|
        ..default()
 | 
						|
    });
 | 
						|
 | 
						|
    commands.spawn(
 | 
						|
        TextBundle::from_section(
 | 
						|
            "",
 | 
						|
            TextStyle {
 | 
						|
                font: asset_server.load("fonts/FiraMono-Medium.ttf"),
 | 
						|
                font_size: 26.0,
 | 
						|
                ..default()
 | 
						|
            },
 | 
						|
        )
 | 
						|
        .with_style(Style {
 | 
						|
            position_type: PositionType::Absolute,
 | 
						|
            bottom: Val::Px(10.0),
 | 
						|
            left: Val::Px(10.0),
 | 
						|
            ..default()
 | 
						|
        }),
 | 
						|
    );
 | 
						|
}
 | 
						|
 | 
						|
fn update(
 | 
						|
    camera: Query<
 | 
						|
        (
 | 
						|
            Entity,
 | 
						|
            Option<&ScreenSpaceAmbientOcclusionSettings>,
 | 
						|
            Option<&TemporalJitter>,
 | 
						|
        ),
 | 
						|
        With<Camera>,
 | 
						|
    >,
 | 
						|
    mut text: Query<&mut Text>,
 | 
						|
    mut sphere: Query<&mut Transform, With<SphereMarker>>,
 | 
						|
    mut commands: Commands,
 | 
						|
    keycode: Res<ButtonInput<KeyCode>>,
 | 
						|
    time: Res<Time>,
 | 
						|
) {
 | 
						|
    let mut sphere = sphere.single_mut();
 | 
						|
    sphere.translation.y = (time.elapsed_seconds() / 1.7).sin() * 0.7;
 | 
						|
 | 
						|
    let (camera_entity, ssao_settings, temporal_jitter) = camera.single();
 | 
						|
 | 
						|
    let mut commands = commands.entity(camera_entity);
 | 
						|
    if keycode.just_pressed(KeyCode::Digit1) {
 | 
						|
        commands.remove::<ScreenSpaceAmbientOcclusionSettings>();
 | 
						|
    }
 | 
						|
    if keycode.just_pressed(KeyCode::Digit2) {
 | 
						|
        commands.insert(ScreenSpaceAmbientOcclusionSettings {
 | 
						|
            quality_level: ScreenSpaceAmbientOcclusionQualityLevel::Low,
 | 
						|
        });
 | 
						|
    }
 | 
						|
    if keycode.just_pressed(KeyCode::Digit3) {
 | 
						|
        commands.insert(ScreenSpaceAmbientOcclusionSettings {
 | 
						|
            quality_level: ScreenSpaceAmbientOcclusionQualityLevel::Medium,
 | 
						|
        });
 | 
						|
    }
 | 
						|
    if keycode.just_pressed(KeyCode::Digit4) {
 | 
						|
        commands.insert(ScreenSpaceAmbientOcclusionSettings {
 | 
						|
            quality_level: ScreenSpaceAmbientOcclusionQualityLevel::High,
 | 
						|
        });
 | 
						|
    }
 | 
						|
    if keycode.just_pressed(KeyCode::Digit5) {
 | 
						|
        commands.insert(ScreenSpaceAmbientOcclusionSettings {
 | 
						|
            quality_level: ScreenSpaceAmbientOcclusionQualityLevel::Ultra,
 | 
						|
        });
 | 
						|
    }
 | 
						|
    if keycode.just_pressed(KeyCode::Space) {
 | 
						|
        if temporal_jitter.is_some() {
 | 
						|
            commands.remove::<TemporalJitter>();
 | 
						|
        } else {
 | 
						|
            commands.insert(TemporalJitter::default());
 | 
						|
        }
 | 
						|
    }
 | 
						|
 | 
						|
    let mut text = text.single_mut();
 | 
						|
    let text = &mut text.sections[0].value;
 | 
						|
    text.clear();
 | 
						|
 | 
						|
    let (o, l, m, h, u) = match ssao_settings.map(|s| s.quality_level) {
 | 
						|
        None => ("*", "", "", "", ""),
 | 
						|
        Some(ScreenSpaceAmbientOcclusionQualityLevel::Low) => ("", "*", "", "", ""),
 | 
						|
        Some(ScreenSpaceAmbientOcclusionQualityLevel::Medium) => ("", "", "*", "", ""),
 | 
						|
        Some(ScreenSpaceAmbientOcclusionQualityLevel::High) => ("", "", "", "*", ""),
 | 
						|
        Some(ScreenSpaceAmbientOcclusionQualityLevel::Ultra) => ("", "", "", "", "*"),
 | 
						|
        _ => unreachable!(),
 | 
						|
    };
 | 
						|
 | 
						|
    text.push_str("SSAO Quality:\n");
 | 
						|
    text.push_str(&format!("(1) {o}Off{o}\n"));
 | 
						|
    text.push_str(&format!("(2) {l}Low{l}\n"));
 | 
						|
    text.push_str(&format!("(3) {m}Medium{m}\n"));
 | 
						|
    text.push_str(&format!("(4) {h}High{h}\n"));
 | 
						|
    text.push_str(&format!("(5) {u}Ultra{u}\n\n"));
 | 
						|
 | 
						|
    text.push_str("Temporal Antialiasing:\n");
 | 
						|
    text.push_str(match temporal_jitter {
 | 
						|
        Some(_) => "(Space) Enabled",
 | 
						|
        None => "(Space) Disabled",
 | 
						|
    });
 | 
						|
}
 | 
						|
 | 
						|
#[derive(Component)]
 | 
						|
struct SphereMarker;
 |