Struct bevy::core_pipeline::contrast_adaptive_sharpening::ContrastAdaptiveSharpeningSettings

pub struct ContrastAdaptiveSharpeningSettings {
    pub enabled: bool,
    pub sharpening_strength: f32,
    pub denoise: bool,
}

Applies a contrast adaptive sharpening (CAS) filter to the camera.

CAS is usually used in combination with shader based anti-aliasing methods such as FXAA or TAA to regain some of the lost detail from the blurring that they introduce.

CAS is designed to adjust the amount of sharpening applied to different areas of an image based on the local contrast. This can help avoid over-sharpening areas with high contrast and under-sharpening areas with low contrast.

To use this, add the ContrastAdaptiveSharpeningSettings component to a 2D or 3D camera.

Fields

enabled: bool

Enable or disable sharpening.

sharpening_strength: f32

Adjusts sharpening strength. Higher values increase the amount of sharpening.

Clamped between 0.0 and 1.0.

The default value is 0.6.

denoise: bool

Whether to try and avoid sharpening areas that are already noisy.

You probably shouldn’t use this, and just leave it set to false. You should generally apply any sort of film grain or similar effects after CAS and upscaling to avoid artifacts.

Trait Implementations

impl Clone for ContrastAdaptiveSharpeningSettings

fn clone(&self) -> ContrastAdaptiveSharpeningSettings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for ContrastAdaptiveSharpeningSettings

where ContrastAdaptiveSharpeningSettings: Send + Sync + 'static,

type Storage = TableStorage

A marker type indicating the storage type used for this component. This must be either TableStorage or SparseStorage.

impl Default for ContrastAdaptiveSharpeningSettings

fn default() -> ContrastAdaptiveSharpeningSettings

Returns the “default value” for a type.

impl ExtractComponent for ContrastAdaptiveSharpeningSettings

type QueryData = &'static ContrastAdaptiveSharpeningSettings

ECS ReadOnlyQueryData to fetch the components to extract.

type QueryFilter = With<Camera>

Filters the entities with additional constraints.

type Out = (DenoiseCAS, CASUniform)

The output from extraction.

fn extract_component( item: <<ContrastAdaptiveSharpeningSettings as ExtractComponent>::QueryData as WorldQuery>::Item<'_> ) -> Option<<ContrastAdaptiveSharpeningSettings as ExtractComponent>::Out>

Defines how the component is transferred into the “render world”.

impl FromReflect for ContrastAdaptiveSharpeningSettings

where ContrastAdaptiveSharpeningSettings: Any + Send + Sync, bool: FromReflect + TypePath, f32: FromReflect + TypePath,

fn from_reflect( reflect: &(dyn Reflect + 'static) ) -> Option<ContrastAdaptiveSharpeningSettings>

Constructs a concrete instance of Self from a reflected value.

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

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

impl GetTypeRegistration for ContrastAdaptiveSharpeningSettings

where ContrastAdaptiveSharpeningSettings: Any + Send + Sync, bool: FromReflect + TypePath, f32: FromReflect + TypePath,

fn get_type_registration() -> TypeRegistration

impl Reflect for ContrastAdaptiveSharpeningSettings

where ContrastAdaptiveSharpeningSettings: Any + Send + Sync, bool: FromReflect + TypePath, f32: FromReflect + TypePath,

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

Returns the TypeInfo of the type represented by this value.

fn into_any(self: Box<ContrastAdaptiveSharpeningSettings>) -> 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<ContrastAdaptiveSharpeningSettings> ) -> Box<dyn Reflect>

Casts this type to a boxed reflected value.

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

Casts this type to a reflected value.

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

Casts this type to a mutable reflected value.

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

Clones the value as a Reflect trait object.

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

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

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

Applies 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<ContrastAdaptiveSharpeningSettings>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

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

Returns a “partial equality” comparison result.

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

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

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

Debug formatter for the value.

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Struct for ContrastAdaptiveSharpeningSettings

where ContrastAdaptiveSharpeningSettings: Any + Send + Sync, bool: FromReflect + TypePath, f32: FromReflect + TypePath,

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

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

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

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

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

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

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

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

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 clone_dynamic(&self) -> DynamicStruct

Clones the struct into a DynamicStruct.

impl TypePath for ContrastAdaptiveSharpeningSettings

where ContrastAdaptiveSharpeningSettings: 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 ContrastAdaptiveSharpeningSettings

where ContrastAdaptiveSharpeningSettings: Any + Send + Sync, bool: FromReflect + TypePath, f32: FromReflect + TypePath,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.