Struct web_glitz::pipeline::graphics::DepthRange

pub struct DepthRange { /* fields omitted */ }

Defines how a fragment's depth output will be mapped onto the range 0.0..1.0 from the near plane at 0.0 to the far plane at 1.0.

• Values smaller than the lower bound will be mapped to 0.0.
• Values greater than the upper bound will be mapped to 1.0.
• Values contained on the range will be mapped to the range 0.0..1.0.

Can be constructed from a [RangeInclusive] via TryFrom:

use std::convert::TryFrom;
use web_glitz::pipeline::graphics::DepthRange;

let depth_range = DepthRange::try_from(0.2..=0.8).unwrap();

The lower bound of the range must not be smaller than 0.0, the upper bound of the range must not be greater than 1.0, and the lower bound must be strictly smaller than the upper bound; otherwise, an [InvalidDepthRange] error is returned.

A default depth range may be obtained through Default:

use std::convert::TryFrom;
use web_glitz::pipeline::graphics::DepthRange;

assert_eq!(DepthRange::default(), DepthRange::try_from(0.0..=1.0).unwrap());

Implementations

impl DepthRange

pub fn near(&self) -> f32

The lower bound of this range that will be mapped onto the near plane at 0.0.

pub fn far(&self) -> f32

The upper bound of this range that will be mapped onto the far plane at 1.0.

Trait Implementations

impl Clone for DepthRange

fn clone(&self) -> DepthRange

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DepthRange

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

Formats the value using the given formatter.

impl Default for DepthRange

fn default() -> Self

Returns the "default value" for a type.

impl PartialEq<DepthRange> for DepthRange

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

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

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

This method tests for !=.

impl StructuralPartialEq for DepthRange

impl TryFrom<RangeInclusive<f32>> for DepthRange

type Error = InvalidDepthRange

The type returned in the event of a conversion error.

fn try_from(range: RangeInclusive<f32>) -> Result<Self, Self::Error>

Performs the conversion.