Skip to main content

ToneMappingSettings

Struct ToneMappingSettings 

Source
pub struct ToneMappingSettings {
    pub mode: ToneMappingMode,
    pub lut_texture: Option<TextureHandle>,
    /* private fields */
}
Expand description

Tone mapping configuration.

This struct holds all parameters for the tone mapping post-processing pass. Changes to uniforms are tracked via CpuBuffer’s internal version for efficient GPU sync.

§Usage

// Get settings from scene
let settings = &mut scene.tone_mapping;

// Modify parameters (automatically updates version)
settings.set_exposure(1.5);
settings.set_mode(ToneMappingMode::ACESFilmic);

Fields§

§mode: ToneMappingMode

Selected tone mapping algorithm

§lut_texture: Option<TextureHandle>

Exposure multiplier (default: 1.0) Optional 3D LUT texture handle. When Some, the USE_LUT shader macro is enabled and the pipeline is recompiled. When None, no LUT is applied.

Implementations§

Source§

impl ToneMappingSettings

Source

pub fn new() -> ToneMappingSettings

Creates new tone mapping settings with default values.

Source

pub fn uniforms(&self) -> BufferReadGuard<'_, ToneMappingUniforms>

Source

pub fn uniforms_mut(&mut self) -> BufferGuard<'_, ToneMappingUniforms>

Source

pub fn set_mode(&mut self, mode: ToneMappingMode)

Sets the tone mapping mode.

Only updates the mode if the value actually changed.

Source

pub fn set_exposure(&mut self, exposure: f32)

Sets the exposure value.

Source

pub fn set_contrast(&mut self, contrast: f32)

Sets the contrast adjustment.

Source

pub fn set_saturation(&mut self, saturation: f32)

Sets the saturation adjustment.

Source

pub fn set_chromatic_aberration(&mut self, intensity: f32)

Sets the chromatic aberration intensity.

Source

pub fn set_film_grain(&mut self, intensity: f32)

Sets the film grain intensity.

Source

pub fn set_vignette_intensity(&mut self, intensity: f32)

Sets the vignette intensity.

A value of 0.0 disables the vignette effect.

Source

pub fn set_vignette_smoothness(&mut self, smoothness: f32)

Sets the vignette smoothness.

Controls how quickly the darkening falls off from the edges. Recommended range: 0.1 ~ 1.0. Default is 0.5 for a balanced look.

Source

pub fn set_vignette_color(&mut self, color: Vec4)

Sets the vignette color. This is the color used for the vignette effect (default: black with full alpha).

Source

pub fn set_lut_texture(&mut self, lut: Option<TextureHandle>)

Sets the 3D LUT texture for color grading.

Pass Some(handle) to enable LUT-based color grading, or None to disable it. Changing this triggers a pipeline rebuild (shader macro change).

Source

pub fn set_lut_contribution(&mut self, contribution: f32)

Sets the LUT contribution weight.

0.0 = original color, 1.0 = fully LUT-graded.

Source

pub fn has_lut(&self) -> bool

Returns whether a LUT texture is currently set.

Source

pub fn exposure(&self) -> f32

Returns the current exposure value.

Source

pub fn vignette_intensity(&self) -> f32

Returns the current vignette intensity.

Source

pub fn mode(&self) -> ToneMappingMode

Returns the current tone mapping mode.

Source

pub fn contrast(&self) -> f32

Returns the current contrast value.

Source

pub fn saturation(&self) -> f32

Returns the current saturation value.

Source

pub fn chromatic_aberration(&self) -> f32

Returns the current chromatic aberration intensity.

Source

pub fn film_grain(&self) -> f32

Returns the current film grain intensity.

Source

pub fn vignette_smoothness(&self) -> f32

Returns the current vignette smoothness.

Source

pub fn vignette_color(&self) -> Vec4

Returns the current vignette color.

Source

pub fn lut_contribution(&self) -> f32

Returns the current LUT contribution.

Trait Implementations§

Source§

impl Clone for ToneMappingSettings

Source§

fn clone(&self) -> ToneMappingSettings

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ToneMappingSettings

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ToneMappingSettings

Source§

fn default() -> ToneMappingSettings

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> Downcast for T
where T: Any,

Source§

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

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

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

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

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

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,