Struct LensDistortion 

pub struct LensDistortion {
    pub intensity: f32,
    pub scale: f32,
    pub multiplier: Vec2,
    pub center: Vec2,
    pub edge_curvature: f32,
}

Simulates the warping of the image caused by real-world camera lenses.

[Lens distortion] simulates the imperfections of optical systems, where straight lines in the real world appear curved in the image. This effect is commonly used to create a sense of unease or disorientation, to mimic specific camera equipment, or to enhance the scale and immersion of scenes.

Bevy’s implementation is based on a simplified special case of the Brown-Conrady model, where p₁ = p₂ = 0 and control is retained only for k1 and k2.

Fields

intensity: f32

The overall strength of the distortion effect.

Positive values typically produce barrel distortion (bulging outwards), while negative values produce pincushion distortion (pinching inwards). This corresponds roughly to the radial distortion coefficient k1 in the simplified model.

The default value is 0.5.

scale: f32

A global scale factor applied to the final distorted image.

Strong distortion pushes pixels away from the center or pulls them in, resulting in visible stretching artifacts at the screen edges. Increasing this value zooms in to crop out these extreme edge artifacts, ensuring the screen remains fully covered at the cost of a tighter field of view.

The default value is 1.0(No zoom).

multiplier: Vec2

A multiplier that determines how the distortion scales along the X and Y axes.

By default, this should be Vec2::ONE for uniform radial distortion. Modifying these values allows for anamorphic-like effects where the distortion is stronger on one axis than the other. When a component of multiplier is set to 0.0, no distortion effect is applied.

The default value is Vec2::ONE

center: Vec2

The center point of the distortion effect in UV space [0.0, 1.0].

Distortion radiates outward or inward from this point.

The default value is Vec2::splat(0.5)

edge_curvature: f32

Controls the sharpness of the distortion curve near the screen edges.

edge_curvature provides indirect control over the k2 parameter. The reason for indirect control is that k1 and k2 are typically correlated. If k2 did not vary with k1, it would easily cause visual jumping when intensity transitions from positive to negative. For a simple and natural look in most cases, we recommend setting edge_curvature to 0.0.

The default value is 0.0.

Trait Implementations

impl Clone for LensDistortion

fn clone(&self) -> LensDistortion

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for LensDistortion

where LensDistortion: 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, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

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 relationship_accessor() -> Option<ComponentRelationshipAccessor<LensDistortion>>

Returns ComponentRelationshipAccessor required for working with relationships in dynamic contexts.

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_discard() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_discard 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 Default for LensDistortion

fn default() -> LensDistortion

Returns the “default value” for a type.

impl ExtractComponent for LensDistortion

type QueryData = &'static LensDistortion

ECS ReadOnlyQueryData to fetch the components to extract.

type QueryFilter = With<LensDistortion>

Filters the entities with additional constraints.

type Out = LensDistortion

The output from extraction, i.e. ExtractComponent::extract_component.

fn extract_component( lens_distortion: <<LensDistortion as ExtractComponent>::QueryData as QueryData>::Item<'_, '_>, ) -> Option<<LensDistortion as ExtractComponent>::Out>

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

impl FromReflect for LensDistortion

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

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 GetTypeRegistration for LensDistortion

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 PartialReflect for LensDistortion

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<LensDistortion>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn try_into_reflect( self: Box<LensDistortion>, ) -> 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<LensDistortion>) -> 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 reflect_partial_cmp( &self, value: &(dyn PartialReflect + 'static), ) -> Option<Ordering>

Returns a “partial comparison” result.

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 to_dynamic(&self) -> Box<dyn PartialReflect>

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

fn reflect_clone_and_take<T>(&self) -> Result<T, ReflectCloneError>

where T: 'static, Self: Sized + TypePath,

For a type implementing PartialReflect, combines reflect_clone and take in a useful fashion, automatically constructing an appropriate ReflectCloneError if the downcast fails.

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 is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Reflect for LensDistortion

fn into_any(self: Box<LensDistortion>) -> 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<LensDistortion>) -> 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 LensDistortion

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

Gets 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)>

Gets 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)>

Gets 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)>

Gets 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>

Gets the name of the field with index index.

fn index_of_name(&self, name: &str) -> Option<usize>

Gets the index of the field with the given name.

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

Creates a new DynamicStruct from this struct.

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

Will return None if TypeInfo is not available.

impl SyncComponent for LensDistortion

type Target = LensDistortion

Describes what components should be removed from the render world if the implementing component is removed.

impl TypePath for LensDistortion

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 LensDistortion

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.