Struct bevy_render::camera::ClearColor

pub struct ClearColor(pub Color);

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 = _

pub const ANTIQUE_WHITE: Color = _

pub const AQUAMARINE: Color = _

pub const AZURE: Color = _

pub const BEIGE: Color = _

pub const BISQUE: Color = _

pub const BLACK: Color = _

pub const BLUE: Color = _

pub const CRIMSON: Color = _

pub const CYAN: Color = _

pub const DARK_GRAY: Color = _

pub const DARK_GREEN: Color = _

pub const FUCHSIA: Color = _

pub const GOLD: Color = _

pub const GRAY: Color = _

pub const GREEN: Color = _

pub const INDIGO: Color = _

pub const LIME_GREEN: Color = _

pub const MAROON: Color = _

pub const MIDNIGHT_BLUE: Color = _

pub const NAVY: Color = _

pub const NONE: Color = _

pub const OLIVE: Color = _

pub const ORANGE: Color = _

pub const ORANGE_RED: Color = _

pub const PINK: Color = _

pub const PURPLE: Color = _

pub const RED: Color = _

pub const SALMON: Color = _

pub const SEA_GREEN: Color = _

pub const SILVER: Color = _

pub const TEAL: Color = _

pub const TOMATO: Color = _

pub const TURQUOISE: Color = _

pub const VIOLET: Color = _

pub const WHITE: Color = _

pub const YELLOW: Color = _

pub const YELLOW_GREEN: Color = _

pub fn r(&self) -> f32

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

pub fn g(&self) -> f32

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

pub fn b(&self) -> f32

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

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

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

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

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

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

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

pub fn h(&self) -> f32

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

pub fn s(&self) -> f32

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

pub fn l(&self) -> f32

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

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

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

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

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

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

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

pub fn a(&self) -> f32

Get alpha.

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

Set alpha.

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());

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

Converts a Color to variant Color::Rgba

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

Converts a Color to variant Color::RgbaLinear

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

Converts a Color to variant Color::Hsla

pub fn as_lcha(self: &Color) -> 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

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

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

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

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

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

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

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

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

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.

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.

pub fn rgba_to_vec4(&self) -> Vec4

Convert Color to RGBA and return as Vec4.

pub fn rgb_to_vec3(&self) -> Vec3

Convert Color to RGBA and return as Vec3.

pub fn rgba_linear_to_vec4(&self) -> Vec4

Convert Color to linear RGBA and return as Vec4.

pub fn rgb_linear_to_vec3(&self) -> Vec3

Convert Color to linear RGBA and return as Vec3.

pub fn hsla_to_vec4(&self) -> Vec4

Convert Color to HSLA and return as Vec4.

pub fn hsl_to_vec3(&self) -> Vec3

Convert Color to HSLA and return as Vec3.

pub fn lcha_to_vec4(&self) -> Vec4

Convert Color to LCHA and return as Vec4.

pub fn lch_to_vec3(&self) -> Vec3

Convert Color to LCHA and return as Vec3.

Trait Implementations

impl Clone for ClearColor

fn clone(&self) -> ClearColor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClearColor

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

Formats the value using the given formatter.

impl Default for ClearColor

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

fn default() -> Self

Returns the “default value” for a type.

impl Deref for ClearColor

type Target = Color

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for ClearColor

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

Mutably dereferences the value.

impl ExtractResource for ClearColor

where Self: Clone,

type Source = ClearColor

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

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

impl FromReflect for ClearColor

where Self: Any + Send + Sync, Color: FromReflect + TypePath,

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

Constructs a concrete instance of Self from a reflected value.

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.

impl GetTypeRegistration for ClearColor

where Self: Any + Send + Sync, Color: FromReflect + TypePath,

fn get_type_registration() -> TypeRegistration

impl Reflect for ClearColor

where Self: Any + Send + Sync, Color: FromReflect + TypePath,

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

Returns the TypeInfo of the type represented by this value.

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

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

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

Returns the value as a &mut dyn Any.

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

Casts this type to a boxed reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a reflected value.

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

Casts this type to a mutable reflected value.

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

Clones the value as a Reflect trait object.

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

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

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

Applies a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

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

Returns an immutable enumeration of “kinds” of type.

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

Returns a mutable enumeration of “kinds” of type.

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

Returns an owned enumeration of “kinds” of type.

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

Returns a “partial equality” comparison result.

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

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

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

Debug formatter for the value.

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

Returns a serializable version of the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl TupleStruct for ClearColor

where Self: Any + Send + Sync, Color: FromReflect + TypePath,

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

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>

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 ClearColor

where Self: Any + Send + Sync,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

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

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

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

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

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

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

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for ClearColor

where Self: Any + Send + Sync, Color: FromReflect + TypePath,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Resource for ClearColor

where Self: Send + Sync + 'static,