Struct ColorGrading

pub struct ColorGrading {
    pub global: ColorGradingGlobal,
    pub shadows: ColorGradingSection,
    pub midtones: ColorGradingSection,
    pub highlights: ColorGradingSection,
}

Configures filmic color grading parameters to adjust the image appearance.

Color grading is applied just before tonemapping for a given Camera entity, with the sole exception of the post_saturation value in ColorGradingGlobal, which is applied after tonemapping.

Fields

global: ColorGradingGlobal

Filmic color grading values applied to the image as a whole (as opposed to individual sections, like shadows and highlights).

shadows: ColorGradingSection

Color grading values that are applied to the darker parts of the image.

The cutoff points can be customized with the ColorGradingGlobal::midtones_range field.

midtones: ColorGradingSection

Color grading values that are applied to the parts of the image with intermediate brightness.

The cutoff points can be customized with the ColorGradingGlobal::midtones_range field.

highlights: ColorGradingSection

Color grading values that are applied to the lighter parts of the image.

The cutoff points can be customized with the ColorGradingGlobal::midtones_range field.

Implementations

impl ColorGrading

pub fn with_identical_sections( global: ColorGradingGlobal, section: ColorGradingSection, ) -> ColorGrading

Creates a new ColorGrading instance in which shadows, midtones, and highlights all have the same set of color grading values.

Examples found in repository

examples/3d/tonemapping.rs (lines 557-567)

    fn basic_scene_recommendation(method: Tonemapping) -> ColorGrading {
        match method {
            Tonemapping::Reinhard | Tonemapping::ReinhardLuminance => ColorGrading {
                global: ColorGradingGlobal {
                    exposure: 0.5,
                    ..default()
                },
                ..default()
            },
            Tonemapping::AcesFitted => ColorGrading {
                global: ColorGradingGlobal {
                    exposure: 0.35,
                    ..default()
                },
                ..default()
            },
            Tonemapping::AgX => ColorGrading::with_identical_sections(
                ColorGradingGlobal {
                    exposure: -0.2,
                    post_saturation: 1.1,
                    ..default()
                },
                ColorGradingSection {
                    saturation: 1.1,
                    ..default()
                },
            ),
            _ => ColorGrading::default(),
        }
    }

pub fn all_sections(&self) -> impl Iterator<Item = &ColorGradingSection>

Returns an iterator that visits the shadows, midtones, and highlights sections, in that order.

pub fn all_sections_mut( &mut self, ) -> impl Iterator<Item = &mut ColorGradingSection>

Applies the given mutating function to the shadows, midtones, and highlights sections, in that order.

Returns an array composed of the results of such evaluation, in that order.

Examples found in repository

examples/3d/tonemapping.rs (line 360)

fn update_color_grading_settings(
    keys: Res<ButtonInput<KeyCode>>,
    time: Res<Time>,
    mut per_method_settings: ResMut<PerMethodSettings>,
    tonemapping: Single<&Tonemapping>,
    current_scene: Res<CurrentScene>,
    mut selected_parameter: ResMut<SelectedParameter>,
) {
    let color_grading = per_method_settings.settings.get_mut(*tonemapping).unwrap();
    let mut dt = time.delta_secs() * 0.25;
    if keys.pressed(KeyCode::ArrowLeft) {
        dt = -dt;
    }

    if keys.just_pressed(KeyCode::ArrowDown) {
        selected_parameter.next();
    }
    if keys.just_pressed(KeyCode::ArrowUp) {
        selected_parameter.prev();
    }
    if keys.pressed(KeyCode::ArrowLeft) || keys.pressed(KeyCode::ArrowRight) {
        match selected_parameter.value {
            0 => {
                color_grading.global.exposure += dt;
            }
            1 => {
                color_grading
                    .all_sections_mut()
                    .for_each(|section| section.gamma += dt);
            }
            2 => {
                color_grading
                    .all_sections_mut()
                    .for_each(|section| section.saturation += dt);
            }
            3 => {
                color_grading.global.post_saturation += dt;
            }
            _ => {}
        }
    }

    if keys.just_pressed(KeyCode::Space) {
        for (_, grading) in per_method_settings.settings.iter_mut() {
            *grading = ColorGrading::default();
        }
    }

    if keys.just_pressed(KeyCode::Enter) && current_scene.0 == 1 {
        for (mapper, grading) in per_method_settings.settings.iter_mut() {
            *grading = PerMethodSettings::basic_scene_recommendation(*mapper);
        }
    }
}

Trait Implementations

impl Clone for ColorGrading

fn clone(&self) -> ColorGrading

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Component for ColorGrading

where ColorGrading: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have [Component<Mutability = Mutable>], while immutable components will instead have [Component<Mutability = Immutable>].

fn register_required_components( requiree: ComponentId, components: &mut ComponentsRegistrator<'_>, required_components: &mut RequiredComponents, inheritance_depth: u16, recursion_check_stack: &mut Vec<ComponentId>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn register_component_hooks(hooks: &mut ComponentHooks)

👎Deprecated since 0.16.0: Use the individual hook methods instead (e.g., Component::on_add, etc.)

Called when registering this component, allowing mutable access to its ComponentHooks.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add ComponentHook for this Component if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert ComponentHook for this Component if one is defined.

fn on_replace() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_replace ComponentHook for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove ComponentHook for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn ComponentHook for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]

impl Debug for ColorGrading

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for ColorGrading

fn default() -> ColorGrading

Returns the “default value” for a type.

impl From<ColorGrading> for ColorGradingUniform

fn from(component: ColorGrading) -> ColorGradingUniform

Converts to this type from the input type.

impl FromArg for &'static ColorGrading

where ColorGrading: Any + Send + Sync, ColorGradingGlobal: FromReflect + TypePath + MaybeTyped + RegisterForReflection, ColorGradingSection: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

type This<'from_arg> = &'from_arg ColorGrading

The type to convert into.

fn from_arg( arg: Arg<'_>, ) -> Result<<&'static ColorGrading as FromArg>::This<'_>, ArgError>

Creates an item from an argument.

impl FromArg for &'static mut ColorGrading

where ColorGrading: Any + Send + Sync, ColorGradingGlobal: FromReflect + TypePath + MaybeTyped + RegisterForReflection, ColorGradingSection: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

type This<'from_arg> = &'from_arg mut ColorGrading

The type to convert into.

fn from_arg( arg: Arg<'_>, ) -> Result<<&'static mut ColorGrading as FromArg>::This<'_>, ArgError>

Creates an item from an argument.

impl FromArg for ColorGrading

where ColorGrading: Any + Send + Sync, ColorGradingGlobal: FromReflect + TypePath + MaybeTyped + RegisterForReflection, ColorGradingSection: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

type This<'from_arg> = ColorGrading

The type to convert into.

fn from_arg( arg: Arg<'_>, ) -> Result<<ColorGrading as FromArg>::This<'_>, ArgError>

Creates an item from an argument.

impl FromReflect for ColorGrading

where ColorGrading: Any + Send + Sync, ColorGradingGlobal: FromReflect + TypePath + MaybeTyped + RegisterForReflection, ColorGradingSection: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn from_reflect( reflect: &(dyn PartialReflect + 'static), ) -> Option<ColorGrading>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn PartialReflect>, ) -> Result<Self, Box<dyn PartialReflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetOwnership for &ColorGrading

where ColorGrading: Any + Send + Sync, ColorGradingGlobal: FromReflect + TypePath + MaybeTyped + RegisterForReflection, ColorGradingSection: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn ownership() -> Ownership

Returns the ownership of Self.

impl GetOwnership for &mut ColorGrading

where ColorGrading: Any + Send + Sync, ColorGradingGlobal: FromReflect + TypePath + MaybeTyped + RegisterForReflection, ColorGradingSection: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn ownership() -> Ownership

Returns the ownership of Self.

impl GetOwnership for ColorGrading

where ColorGrading: Any + Send + Sync, ColorGradingGlobal: FromReflect + TypePath + MaybeTyped + RegisterForReflection, ColorGradingSection: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn ownership() -> Ownership

Returns the ownership of Self.

impl GetTypeRegistration for ColorGrading

where ColorGrading: Any + Send + Sync, ColorGradingGlobal: FromReflect + TypePath + MaybeTyped + RegisterForReflection, ColorGradingSection: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl IntoReturn for &ColorGrading

where ColorGrading: Any + Send + Sync, ColorGradingGlobal: FromReflect + TypePath + MaybeTyped + RegisterForReflection, ColorGradingSection: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn into_return<'into_return>(self) -> Return<'into_return>

where &ColorGrading: 'into_return,

Converts Self into a Return value.

impl IntoReturn for &mut ColorGrading

where ColorGrading: Any + Send + Sync, ColorGradingGlobal: FromReflect + TypePath + MaybeTyped + RegisterForReflection, ColorGradingSection: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn into_return<'into_return>(self) -> Return<'into_return>

where &mut ColorGrading: 'into_return,

Converts Self into a Return value.

impl IntoReturn for ColorGrading

where ColorGrading: Any + Send + Sync, ColorGradingGlobal: FromReflect + TypePath + MaybeTyped + RegisterForReflection, ColorGradingSection: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn into_return<'into_return>(self) -> Return<'into_return>

where ColorGrading: 'into_return,

Converts Self into a Return value.

impl PartialReflect for ColorGrading

where ColorGrading: Any + Send + Sync, ColorGradingGlobal: FromReflect + TypePath + MaybeTyped + RegisterForReflection, ColorGradingSection: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn try_apply( &mut self, value: &(dyn PartialReflect + 'static), ) -> Result<(), ApplyError>

Tries to apply a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<ColorGrading>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn try_into_reflect( self: Box<ColorGrading>, ) -> Result<Box<dyn Reflect>, Box<dyn PartialReflect>>

Attempts to cast this type to a boxed, fully-reflected value.

fn try_as_reflect(&self) -> Option<&(dyn Reflect + 'static)>

Attempts to cast this type to a fully-reflected value.

fn try_as_reflect_mut(&mut self) -> Option<&mut (dyn Reflect + 'static)>

Attempts to cast this type to a mutable, fully-reflected value.

fn into_partial_reflect(self: Box<ColorGrading>) -> Box<dyn PartialReflect>

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &(dyn PartialReflect + 'static)

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut (dyn PartialReflect + 'static)

Casts this type to a mutable, reflected value.

fn reflect_partial_eq( &self, value: &(dyn PartialReflect + 'static), ) -> Option<bool>

Returns a “partial equality” comparison result.

fn debug(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Debug formatter for the value.

fn reflect_clone(&self) -> Result<Box<dyn Reflect>, ReflectCloneError>

Attempts to clone Self using reflection.

fn apply(&mut self, value: &(dyn PartialReflect + 'static))

Applies a reflected value to this value.

fn clone_value(&self) -> Box<dyn PartialReflect>

👎Deprecated since 0.16.0: to clone reflected values, prefer using reflect_clone. To convert reflected values to dynamic ones, use to_dynamic.

Clones Self into its dynamic representation.

fn to_dynamic(&self) -> Box<dyn PartialReflect>

Converts this reflected value into its dynamic representation based on its kind.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Reflect for ColorGrading

where ColorGrading: Any + Send + Sync, ColorGradingGlobal: FromReflect + TypePath + MaybeTyped + RegisterForReflection, ColorGradingSection: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn into_any(self: Box<ColorGrading>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &(dyn Any + 'static)

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<ColorGrading>) -> Box<dyn Reflect>

Casts this type to a boxed, fully-reflected value.

fn as_reflect(&self) -> &(dyn Reflect + 'static)

Casts this type to a fully-reflected value.

fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)

Casts this type to a mutable, fully-reflected value.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

impl Struct for ColorGrading

where ColorGrading: Any + Send + Sync, ColorGradingGlobal: FromReflect + TypePath + MaybeTyped + RegisterForReflection, ColorGradingSection: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn field(&self, name: &str) -> Option<&(dyn PartialReflect + 'static)>

Returns a reference to the value of the field named name as a &dyn PartialReflect.

fn field_mut( &mut self, name: &str, ) -> Option<&mut (dyn PartialReflect + 'static)>

Returns a mutable reference to the value of the field named name as a &mut dyn PartialReflect.

fn field_at(&self, index: usize) -> Option<&(dyn PartialReflect + 'static)>

Returns a reference to the value of the field with index index as a &dyn PartialReflect.

fn field_at_mut( &mut self, index: usize, ) -> Option<&mut (dyn PartialReflect + 'static)>

Returns a mutable reference to the value of the field with index index as a &mut dyn PartialReflect.

fn name_at(&self, index: usize) -> Option<&str>

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

fn iter_fields(&self) -> FieldIter<'_>

Returns an iterator over the values of the reflectable fields for this struct.

fn to_dynamic_struct(&self) -> DynamicStruct

fn clone_dynamic(&self) -> DynamicStruct

👎Deprecated since 0.16.0: use to_dynamic_struct instead

Clones the struct into a DynamicStruct.

fn get_represented_struct_info(&self) -> Option<&'static StructInfo>

Will return None if TypeInfo is not available.

impl TypePath for ColorGrading

where ColorGrading: Any + Send + Sync,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for ColorGrading

where ColorGrading: Any + Send + Sync, ColorGradingGlobal: FromReflect + TypePath + MaybeTyped + RegisterForReflection, ColorGradingSection: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.