Struct three_d::ClearState[−][src]

pub struct ClearState {
    pub red: Option<f32>,
    pub green: Option<f32>,
    pub blue: Option<f32>,
    pub alpha: Option<f32>,
    pub depth: Option<f32>,
}
Expand description

Defines which channels (red, green, blue, alpha and depth) to clear when starting to write to a render target or the screen. If None then the channel is not cleared and if Some(value) the channel is cleared to that value (the value must be between 0 and 1).

Fields

red: Option<f32>
Expand description

Defines the clear value for the red channel.

green: Option<f32>
Expand description

Defines the clear value for the green channel.

blue: Option<f32>
Expand description

Defines the clear value for the blue channel.

alpha: Option<f32>
Expand description

Defines the clear value for the alpha channel.

depth: Option<f32>
Expand description

Defines the clear value for the depth channel. A value of 1 means a depth value equal to the far plane and 0 means a depth value equal to the near plane.

Implementations

impl ClearState[src]

pub const fn none() -> Self[src]

Nothing will be cleared.

pub const fn depth(depth: f32) -> Self[src]

The depth will be cleared to the given value.

pub const fn color(red: f32, green: f32, blue: f32, alpha: f32) -> Self[src]

The color channels (red, green, blue and alpha) will be cleared to the given values.

pub const fn color_and_depth(
    red: f32,
    green: f32,
    blue: f32,
    alpha: f32,
    depth: f32
) -> Self[src]

Both the color channels (red, green, blue and alpha) and depth will be cleared to the given values.

Trait Implementations

impl Clone for ClearState[src]

fn clone(&self) -> ClearState[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl Debug for ClearState[src]

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

Formats the value using the given formatter. Read more

impl Default for ClearState[src]

fn default() -> Self[src]

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

impl PartialEq<ClearState> for ClearState[src]

fn eq(&self, other: &ClearState) -> bool[src]

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

fn ne(&self, other: &ClearState) -> bool[src]

This method tests for !=.

impl Copy for ClearState[src]

impl StructuralPartialEq for ClearState[src]

Auto Trait Implementations

Blanket Implementations

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

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, [src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> ToOwned for T where
    T: Clone, [src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

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

pub fn clone_into(&self, target: &mut T)[src]

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

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

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

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

The type returned in the event of a conversion error.

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

Performs the conversion.