Crate light 

Modules

cascade

cluster

Spatial clustering of objects, currently just point and spot lights.

prelude

The light prelude.

Structs

AmbientLight

An ambient light, which lights the entire scene equally.

AtmosphereEnvironmentMapLight

Lets the atmosphere contribute environment lighting (reflections and ambient diffuse) to your scene.

CascadeShadowConfig

Controls how cascaded shadow mapping works. Prefer using CascadeShadowConfigBuilder to construct an instance.

CascadeShadowConfigBuilder

Builder for CascadeShadowConfig.

Cascades

ClusteredDecal

An object that projects a decal onto surfaces within its bounds.

DirectionalLight

A Directional light.

DirectionalLightShadowMap

Controls the resolution of DirectionalLight and SpotLight shadow maps.

DirectionalLightTexture

Add to a DirectionalLight to add a light texture effect. A texture mask is applied to the light source to modulate its intensity,
simulating patterns like window shadows, gobo/cookie effects, or soft falloffs.

EnvironmentMapLight

A pair of cubemap textures that represent the surroundings of a specific area in space.

FogVolume

GeneratedEnvironmentMapLight

A generated environment map that is filtered at runtime.

IrradianceVolume

The component that defines an irradiance volume.

LightPlugin

LightProbe

A marker component for a light probe, which is a cuboid region that provides global illumination to all fragments inside it.

NotShadowCaster

Add this component to make a Mesh3d not cast shadows.

NotShadowReceiver

Add this component to make a Mesh3d not receive shadows.

PointLight

A light that emits light in all directions from a central point.

PointLightShadowMap

Controls the resolution of PointLight shadow maps.

PointLightTexture

Add to a PointLight to add a light texture effect. A texture mask is applied to the light source to modulate its intensity,
simulating patterns like window shadows, gobo/cookie effects, or soft falloffs.

SpotLight

A light that emits light in a given direction from a central point.

SpotLightTexture

Add to a SpotLight to add a light texture effect. A texture mask is applied to the light source to modulate its intensity,
simulating patterns like window shadows, gobo/cookie effects, or soft falloffs.

SunDisk

Add to a DirectionalLight to control rendering of the visible solar disk in the sky. Affects only the disk’s appearance, not the light’s illuminance or shadows. Requires a bevy::pbr::Atmosphere component on a Camera3d to have any effect.

TransmittedShadowReceiver

Add this component to make a Mesh3d using a PBR material with StandardMaterial::diffuse_transmission > 0.0 receive shadows on its diffuse transmission lobe. (i.e. its “backside”)

VolumetricFog

When placed on a bevy_camera::Camera3d, enables volumetric fog and volumetric lighting, also known as light shafts or god rays.

VolumetricLight

Add this component to a DirectionalLight with a shadow map (shadows_enabled: true) to make volumetric fog interact with it.

Enums

ShadowFilteringMethod

Add this component to a Camera3d to control how to anti-alias shadow edges.

SimulationLightSystems

System sets used to run light-related systems.

Functions

check_dir_light_mesh_visibility

check_point_light_mesh_visibility

orthonormalize

Constructs a right-handed orthonormal basis from a given unit Z vector.

spot_light_clip_from_view

spot_light_world_from_view

Constructs a right-handed orthonormal basis with translation, using only the forward direction and translation of a given GlobalTransform.

update_directional_light_frusta

update_point_light_frusta

update_spot_light_frusta

Type Aliases

WithLight

A convenient alias for Or<(With<PointLight>, With<SpotLight>, With<DirectionalLight>)>, for use with bevy_camera::visibility::VisibleEntities.