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 > USkyLightComponent

Light Theme

Dark Theme

USkyLightComponent

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

USceneComponent

ULightComponentBase

USkyLightComponent

References

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

Syntax

class USkyLightComponent : public ULightComponentBase

Variables

	Name	Description
float	AverageBrightness
bool	bCaptureEmissiveOnly	Only capture emissive materials.
bool	bHasEverCaptured
float	BlendDestinationAverageBrightness
UTextureCube &#...	BlendDestinationCubemap
FSHVectorRGB3	BlendDestinationIrradianceEnvironmentMap
TRefCountPtr< F...	BlendDestinationProcessedSkyTexture
float	BlendFraction	If 0, no blend is present.
bool	bLowerHemisphereIsBlack	Whether all distant lighting from the lower hemisphere should be set to LowerHemisphereColor.
bool	bSavedConstructionScriptValuesValid	Indicates whether the cached data stored in GetComponentInstanceData is valid to be applied in ApplyComponentInstanceData.
float	Contrast	Contrast S-curve applied to the computed AO.
UTextureCube &#...	Cubemap	Cubemap to use for sky lighting if SourceType is set to SLS_SpecifiedCubemap.
int32	CubemapResolution	Maximum resolution for the very top processed cubemap mip. Must be a power of 2.
FSHVectorRGB3	IrradianceEnvironmentMap
FRenderCommandF...	IrradianceMapFence	Tracks when the rendering thread has completed its writes to IrradianceEnvironmentMap.
FLinearColor	LowerHemisphereColor
float	MinOcclusion	Controls the darkest that a fully occluded area can get.
TEnumAsByte< en...	OcclusionCombineMode	Controls how occlusion from Distance Field Ambient Occlusion is combined with Screen Space Ambient Occlusion.
float	OcclusionExponent	Exponent applied to the computed AO.
float	OcclusionMaxDistance	Max distance that the occlusion of one point will affect another.
FColor	OcclusionTint	Tint color on occluded areas, artistic control.
int32	PreEditCubemapResolution	Shadow copy saved before effects of PostEditChange() to provide option to roll back edit.
TRefCountPtr< F...	ProcessedSkyTexture
FRenderCommandF...	ReleaseResourcesFence	Fence used to track progress of releasing resources on the rendering thread.
FSkyLightSceneP...	SceneProxy
float	SkyDistanceThreshold	Distance from the sky light at which any geometry should be treated as part of the sky.
float	SourceCubemapAngle	Angle to rotate the source cubemap when SourceType is set to SLS_SpecifiedCubemap.
TEnumAsByte< en...	SourceType	Indicates where to get the light contribution from.

Constructors

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

Functions

	Name	Description
void	ApplyComponentInstanceData ( FPrecomputedSkyLightInstanceData&#... )
void	CaptureEmissiveRadianceEnvironmentCubeMap ( FSHVectorRGB3& OutIrradianceMap, TArray< FFloat16Color >& OutRadian... )	Computes a radiance map using only emissive contribution from the sky light.
FSkyLightSce...	CreateSceneProxy()
bool	IsOcclusionSupported()	Whether sky occlusion is supported by current feature level
void	RecaptureSky()	Recaptures the scene for the skylight.
void	SanitizeCubemapSize()
void	SetBlendDestinationCaptureIsDirty()
void	SetCaptureIsDirty()	Indicates that the capture needs to recapture the scene, adds it to the recapture queue.
void	SetCubemap ( UTextureCube* NewCubemap )	Sets the cubemap used when SourceType is set to SpecifiedCubemap, and causes a skylight update on the next tick.
void	SetCubemapBlend ( UTextureCube* SourceCubemap, UTextureCube* DestinationCubem..., float InBlendFraction )	Creates sky lighting from a blend between two cubemaps, which is only valid when SourceType is set to SpecifiedCubemap.
void	SetIndirectLightingIntensity ( float NewIntensity )
void	SetIntensity ( float NewIntensity )	Set brightness of the light
void	SetIrradianceEnvironmentMap ( const FSHVectorRGB3& InIrradianceE... )
void	SetLightColor ( FLinearColor NewLightColor )	Set color of the light
void	SetLowerHemisphereColor ( const FLinearColor& InLowerHemisph... )
void	SetMinOcclusion ( float InMinOcclusion )
void	SetOcclusionContrast ( float InOcclusionContrast )
void	SetOcclusionExponent ( float InOcclusionExponent )
void	SetOcclusionTint ( const FColor& InTint )
void	SetVolumetricScatteringIntensity ( float NewIntensity )
void	UpdateImportanceSamplingData()
void	UpdateLimitedRenderingStateFast()	Fast path for updating light properties that doesn't require a re-register, Which would otherwise cause the scene's static draw lists to be recreated.
void	UpdateOcclusionRenderingStateFast()
void	UpdateSkyCaptureContents ( UWorld* WorldToUpdate )	Called each tick to recapture and queued sky captures.
void	UpdateSkyCaptureContentsArray ( UWorld* WorldToUpdate, TArray< USkyLightComponent* > ..., bool bBlendSources )	Called each tick to recapture and queued sky captures.

Overridden from USceneComponent

		Name	Description
	void	OnVisibilityChanged()	Overridable internal function to respond to changes in the visibility of the component.

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
TStructOnSco...	GetComponentInstanceData()	Called before we throw away components during RerunConstructionScripts, to cache any data we wish to persist across that operation

Overridden from UObject

	Name	Description
void	BeginDestroy()	Called before destroying the object.
bool	CanEditChange ( const FProperty* InProperty )	Called by the editor to query whether a property of this object is allowed to be modified.
bool	IsDestructionThreadSafe()	Called during garbage collection to determine if an object can have its destructor called on a worker thread.
bool	IsReadyForFinishDestroy()	Called to check if the object is ready for FinishDestroy.
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
void	PostInterpChange ( FProperty* PropertyThatChanged )	This is called when property is modified by InterpPropertyTracks
void	PostLoad()	UObject Interface
void	PreEditChange ( FProperty* PropertyAboutToChan... )	This is called when a property is about to be modified externally
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Constants

Name	Description
SkyCapturesToUpdate	List of sky captures that need to be recaptured.
SkyCapturesToUpdateBlendDestinations
SkyCapturesToUpdateLock

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

Take our survey

Dismiss