Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > Components > UVolumetricCloudComponent

Light Theme

Dark Theme

UVolumetricCloudComponent

A component that represents a participating media material around a planet, e.g. clouds.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

USceneComponent

UVolumetricCloudComponent

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/Components/VolumetricCloudComponent.h
Include	#include "Components/VolumetricCloudComponent.h"

Syntax

class UVolumetricCloudComponent : public USceneComponent

Remarks

A component that represents a participating media material around a planet, e.g. clouds.

Variables

	Name	Description
uint32: 1	bUsePerSampleAtmosphericLightTransmittance	Whether to apply atmosphere transmittance per sample, instead of using the light global transmittance.
FColor	GroundAlbedo	The ground albedo used to light the cloud from below with respect to the sun light and sky atmosphere.
float	LayerBottomAltitude	The altitude at which the cloud layer starts. (kilometers above the ground)
float	LayerHeight	The altitude at which the cloud layer ends. (kilometers above the ground)
UMaterialInterf...	Material	The material describing the cloud volume. It must be a Volume domain material.
float	PlanetRadius	The planet radius used when there is not SkyAtmosphere component present in the scene.
float	ReflectionSampleCountScale	Scale the tracing sample count in reflection views.
float	ShadowReflectionSampleCountScale	Scale the shadow tracing sample count in reflection views, only used with Advanced Output ray marched shadows.
float	ShadowTracingDistance	The shadow tracing distance in kilometers, only used with Advanced Output ray marched shadows.
float	ShadowViewSampleCountScale	Scale the shadow tracing sample count in primary views, only used with Advanced Output ray marched shadows.
float	SkyLightCloudBottomOcclusion	BUsePerSampleAtmosphericLightTransmittance is there on the cloud component and not on the light because otherwise we would need optimisation permutations of the cloud shader.
float	StopTracingTransmittanceThreshold	When the mean transmittance is below this threashold, we stop tracing.
float	TracingMaxDistance	The maximum distance that will be traced inside the cloud layer. (kilometers)
float	TracingStartMaxDistance	The maximum distance of the volumetric surface before which we will accept to start tracing.
float	ViewSampleCountScale	Scale the tracing sample count in primary views.

Constructors

	Name	Description
	UVolumetricCloudComponent ( const FObjectInitializer& ObjectIn... )

Destructors

	Name	Description
	~UVolumetricCloudComponent()

Functions

		Name	Description
	void	SetbUsePerSampleAtmosphericLightTransmittance ( bool NewValue )
	void	SetGroundAlbedo ( FColor NewValue )
	void	SetLayerBottomAltitude ( float NewValue )
	void	SetLayerHeight ( float NewValue )
	void	SetMaterial ( UMaterialInterface* NewValue )
	void	SetPlanetRadius ( float NewValue )
	void	SetReflectionSampleCountScale ( float NewValue )
	void	SetShadowReflectionSampleCountScale ( float NewValue )
	void	SetShadowTracingDistance ( float NewValue )
	void	SetShadowViewSampleCountScale ( float NewValue )
	void	SetSkyLightCloudBottomOcclusion ( float NewValue )
	void	SetStopTracingTransmittanceThreshold ( float NewValue )
	void	SetTracingMaxDistance ( float NewValue )
	void	SetTracingStartMaxDistance ( float NewValue )
	void	SetViewSampleCountScale ( float NewValue )

Overridden from UActorComponent

	Name	Description
void	CheckForErrors()	Function that gets called from within Map_Check to allow this actor component to check itself for any potential errors and register them with map check dialog.
void	CreateRenderState_Concurrent ( FRegisterComponentContext* Con... )	Used to create any rendering thread information for this component
void	DestroyRenderState_Concurrent()	Used to shut down any rendering thread structure for this component

Overridden from UObject

	Name	Description
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostInterpChange ( FProperty* PropertyThatChanged )	This is called when property is modified by InterpPropertyTracks
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss