Struct SunDisk 

pub struct SunDisk {
    pub angular_size: f32,
    pub intensity: f32,
}

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.

By default, the atmosphere is rendered with SunDisk::EARTH, which approximates the apparent size and brightness of the Sun as seen from Earth. You can also disable the sun disk entirely with SunDisk::OFF.

In order to cause the sun to “glow” and light up the surrounding sky, enable bloom in your post-processing pipeline by adding a Bloom component to your camera.

Fields

angular_size: f32

The angular size (diameter) of the sun disk in radians, as observed from the scene.

intensity: f32

Multiplier for the brightness of the sun disk.

0.0 disables the disk entirely (atmospheric scattering still occurs), 1.0 is the default physical intensity, and values >1.0 overexpose it.

Implementations

impl SunDisk

pub const EARTH: SunDisk

Earth-like parameters for the sun disk.

Uses the mean apparent size (~32 arcminutes) of the Sun at 1 AU distance with default intensity.

pub const OFF: SunDisk

No visible sun disk.

Keeps scattering and directional light illumination, but hides the disk itself.

Trait Implementations

impl Clone for SunDisk

fn clone(&self) -> SunDisk

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for SunDisk

where SunDisk: Send + Sync + 'static,

Required Components: DirectionalLight.

A component’s Required Components are inserted whenever it is inserted. Note that this will also insert the required components of the required components, recursively, in depth-first order.

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have Component<Mutability = Mutable>, while immutable components will instead have Component<Mutability = Immutable>.

fn register_required_components( _requiree: ComponentId, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add ComponentHook for this Component if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert ComponentHook for this Component if one is defined.

fn on_replace() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_replace ComponentHook for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove ComponentHook for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn ComponentHook for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]

impl Default for &SunDisk

fn default() -> &SunDisk

Returns the “default value” for a type.

impl Default for SunDisk

fn default() -> SunDisk

Returns the “default value” for a type.