Struct bevy_core_pipeline::dof::DepthOfFieldSettings

pub struct DepthOfFieldSettings {
    pub mode: DepthOfFieldMode,
    pub focal_distance: f32,
    pub sensor_height: f32,
    pub aperture_f_stops: f32,
    pub max_circle_of_confusion_diameter: f32,
    pub max_depth: f32,
}

Depth of field settings.

Fields

mode: DepthOfFieldMode

The appearance of the effect.

focal_distance: f32

The distance in meters to the location in focus.

sensor_height: f32

The height of the image sensor format in meters.

Focal length is derived from the FOV and this value. The default is 18.66mm, matching the Super 35 format, which is popular in cinema.

aperture_f_stops: f32

Along with the focal length, controls how much objects not in focus are blurred.

max_circle_of_confusion_diameter: f32

The maximum diameter, in pixels, that we allow a circle of confusion to be.

A circle of confusion essentially describes the size of a blur.

This value is nonphysical but is useful for avoiding pathologically-slow behavior.

max_depth: f32

Objects are never considered to be farther away than this distance as far as depth of field is concerned, even if they actually are.

This is primarily useful for skyboxes and background colors. The Bevy renderer considers them to be infinitely far away. Without this value, that would cause the circle of confusion to be infinitely large, capped only by the max_circle_of_confusion_diameter. As that’s unsightly, this value can be used to essentially adjust how “far away” the skybox or background are.

Implementations

impl DepthOfFieldSettings

pub fn from_physical_camera( camera: &PhysicalCameraParameters ) -> DepthOfFieldSettings

Initializes DepthOfFieldSettings from a set of PhysicalCameraParameters.

By passing the same PhysicalCameraParameters object to this function and to bevy_render::camera::Exposure::from_physical_camera, matching results for both the exposure and depth of field effects can be obtained.

All fields of the returned DepthOfFieldSettings other than focal_length and aperture_f_stops are set to their default values.

Trait Implementations

impl Clone for DepthOfFieldSettings

fn clone(&self) -> DepthOfFieldSettings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for DepthOfFieldSettings

where Self: Send + Sync + 'static,

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

A constant indicating the storage type used for this component.

fn register_component_hooks(_hooks: &mut ComponentHooks)

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

impl Default for DepthOfFieldSettings

fn default() -> Self

Returns the “default value” for a type.

impl Copy for DepthOfFieldSettings