Struct bevy::prelude::EnvironmentMapLight

pub struct EnvironmentMapLight {
    pub diffuse_map: Handle<Image>,
    pub specular_map: Handle<Image>,
}

Environment map based ambient lighting representing light from distant scenery.

When added to a 3D camera, this component adds indirect light to every point of the scene (including inside, enclosed areas) based on an environment cubemap texture. This is similar to crate::AmbientLight, but higher quality, and is intended for outdoor scenes.

The environment map must be prefiltered into a diffuse and specular cubemap based on the split-sum approximation.

To prefilter your environment map, you can use KhronosGroup’s glTF-IBL-Sampler. The diffuse map uses the Lambertian distribution, and the specular map uses the GGX distribution.

KhronosGroup also has several prefiltered environment maps that can be found here.

Fields

diffuse_map: Handle<Image>

specular_map: Handle<Image>

Implementations

impl EnvironmentMapLight

pub fn is_loaded(&self, images: &RenderAssets<Image>) -> bool

Whether or not all textures necessary to use the environment map have been loaded by the asset server.

Trait Implementations

impl Clone for EnvironmentMapLight

fn clone(&self) -> EnvironmentMapLight

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for EnvironmentMapLightwhere EnvironmentMapLight: Send + Sync + 'static,

type Storage = TableStorage

A marker type indicating the storage type used for this component. This must be either TableStorage or SparseStorage.

impl ExtractComponent for EnvironmentMapLightwhere EnvironmentMapLight: Clone,

type Query = &'static EnvironmentMapLight

ECS ReadOnlyWorldQueryData to fetch the components to extract.

type Filter = With<Camera3d>

Filters the entities with additional constraints.

type Out = EnvironmentMapLight

The output from extraction.

fn extract_component( item: <<EnvironmentMapLight as ExtractComponent>::Query as WorldQuery>::Item<'_> ) -> Option<<EnvironmentMapLight as ExtractComponent>::Out>

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

impl FromReflect for EnvironmentMapLightwhere Handle<Image>: FromReflect,

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

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.

impl GetTypeRegistration for EnvironmentMapLightwhere Handle<Image>: FromReflect,

fn get_type_registration() -> TypeRegistration

impl Reflect for EnvironmentMapLightwhere Handle<Image>: FromReflect,

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

Returns the TypeInfo of the type represented by this value.

fn into_any(self: Box<EnvironmentMapLight, 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<EnvironmentMapLight, 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.

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.

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

Applies a reflected value to this value.

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

Returns an enumeration of “kinds” of type.

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

Returns a mutable enumeration of “kinds” of type.

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

Returns an owned enumeration of “kinds” of type.

fn reflect_partial_eq(&self, value: &(dyn Reflect + 'static)) -> 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 Struct for EnvironmentMapLightwhere Handle<Image>: FromReflect,

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

Returns a reference to the value of the field named name as a &dyn Reflect.

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

Returns a mutable reference to the value of the field named name as a &mut dyn Reflect.

fn field_at(&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_at_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 name_at(&self, index: usize) -> Option<&str>

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

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

Returns an iterator over the values of the reflectable fields for this struct.

fn clone_dynamic(&self) -> DynamicStruct

Clones the struct into a DynamicStruct.

impl TypePath for EnvironmentMapLightwhere Handle<Image>: FromReflect,

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 EnvironmentMapLightwhere Handle<Image>: FromReflect,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.