UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FAtmosphereSetup Struct Reference

#include <SkyAtmosphereCommonData.h>

Public Member Functions

ENGINE_API FAtmosphereSetup (const USkyAtmosphereComponent &SkyAtmosphereComponent)
 
ENGINE_API FAtmosphereSetup (const FSkyAtmosphereDynamicState &Ds)
 
template<typename T >
void InternalInit (const T &SkyAtmosphereComponent)
 
ENGINE_API FLinearColor GetTransmittanceAtGroundLevel (const FVector &SunDirection) const
 
ENGINE_API void UpdateTransform (const FTransform &ComponentTransform, uint8 TranformMode)
 
ENGINE_API void ApplyWorldOffset (const FVector &InOffset)
 
ENGINE_API void ComputeViewData (const FVector &WorldCameraOrigin, const FVector &PreViewTranslation, const FVector3f &ViewForward, const FVector3f &ViewRight, FVector3f &SkyCameraTranslatedWorldOrigin, FVector4f &SkyPlanetTranslatedWorldCenterAndViewHeight, FMatrix44f &SkyViewLutReferential) const
 
uint32 GetTransmittanceAndMultiScatteringLUTsVersion () const
 

Public Attributes

FVector PlanetCenterKm
 
float BottomRadiusKm
 
float TopRadiusKm
 
float MultiScatteringFactor
 
FLinearColor RayleighScattering
 
float RayleighDensityExpScale
 
FLinearColor MieScattering
 
FLinearColor MieExtinction
 
FLinearColor MieAbsorption
 
float MieDensityExpScale
 
float MiePhaseG
 
FLinearColor AbsorptionExtinction
 
float AbsorptionDensity0LayerWidth
 
float AbsorptionDensity0ConstantTerm
 
float AbsorptionDensity0LinearTerm
 
float AbsorptionDensity1ConstantTerm
 
float AbsorptionDensity1LinearTerm
 
FLinearColor GroundAlbedo
 
float TransmittanceMinLightElevationAngle
 

Static Public Attributes

static ENGINE_API const float CmToSkyUnit = 0.00001f
 
static ENGINE_API const float SkyUnitToCm = 1.0f / 0.00001f
 

Constructor & Destructor Documentation

◆ FAtmosphereSetup() [1/2]

FAtmosphereSetup::FAtmosphereSetup ( const USkyAtmosphereComponent SkyAtmosphereComponent)

◆ FAtmosphereSetup() [2/2]

FAtmosphereSetup::FAtmosphereSetup ( const FSkyAtmosphereDynamicState Ds)

Member Function Documentation

◆ ApplyWorldOffset()

void FAtmosphereSetup::ApplyWorldOffset ( const FVector InOffset)

◆ ComputeViewData()

void FAtmosphereSetup::ComputeViewData ( const FVector WorldCameraOrigin,
const FVector PreViewTranslation,
const FVector3f ViewForward,
const FVector3f ViewRight,
FVector3f SkyCameraTranslatedWorldOrigin,
FVector4f SkyPlanetTranslatedWorldCenterAndViewHeight,
FMatrix44f SkyViewLutReferential 
) const

◆ GetTransmittanceAndMultiScatteringLUTsVersion()

uint32 FAtmosphereSetup::GetTransmittanceAndMultiScatteringLUTsVersion ( ) const
inline

◆ GetTransmittanceAtGroundLevel()

FLinearColor FAtmosphereSetup::GetTransmittanceAtGroundLevel ( const FVector SunDirection) const

◆ InternalInit()

template<typename T >
void FAtmosphereSetup::InternalInit ( const T &  SkyAtmosphereComponent)

◆ UpdateTransform()

void FAtmosphereSetup::UpdateTransform ( const FTransform ComponentTransform,
uint8  TranformMode 
)

Member Data Documentation

◆ AbsorptionDensity0ConstantTerm

float FAtmosphereSetup::AbsorptionDensity0ConstantTerm

◆ AbsorptionDensity0LayerWidth

float FAtmosphereSetup::AbsorptionDensity0LayerWidth

◆ AbsorptionDensity0LinearTerm

float FAtmosphereSetup::AbsorptionDensity0LinearTerm

◆ AbsorptionDensity1ConstantTerm

float FAtmosphereSetup::AbsorptionDensity1ConstantTerm

◆ AbsorptionDensity1LinearTerm

float FAtmosphereSetup::AbsorptionDensity1LinearTerm

◆ AbsorptionExtinction

FLinearColor FAtmosphereSetup::AbsorptionExtinction

◆ BottomRadiusKm

float FAtmosphereSetup::BottomRadiusKm

◆ CmToSkyUnit

const float FAtmosphereSetup::CmToSkyUnit = 0.00001f
static

◆ GroundAlbedo

FLinearColor FAtmosphereSetup::GroundAlbedo

◆ MieAbsorption

FLinearColor FAtmosphereSetup::MieAbsorption

◆ MieDensityExpScale

float FAtmosphereSetup::MieDensityExpScale

◆ MieExtinction

FLinearColor FAtmosphereSetup::MieExtinction

◆ MiePhaseG

float FAtmosphereSetup::MiePhaseG

◆ MieScattering

FLinearColor FAtmosphereSetup::MieScattering

◆ MultiScatteringFactor

float FAtmosphereSetup::MultiScatteringFactor

◆ PlanetCenterKm

FVector FAtmosphereSetup::PlanetCenterKm

◆ RayleighDensityExpScale

float FAtmosphereSetup::RayleighDensityExpScale

◆ RayleighScattering

FLinearColor FAtmosphereSetup::RayleighScattering

◆ SkyUnitToCm

const float FAtmosphereSetup::SkyUnitToCm = 1.0f / 0.00001f
static

◆ TopRadiusKm

float FAtmosphereSetup::TopRadiusKm

◆ TransmittanceMinLightElevationAngle

float FAtmosphereSetup::TransmittanceMinLightElevationAngle

The documentation for this struct was generated from the following files: