Struct AtmosphereSettings

Source

pub struct AtmosphereSettings {
    pub transmittance_lut_size: UVec2,
    pub multiscattering_lut_size: UVec2,
    pub sky_view_lut_size: UVec2,
    pub aerial_view_lut_size: UVec3,
    pub transmittance_lut_samples: u32,
    pub multiscattering_lut_dirs: u32,
    pub multiscattering_lut_samples: u32,
    pub sky_view_lut_samples: u32,
    pub aerial_view_lut_samples: u32,
    pub aerial_view_lut_max_distance: f32,
    pub scene_units_to_m: f32,
}

Expand description

This component controls the resolution of the atmosphere LUTs, and how many samples are used when computing them.

The transmittance LUT stores the transmittance from a point in the atmosphere to the outer edge of the atmosphere in any direction, parametrized by the point’s radius and the cosine of the zenith angle of the ray.

The multiscattering LUT stores the factor representing luminance scattered towards the camera with scattering order >2, parametrized by the point’s radius and the cosine of the zenith angle of the sun.

The sky-view lut is essentially the actual skybox, storing the light scattered towards the camera in every direction with a cubemap.

The aerial-view lut is a 3d LUT fit to the view frustum, which stores the luminance scattered towards the camera at each point (RGB channels), alongside the average transmittance to that point (A channel).

Fields§

§transmittance_lut_size: UVec2

The size of the transmittance LUT

§multiscattering_lut_size: UVec2

The size of the multiscattering LUT

§sky_view_lut_size: UVec2

The size of the sky-view LUT.

§aerial_view_lut_size: UVec3

The size of the aerial-view LUT.

§transmittance_lut_samples: u32

The number of points to sample along each ray when computing the transmittance LUT

§multiscattering_lut_dirs: u32

The number of rays to sample when computing each pixel of the multiscattering LUT

§multiscattering_lut_samples: u32

The number of points to sample when integrating along each multiscattering ray

§sky_view_lut_samples: u32

The number of points to sample along each ray when computing the sky-view LUT.

§aerial_view_lut_samples: u32

The number of points to sample for each slice along the z-axis of the aerial-view LUT.

§aerial_view_lut_max_distance: f32

The maximum distance from the camera to evaluate the aerial view LUT. The slices along the z-axis of the texture will be distributed linearly from the camera to this value.

units: m

§scene_units_to_m: f32

A conversion factor between scene units and meters, used to ensure correctness at different length scales.

Struct AtmosphereSettingsCopy item path

Fields§

Trait Implementations§

impl Clone for AtmosphereSettings

fn clone(&self) -> AtmosphereSettings

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

impl Component for AtmosphereSettingswhere Self: Send + Sync + 'static,

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

type Mutability = Mutable

fn register_required_components( requiree: ComponentId, components: &mut ComponentsRegistrator<'_>, required_components: &mut RequiredComponents, inheritance_depth: u16, recursion_check_stack: &mut Vec<ComponentId>, )

fn clone_behavior() -> ComponentCloneBehavior

fn register_component_hooks(hooks: &mut ComponentHooks)

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

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

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

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

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

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

impl CreateFrom for AtmosphereSettingswhere Self: ShaderType<ExtraMetadata = StructMetadata<11usize>>, for<'__, '__, '__> UVec2: CreateFrom, for<'__> UVec3: CreateFrom, for<'__, '__, '__, '__, '__> u32: CreateFrom, for<'__, '__> f32: CreateFrom,

fn create_from<B: BufferRef>(reader: &mut Reader<B>) -> Self

impl Default for AtmosphereSettings

fn default() -> Self

impl ExtractComponent for AtmosphereSettings

type QueryData = &'static AtmosphereSettings

type QueryFilter = (With<Camera3d>, With<Atmosphere>)

type Out = AtmosphereSettings

fn extract_component(item: QueryItem<'_, Self::QueryData>) -> Option<Self::Out>

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

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

fn get_type_registration() -> TypeRegistration

fn register_type_dependencies(registry: &mut TypeRegistry)

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

fn try_apply(&mut self, value: &dyn PartialReflect) -> Result<(), ApplyError>

fn reflect_kind(&self) -> ReflectKind

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

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

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

fn try_into_reflect( self: Box<Self>, ) -> Result<Box<dyn Reflect>, Box<dyn PartialReflect>>

fn try_as_reflect(&self) -> Option<&dyn Reflect>

fn try_as_reflect_mut(&mut self) -> Option<&mut dyn Reflect>

fn into_partial_reflect(self: Box<Self>) -> Box<dyn PartialReflect>

fn as_partial_reflect(&self) -> &dyn PartialReflect

fn as_partial_reflect_mut(&mut self) -> &mut dyn PartialReflect

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

fn reflect_clone(&self) -> Result<Box<dyn Reflect>, ReflectCloneError>

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

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

fn to_dynamic(&self) -> Box<dyn PartialReflect>

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

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

fn is_dynamic(&self) -> bool

impl ReadFrom for AtmosphereSettingswhere Self: ShaderType<ExtraMetadata = StructMetadata<11usize>>, for<'__, '__, '__> UVec2: ReadFrom, for<'__> UVec3: ReadFrom, for<'__, '__, '__, '__, '__> u32: ReadFrom, for<'__, '__> f32: ReadFrom,

fn read_from<B: BufferRef>(&mut self, reader: &mut Reader<B>)

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

fn as_any(&self) -> &dyn Any

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

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

fn as_reflect(&self) -> &dyn Reflect

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

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

impl ShaderSize for AtmosphereSettingswhere UVec2: ShaderSize, UVec3: ShaderSize, u32: ShaderSize, f32: ShaderSize,

const SHADER_SIZE: NonZero<u64> = _

impl ShaderType for AtmosphereSettingswhere UVec2: ShaderType + ShaderSize, UVec3: ShaderType + ShaderSize, u32: ShaderType + ShaderSize, f32: ShaderType + ShaderSize,

fn size(&self) -> NonZeroU64

fn min_size() -> NonZero<u64>

fn assert_uniform_compat()

fn field(&self, name: &str) -> Option<&dyn PartialReflect>

fn field_mut(&mut self, name: &str) -> Option<&mut dyn PartialReflect>

fn field_at(&self, index: usize) -> Option<&dyn PartialReflect>

fn field_at_mut(&mut self, index: usize) -> Option<&mut dyn PartialReflect>

fn name_at(&self, index: usize) -> Option<&str>

fn field_len(&self) -> usize

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

fn to_dynamic_struct(&self) -> DynamicStruct

fn clone_dynamic(&self) -> DynamicStruct

fn get_represented_struct_info(&self) -> Option<&'static StructInfo>

impl TypePath for AtmosphereSettingswhere AtmosphereSettings: Any + Send + Sync,

fn type_path() -> &'static str

fn short_type_path() -> &'static str

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

Struct AtmosphereSettings

impl Component for AtmosphereSettings
where Self: Send + Sync + 'static,

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

impl CreateFrom for AtmosphereSettings
where Self: ShaderType<ExtraMetadata = StructMetadata<11usize>>, for<', ', '> UVec2: CreateFrom, for<'> UVec3: CreateFrom, for<', ', ', ', '> u32: CreateFrom, for<', '__> f32: CreateFrom,

impl ReadFrom for AtmosphereSettings
where Self: ShaderType<ExtraMetadata = StructMetadata<11usize>>, for<', ', '> UVec2: ReadFrom, for<'> UVec3: ReadFrom, for<', ', ', ', '> u32: ReadFrom, for<', '__> f32: ReadFrom,

impl ShaderSize for AtmosphereSettings
where UVec2: ShaderSize, UVec3: ShaderSize, u32: ShaderSize, f32: ShaderSize,

impl ShaderType for AtmosphereSettings
where UVec2: ShaderType + ShaderSize, UVec3: ShaderType + ShaderSize, u32: ShaderType + ShaderSize, f32: ShaderType + ShaderSize,

impl TypePath for AtmosphereSettings
where AtmosphereSettings: Any + Send + Sync,

impl WriteInto for AtmosphereSettings
where Self: ShaderType<ExtraMetadata = StructMetadata<11usize>>, for<', ', '> UVec2: WriteInto, for<'> UVec3: WriteInto, for<', ', ', ', '> u32: WriteInto, for<', '__> f32: WriteInto,

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

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

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

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

impl<C> Bundle for C
where C: Component,

impl<C> BundleFromComponents for C
where C: Component,

unsafe fn from_components<T, F>(ctx: &mut T, func: &mut F) -> C
where F: for<'a> FnMut(&'a mut T) -> OwningPtr<'a>,

impl<T> CloneToUninit for T
where T: Clone,

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

impl<T> DowncastSend for T
where T: Any + Send,

impl<C> DynamicBundle for C
where C: Component,

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

impl<T> DynamicTyped for T
where T: Typed,

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

impl<S> GetField for S
where S: Struct,

fn get_field<T>(&self, name: &str) -> Option<&T>
where T: Reflect,

fn get_field_mut<T>(&mut self, name: &str) -> Option<&mut T>
where T: Reflect,

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