pub struct ClearColor(pub Color);
Expand description

A Resource that stores the color that is used to clear the screen between frames.

This color appears as the “background” color for simple apps, when there are portions of the screen with nothing rendered.

Tuple Fields§

§0: Color

Methods from Deref<Target = Color>§

pub const ALICE_BLUE: Color = Color::rgb(0.94, 0.97, 1.0)

pub const ANTIQUE_WHITE: Color = Color::rgb(0.98, 0.92, 0.84)

pub const AQUAMARINE: Color = Color::rgb(0.49, 1.0, 0.83)

pub const AZURE: Color = Color::rgb(0.94, 1.0, 1.0)

pub const BEIGE: Color = Color::rgb(0.96, 0.96, 0.86)

pub const BISQUE: Color = Color::rgb(1.0, 0.89, 0.77)

pub const BLACK: Color = Color::rgb(0.0, 0.0, 0.0)

pub const BLUE: Color = Color::rgb(0.0, 0.0, 1.0)

pub const CRIMSON: Color = Color::rgb(0.86, 0.08, 0.24)

pub const CYAN: Color = Color::rgb(0.0, 1.0, 1.0)

pub const DARK_GRAY: Color = Color::rgb(0.25, 0.25, 0.25)

pub const DARK_GREEN: Color = Color::rgb(0.0, 0.5, 0.0)

pub const FUCHSIA: Color = Color::rgb(1.0, 0.0, 1.0)

pub const GOLD: Color = Color::rgb(1.0, 0.84, 0.0)

pub const GRAY: Color = Color::rgb(0.5, 0.5, 0.5)

pub const GREEN: Color = Color::rgb(0.0, 1.0, 0.0)

pub const INDIGO: Color = Color::rgb(0.29, 0.0, 0.51)

pub const LIME_GREEN: Color = Color::rgb(0.2, 0.8, 0.2)

pub const MAROON: Color = Color::rgb(0.5, 0.0, 0.0)

pub const MIDNIGHT_BLUE: Color = Color::rgb(0.1, 0.1, 0.44)

pub const NAVY: Color = Color::rgb(0.0, 0.0, 0.5)

pub const NONE: Color = Color::rgba(0.0, 0.0, 0.0, 0.0)

pub const OLIVE: Color = Color::rgb(0.5, 0.5, 0.0)

pub const ORANGE: Color = Color::rgb(1.0, 0.65, 0.0)

pub const ORANGE_RED: Color = Color::rgb(1.0, 0.27, 0.0)

pub const PINK: Color = Color::rgb(1.0, 0.08, 0.58)

pub const PURPLE: Color = Color::rgb(0.5, 0.0, 0.5)

pub const RED: Color = Color::rgb(1.0, 0.0, 0.0)

pub const SALMON: Color = Color::rgb(0.98, 0.5, 0.45)

pub const SEA_GREEN: Color = Color::rgb(0.18, 0.55, 0.34)

pub const SILVER: Color = Color::rgb(0.75, 0.75, 0.75)

pub const TEAL: Color = Color::rgb(0.0, 0.5, 0.5)

pub const TOMATO: Color = Color::rgb(1.0, 0.39, 0.28)

pub const TURQUOISE: Color = Color::rgb(0.25, 0.88, 0.82)

pub const VIOLET: Color = Color::rgb(0.93, 0.51, 0.93)

pub const WHITE: Color = Color::rgb(1.0, 1.0, 1.0)

pub const YELLOW: Color = Color::rgb(1.0, 1.0, 0.0)

pub const YELLOW_GREEN: Color = Color::rgb(0.6, 0.8, 0.2)

pub fn r(&self) -> f32

Get red in sRGB colorspace.

pub fn g(&self) -> f32

Get green in sRGB colorspace.

pub fn b(&self) -> f32

Get blue in sRGB colorspace.

pub fn set_r(&mut self, r: f32) -> &mut Color

Set red in sRGB colorspace.

pub fn set_g(&mut self, g: f32) -> &mut Color

Set green in sRGB colorspace.

pub fn set_b(&mut self, b: f32) -> &mut Color

Set blue in sRGB colorspace.

pub fn a(&self) -> f32

Get alpha.

pub fn set_a(&mut self, a: f32) -> &mut Color

Set alpha.

pub fn as_rgba(&self) -> Color

Converts a Color to variant Color::Rgba

pub fn as_rgba_linear(&self) -> Color

Converts a Color to variant Color::RgbaLinear

pub fn as_hsla(&self) -> Color

Converts a Color to variant Color::Hsla

pub fn as_lcha(&self) -> Color

Converts a Color to variant Color::Lcha

pub fn as_rgba_u8(&self) -> [u8; 4]

Converts a Color to a [u8; 4] from sRGB colorspace

Trait Implementations§

§

impl Clone for ClearColor

§

fn clone(&self) -> ClearColor

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
§

impl Debug for ClearColor

§

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

Formats the value using the given formatter. Read more
§

impl Default for ClearColor

§

fn default() -> ClearColor

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

impl Deref for ClearColor

§

type Target = Color

The resulting type after dereferencing.
§

fn deref(&self) -> &<ClearColor as Deref>::Target

Dereferences the value.
§

impl DerefMut for ClearColor

§

fn deref_mut(&mut self) -> &mut <ClearColor as Deref>::Target

Mutably dereferences the value.
§

impl ExtractResource for ClearColorwhere ClearColor: Clone,

§

type Source = ClearColor

§

fn extract_resource( source: &<ClearColor as ExtractResource>::Source ) -> ClearColor

Defines how the resource is transferred into the “render world”.
§

impl FromReflect for ClearColorwhere Color: FromReflect,

§

fn from_reflect(reflect: &(dyn Reflect + 'static)) -> Option<ClearColor>

Constructs a concrete instance of Self from a reflected value.
§

fn take_from_reflect( reflect: Box<dyn Reflect, Global> ) -> Result<Self, Box<dyn Reflect, Global>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails. Read more
§

impl GetTypeRegistration for ClearColorwhere Color: FromReflect,

§

impl Reflect for ClearColorwhere Color: FromReflect,

§

fn type_name(&self) -> &str

Returns the type name of the underlying type.
§

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value. Read more
§

fn into_any(self: Box<ClearColor, Global>) -> Box<dyn Any, Global>

Returns the value as a Box<dyn Any>.
§

fn as_any(&self) -> &(dyn Any + 'static)

Returns the value as a &dyn Any.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Returns the value as a &mut dyn Any.
§

fn into_reflect(self: Box<ClearColor, Global>) -> Box<dyn Reflect, Global>

Casts this type to a boxed reflected value.
§

fn as_reflect(&self) -> &(dyn Reflect + 'static)

Casts this type to a reflected value.
§

fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)

Casts this type to a mutable reflected value.
§

fn clone_value(&self) -> Box<dyn Reflect, Global>

Clones the value as a Reflect trait object. Read more
§

fn set( &mut self, value: Box<dyn Reflect, Global> ) -> Result<(), Box<dyn Reflect, Global>>

Performs a type-checked assignment of a reflected value to this value. Read more
§

fn apply(&mut self, value: &(dyn Reflect + 'static))

Applies a reflected value to this value. Read more
§

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an enumeration of “kinds” of type. Read more
§

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type. Read more
§

fn reflect_owned(self: Box<ClearColor, Global>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type. Read more
§

fn reflect_partial_eq(&self, value: &(dyn Reflect + 'static)) -> Option<bool>

Returns a “partial equality” comparison result. Read more
§

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type). Read more
§

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

Debug formatter for the value. Read more
§

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value. Read more
§

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type. Read more
§

impl TupleStruct for ClearColorwhere Color: FromReflect,

§

fn field(&self, index: usize) -> Option<&(dyn Reflect + 'static)>

Returns a reference to the value of the field with index index as a &dyn Reflect.
§

fn field_mut(&mut self, index: usize) -> Option<&mut (dyn Reflect + 'static)>

Returns a mutable reference to the value of the field with index index as a &mut dyn Reflect.
§

fn field_len(&self) -> usize

Returns the number of fields in the tuple struct.
§

fn iter_fields(&self) -> TupleStructFieldIter<'_>

Returns an iterator over the values of the tuple struct’s fields.
§

fn clone_dynamic(&self) -> DynamicTupleStruct

Clones the struct into a DynamicTupleStruct.
§

impl TypePath for ClearColorwhere Color: FromReflect,

§

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type. Read more
§

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type. Read more
§

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous. Read more
§

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous. Read more
§

fn module_path() -> Option<&'static str>

Returns the path to the moudle the type is in, or None if it is anonymous. Read more
§

impl Typed for ClearColorwhere Color: FromReflect,

§

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.
§

impl Resource for ClearColorwhere ClearColor: Send + Sync + 'static,

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T, U> AsBindGroupShaderType<U> for Twhere U: ShaderType, &'a T: for<'a> Into<U>,

§

fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U

Return the T ShaderType for self. When used in AsBindGroup derives, it is safe to assume that all images in self exist.
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

§

impl<T> Downcast for Twhere T: Any,

§

fn into_any(self: Box<T, Global>) -> Box<dyn Any, Global>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSync for Twhere T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
§

impl<T> DynamicTypePath for Twhere T: TypePath,

source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<S> FromSample<S> for S

§

fn from_sample_(s: S) -> S

§

impl<T> FromWorld for Twhere T: Default,

§

fn from_world(_world: &mut World) -> T

Creates Self using data from the given World
§

impl<T> GetPath for Twhere T: Reflect,

§

fn reflect_path<'r, 'p>( &'r self, path: &'p str ) -> Result<&'r (dyn Reflect + 'static), ReflectPathError<'p>>

Returns a reference to the value specified by path. Read more
§

fn reflect_path_mut<'r, 'p>( &'r mut self, path: &'p str ) -> Result<&'r mut (dyn Reflect + 'static), ReflectPathError<'p>>

Returns a mutable reference to the value specified by path. Read more
§

fn path<T, 'r, 'p>( &'r self, path: &'p str ) -> Result<&'r T, ReflectPathError<'p>>where T: Reflect,

Returns a statically typed reference to the value specified by path. Read more
§

fn path_mut<T, 'r, 'p>( &'r mut self, path: &'p str ) -> Result<&'r mut T, ReflectPathError<'p>>where T: Reflect,

Returns a statically typed mutable reference to the value specified by path. Read more
§

impl<S> GetTupleStructField for Swhere S: TupleStruct,

§

fn get_field<T>(&self, index: usize) -> Option<&T>where T: Reflect,

Returns a reference to the value of the field with index index, downcast to T.
§

fn get_field_mut<T>(&mut self, index: usize) -> Option<&mut T>where T: Reflect,

Returns a mutable reference to the value of the field with index index, downcast to T.
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<U> for Twhere U: From<T>,

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> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

fn clone_into(&self, target: &mut T)

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

impl<T, U> ToSample<U> for Twhere U: FromSample<T>,

§

fn to_sample_(self) -> U

source§

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
§

impl<T> TypeData for Twhere T: 'static + Send + Sync + Clone,

§

impl<T> Upcast<T> for T

§

fn upcast(&self) -> Option<&T>

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
§

impl<S, T> Duplex<S> for Twhere T: FromSample<S> + ToSample<S>,