Struct three_d::renderer::effect::FogEffect

pub struct FogEffect {
    pub color: Srgba,
    pub density: f32,
    pub animation: f32,
    pub time: f32,
}

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

Fields

color: Srgba

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.

time: f32

The time used for the animation.

Implementations

impl FogEffect

pub fn apply( &self, context: &Context, time: f64, camera: &Camera, depth_texture: DepthTexture<'_> )

👎Deprecated: use apply_screen_effect instead

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

Trait Implementations

impl Clone for FogEffect

fn clone(&self) -> FogEffect

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FogEffect

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

Formats the value using the given formatter.

impl Default for FogEffect

fn default() -> Self

Returns the “default value” for a type.

impl Effect for FogEffect

fn fragment_shader_source( &self, _lights: &[&dyn Light], color_texture: Option<ColorTexture<'_>>, depth_texture: Option<DepthTexture<'_>> ) -> String

Returns the fragment shader source for this effect.

fn id( &self, color_texture: Option<ColorTexture<'_>>, depth_texture: Option<DepthTexture<'_>> ) -> u16

Returns a unique ID for each variation of the shader source returned from Effect::fragment_shader_source.

fn fragment_attributes(&self) -> FragmentAttributes

Returns a FragmentAttributes struct that describes which fragment attributes, ie. the input from the vertex shader, are required for rendering with this effect.

fn use_uniforms( &self, program: &Program, camera: &Camera, _lights: &[&dyn Light], color_texture: Option<ColorTexture<'_>>, depth_texture: Option<DepthTexture<'_>> )

Sends the uniform data needed for this effect to the fragment shader.

fn render_states(&self) -> RenderStates

Returns the render states needed to render with this effect.