Struct three_d::renderer::effect::FogEffect

source · [−]

pub struct FogEffect {
    pub color: Color,
    pub density: f32,
    pub animation: f32,
    /* private fields */
}

Expand description

An effect that simulates fog, ie. the area where it is applied gets hazy when objects are far away.

Fields

color: Color

The color of the fog.

density: f32

The density of the fog.

animation: f32

Determines the variation on the density as a function of time.

Implementations

source

impl FogEffect

source

pub fn new(
 context: &Context,
 color: Color,
 density: f32,
 animation: f32
) -> ThreeDResult<FogEffect>

Constructs a new fog effect.

source

pub fn apply(
 &self,
 camera: &Camera,
 depth_texture: &DepthTargetTexture2D,
 time: f32
) -> ThreeDResult<()>

Apply the fog effect on the current render target based on the given depth map. Must be called in the callback given as input to a RenderTarget, ColorTarget or DepthTarget write method.

Auto Trait Implementations

impl !RefUnwindSafe for FogEffect

impl !Send for FogEffect

impl !Sync for FogEffect

impl Unpin for FogEffect

impl !UnwindSafe for FogEffect

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · 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 for T where
U: From<T>,

const: unstable · 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<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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

Struct three_d::renderer::effect::FogEffect

Fields

Implementations

impl FogEffect

pub fn new(
    context: &Context,
    color: Color,
    density: f32,
    animation: f32
) -> ThreeDResult<FogEffect>

pub fn apply(
    &self,
    camera: &Camera,
    depth_texture: &DepthTargetTexture2D,
    time: f32
) -> ThreeDResult<()>

Auto Trait Implementations

impl !RefUnwindSafe for FogEffect

impl !Send for FogEffect

impl !Sync for FogEffect

impl Unpin for FogEffect

impl !UnwindSafe for FogEffect

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

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

type Error = Infallible

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

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

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

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

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

Struct three_d::renderer::effect::FogEffect

Fields

Implementations

impl FogEffect

pub fn new( context: &Context, color: Color, density: f32, animation: f32) -> ThreeDResult<FogEffect>

pub fn apply( &self, camera: &Camera, depth_texture: &DepthTargetTexture2D, time: f32) -> ThreeDResult<()>

Auto Trait Implementations

impl !RefUnwindSafe for FogEffect

impl !Send for FogEffect

impl !Sync for FogEffect

impl Unpin for FogEffect

impl !UnwindSafe for FogEffect

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

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

type Error = Infallible

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

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

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

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

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

pub fn new(
context: &Context,
color: Color,
density: f32,
animation: f32
) -> ThreeDResult<FogEffect>

pub fn apply(
&self,
camera: &Camera,
depth_texture: &DepthTargetTexture2D,
time: f32
) -> ThreeDResult<()>

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

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

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

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

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

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

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