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>§

source

pub const ALICE_BLUE: Color = _

source

pub const ANTIQUE_WHITE: Color = _

source

pub const AQUAMARINE: Color = _

source

pub const AZURE: Color = _

source

pub const BEIGE: Color = _

source

pub const BISQUE: Color = _

source

pub const BLACK: Color = _

source

pub const BLUE: Color = _

source

pub const CRIMSON: Color = _

source

pub const CYAN: Color = _

source

pub const DARK_GRAY: Color = _

source

pub const DARK_GREEN: Color = _

source

pub const FUCHSIA: Color = _

source

pub const GOLD: Color = _

source

pub const GRAY: Color = _

source

pub const GREEN: Color = _

source

pub const INDIGO: Color = _

source

pub const LIME_GREEN: Color = _

source

pub const MAROON: Color = _

source

pub const MIDNIGHT_BLUE: Color = _

source

pub const NAVY: Color = _

source

pub const NONE: Color = _

source

pub const OLIVE: Color = _

source

pub const ORANGE: Color = _

source

pub const ORANGE_RED: Color = _

source

pub const PINK: Color = _

source

pub const PURPLE: Color = _

source

pub const RED: Color = _

source

pub const SALMON: Color = _

source

pub const SEA_GREEN: Color = _

source

pub const SILVER: Color = _

source

pub const TEAL: Color = _

source

pub const TOMATO: Color = _

source

pub const TURQUOISE: Color = _

source

pub const VIOLET: Color = _

source

pub const WHITE: Color = _

source

pub const YELLOW: Color = _

source

pub const YELLOW_GREEN: Color = _

source

pub fn r(&self) -> f32

Converts a Color to variant Color::Rgba and return red in sRGB colorspace

source

pub fn g(&self) -> f32

Converts a Color to variant Color::Rgba and return green in sRGB colorspace

source

pub fn b(&self) -> f32

Converts a Color to variant Color::Rgba and return blue in sRGB colorspace

source

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

Converts a Color to variant Color::Rgba and set red

source

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

Converts a Color to variant Color::Rgba and set green

source

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

Converts a Color to variant Color::Rgba and set blue

source

pub fn h(&self) -> f32

Converts a Color to variant Color::Hsla and return hue

source

pub fn s(&self) -> f32

Converts a Color to variant Color::Hsla and return saturation

source

pub fn l(&self) -> f32

Converts a Color to variant Color::Hsla and return lightness

source

pub fn set_h(&mut self, h: f32) -> &mut Self

Converts a Color to variant Color::Hsla and set hue

source

pub fn set_s(&mut self, s: f32) -> &mut Self

Converts a Color to variant Color::Hsla and set saturation

source

pub fn set_l(&mut self, l: f32) -> &mut Self

Converts a Color to variant Color::Hsla and set lightness

source

pub fn a(&self) -> f32

Get alpha.

source

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

Set alpha.

source

pub fn is_fully_transparent(&self) -> bool

Determine if the color is fully transparent, i.e. if the alpha is 0.

Examples
// Fully transparent colors
assert!(Color::NONE.is_fully_transparent());
assert!(Color::rgba(1.0, 0.5, 0.5, 0.0).is_fully_transparent());

// (Partially) opaque colors
assert!(!Color::BLACK.is_fully_transparent());
assert!(!Color::rgba(1.0, 0.5, 0.5, 0.2).is_fully_transparent());
source

pub fn as_rgba(self: &Color) -> Color

Converts a Color to variant Color::Rgba

source

pub fn as_rgba_linear(self: &Color) -> Color

Converts a Color to variant Color::RgbaLinear

source

pub fn as_hsla(self: &Color) -> Color

Converts a Color to variant Color::Hsla

source

pub fn as_lcha(self: &Color) -> Color

Converts a Color to variant Color::Lcha

source

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

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

source

pub fn as_rgba_f32(self: Color) -> [f32; 4]

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

source

pub fn as_linear_rgba_f32(self: Color) -> [f32; 4]

Converts a Color to a [f32; 4] from linear RGB colorspace

source

pub fn as_hsla_f32(self: Color) -> [f32; 4]

Converts a Color to a [f32; 4] from HSL colorspace

source

pub fn as_lcha_f32(self: Color) -> [f32; 4]

Converts a Color to a [f32; 4] from LCH colorspace

source

pub fn as_rgba_u32(self: Color) -> u32

Converts Color to a u32 from sRGB colorspace.

Maps the RGBA channels in RGBA order to a little-endian byte array (GPUs are little-endian). A will be the most significant byte and R the least significant.

source

pub fn as_linear_rgba_u32(self: Color) -> u32

Converts Color to a u32 from linear RGB colorspace.

Maps the RGBA channels in RGBA order to a little-endian byte array (GPUs are little-endian). A will be the most significant byte and R the least significant.

source

pub fn rgba_to_vec4(&self) -> Vec4

Convert Color to RGBA and return as Vec4.

source

pub fn rgb_to_vec3(&self) -> Vec3

Convert Color to RGBA and return as Vec3.

source

pub fn rgba_linear_to_vec4(&self) -> Vec4

Convert Color to linear RGBA and return as Vec4.

source

pub fn rgb_linear_to_vec3(&self) -> Vec3

Convert Color to linear RGBA and return as Vec3.

source

pub fn hsla_to_vec4(&self) -> Vec4

Convert Color to HSLA and return as Vec4.

source

pub fn hsl_to_vec3(&self) -> Vec3

Convert Color to HSLA and return as Vec3.

source

pub fn lcha_to_vec4(&self) -> Vec4

Convert Color to LCHA and return as Vec4.

source

pub fn lch_to_vec3(&self) -> Vec3

Convert Color to LCHA and return as Vec3.

Trait Implementations§

source§

impl Clone for ClearColor

source§

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
source§

impl Debug for ClearColor

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for ClearColor

Match the dark gray bevy website code block color by default.

source§

fn default() -> Self

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

impl Deref for ClearColor

§

type Target = Color

The resulting type after dereferencing.
source§

fn deref(&self) -> &Self::Target

Dereferences the value.
source§

impl DerefMut for ClearColor

source§

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.
source§

impl ExtractResource for ClearColor
where Self: Clone,

§

type Source = ClearColor

source§

fn extract_resource(source: &Self::Source) -> Self

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

impl FromReflect for ClearColor
where Self: Any + Send + Sync, Color: FromReflect + TypePath,

source§

fn from_reflect(reflect: &dyn Reflect) -> Option<Self>

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

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

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

impl GetTypeRegistration for ClearColor
where Self: Any + Send + Sync, Color: FromReflect + TypePath,

source§

impl Reflect for ClearColor
where Self: Any + Send + Sync, Color: FromReflect + TypePath,

source§

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

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

fn into_any(self: Box<Self>) -> Box<dyn Any>

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

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.
source§

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.
source§

fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>

Casts this type to a boxed reflected value.
source§

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a reflected value.
source§

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

Casts this type to a mutable reflected value.
source§

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

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

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

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

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

Applies a reflected value to this value. Read more
source§

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type. Read more
source§

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

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

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

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

fn reflect_owned(self: Box<Self>) -> ReflectOwned

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

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

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

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

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

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

Debug formatter for the value. Read more
source§

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

Returns a serializable version of the value. Read more
source§

fn is_dynamic(&self) -> bool

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

impl TupleStruct for ClearColor
where Self: Any + Send + Sync, Color: FromReflect + TypePath,

source§

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

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

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

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

fn field_len(&self) -> usize

Returns the number of fields in the tuple struct.
source§

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

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

fn clone_dynamic(&self) -> DynamicTupleStruct

Clones the struct into a DynamicTupleStruct.
source§

impl TypePath for ClearColor
where Self: Any + Send + Sync,

source§

fn type_path() -> &'static str

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

fn short_type_path() -> &'static str

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

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

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

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

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

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

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

impl Typed for ClearColor
where Self: Any + Send + Sync, Color: FromReflect + TypePath,

source§

fn type_info() -> &'static TypeInfo

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

impl Resource for ClearColor
where Self: Send + Sync + 'static,

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

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 T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> Downcast<T> for T

source§

fn downcast(&self) -> &T

source§

impl<T> Downcast for T
where T: Any,

source§

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

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.
source§

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.
source§

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.
source§

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.
source§

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

source§

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.
source§

impl<T> DynamicTypePath for T
where T: TypePath,

source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> FromWorld for T
where T: Default,

source§

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

Creates Self using data from the given World.
source§

impl<T> GetPath for T
where T: Reflect + ?Sized,

source§

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

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

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

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

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

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

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

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

impl<S> GetTupleStructField for S
where S: TupleStruct,

source§

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.
source§

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 T
where 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 T
where 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
source§

impl<T, U> TryFrom<U> for T
where 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 T
where 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.
source§

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

source§

impl<T> Upcast<T> for T

source§

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
source§

impl<T> Settings for T
where T: 'static + Send + Sync,

source§

impl<T> WasmNotSend for T
where T: Send,

source§

impl<T> WasmNotSendSync for T

source§

impl<T> WasmNotSync for T
where T: Sync,