Enum cogl::FogMode

#[non_exhaustive]
pub enum FogMode {
    Linear,
    Exponential,
    ExponentialSquared,
    // some variants omitted
}

The fog mode determines the equation used to calculate the fogging blend factor while fogging is enabled. The simplest FogMode::Linear mode determines f as:

  f = end - eye_distance / end - start

Where eye_distance is the distance of the current fragment in eye coordinates from the origin.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Linear

Calculates the fog blend factor as:

  f = end - eye_distance / end - start

Exponential

Calculates the fog blend factor as:

  f = e ^ -(density * eye_distance)

ExponentialSquared

Calculates the fog blend factor as:

  f = e ^ -(density * eye_distance)^2

Trait Implementations

impl Clone for FogMode

fn clone(&self) -> FogMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for FogMode

impl Debug for FogMode

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

Formats the value using the given formatter.

impl Display for FogMode

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

Formats the value using the given formatter.

impl Eq for FogMode

impl<'a> FromValue<'a> for FogMode

unsafe fn from_value(value: &Value) -> Self

Safety

impl<'a> FromValueOptional<'a> for FogMode

unsafe fn from_value_optional(value: &Value) -> Option<Self>

Safety

impl Hash for FogMode

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for FogMode

fn cmp(&self, other: &FogMode) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<FogMode> for FogMode

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<FogMode> for FogMode

fn partial_cmp(&self, other: &FogMode) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl SetValue for FogMode

unsafe fn set_value(value: &mut Value, this: &Self)

Safety

impl StaticType for FogMode

fn static_type() -> Type

Returns the type identifier of Self.

impl StructuralEq for FogMode

impl StructuralPartialEq for FogMode