Struct Settings 

pub struct Settings {
    pub defocus_mode: i32,
    pub circle_of_confusion: Settings,
    pub show_image: bool,
    pub camera_max_size: f32,
    pub use_camera_focal: bool,
    pub use_direct_math: bool,
    pub focal_plane_offset: f32,
    pub size_multiplier: f32,
    pub proxy_scale: Option<f32>,
    pub gamma_correction: f32,
}

Settings that define the defocus calculation.

Fields

defocus_mode: i32

Render 2d or use depth

circle_of_confusion: Settings

Circle of confusion settings

show_image: bool

Flag indicating whether to show the image

camera_max_size: f32

Maximum size for camera-based defocus

use_camera_focal: bool

Flag indicating whether to use camera focal distance

use_direct_math: bool

Flag indicating wheter to directly use the input depth

focal_plane_offset: f32

Flag indicating whether to use camera focal distance

size_multiplier: f32

Size multiplier for defocus

proxy_scale: Option<f32>

Proxy scale factor

gamma_correction: f32

Gamma correction to boost bokehs

Implementations

impl Settings

pub fn defocus_mode(&self) -> DefocusMode

Returns the enum value of defocus_mode, or the default if the field is set to an invalid enum value.

pub fn set_defocus_mode(&mut self, value: DefocusMode)

Sets defocus_mode to the provided enum value.

pub fn proxy_scale(&self) -> f32

Returns the value of proxy_scale, or the default value if proxy_scale is unset.

impl Settings

pub fn get_size(&self) -> f32

Calculate the effective defocus size.

pub fn get_raw_max_size(&self) -> f32

pub fn get_max_size(&self) -> f32

Calculate the maximum defocus size based on the current mode.

pub fn get_math(&self) -> Math

Determines the math interpretation of depth.

pub fn get_current_max_size(&self) -> f32

Gets the current maximum size for defocus.

pub fn get_padding(&self) -> u32

Calculate the padding required for rendering.

Trait Implementations

impl Clone for Settings

fn clone(&self) -> Settings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Settings

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

Formats the value using the given formatter.

impl Default for Settings

fn default() -> Self

Returns the “default value” for a type.

impl Message for Settings

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Settings

fn eq(&self, other: &Settings) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Settings

impl StructuralPartialEq for Settings