1. Epic GamesDeveloper
  3. USkyLightComponent

USkyLightComponent

Unreal Engine C++ API Reference > Runtime > Engine > Components

Inheritance Hierarchy

References

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

Syntax

UCLASS (Blueprintable, ClassGroup=Lights,  
       HideCategories=(Trigger, Activation, "Components|Activation", Physics),  
       Meta=(BlueprintSpawnableComponent), MinimalAPI)  
class USkyLightComponent : public ULightComponentBase

Variables

  Type Name Description
Protected variable float AverageBrightness  
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadOnly bool bCaptureEmissiveOnly Only capture emissive materials.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly uint32: 1 bCloudAmbientOcclusion Whether the cloud should occlude sky contribution within the atmosphere (progressively fading multiple scattering out) or not.
Protected variable bool bHasEverCaptured  
Protected variable float BlendDestinationAverageBrightness  
Protected variable UProperty Transient TObjectPtr< class UTextureCube > BlendDestinationCubemap  
Protected variable FSHVectorRGB3 BlendDestinationIrradianceEnvironmentMap  
Protected variable UProperty Transient TRefCountPtr< FSkyTextureCubeResource > BlendDestinationProcessedSkyTexture  
Protected variable float BlendFraction If 0, no blend is present.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadOnly bool bLowerHemisphereIsBlack Whether all distant lighting from the lower hemisphere should be set to LowerHemisphereColor.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly bool bRealTimeCapture When enabled, the sky will be captured and convolved to achieve dynamic diffuse and specular environment lighting.
Protected variable bool bSavedConstructionScriptValuesValid Indicates whether the cached data stored in GetComponentInstanceData is valid to be applied in ApplyComponentInstanceData.
Protected variable ESkyLightCaptureStatus CaptureStatus In an attempt to get valid lighting data as soon as possible in a level, we will always trigger a skylight capture at creation.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly float CloudAmbientOcclusionApertureScale Controls the cone aperture angle over which the sky occlusion due to volumetric clouds is evaluated.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly float CloudAmbientOcclusionExtent The world space radius of the cloud ambient occlusion map around the camera in kilometers.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly float CloudAmbientOcclusionMapResolutionScale Scale the cloud ambient occlusion map resolution, base resolution is 512.
Public variable UProperty Category, EditAnywhere, Interp, Meta BlueprintReadOnly float CloudAmbientOcclusionStrength The strength of the ambient occlusion, higher value will block more light.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly float Contrast Contrast S-curve applied to the computed AO.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly TObjectPtr< class UTextureCube > Cubemap Cubemap to use for sky lighting if SourceType is set to SLS_SpecifiedCubemap.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly int32 CubemapResolution Maximum resolution for the very top processed cubemap mip. Must be a power of 2.
Protected variable FSHVectorRGB3 IrradianceEnvironmentMap  
Protected variable FRenderCommandFence IrradianceMapFence Tracks when the rendering thread has completed its writes to IrradianceEnvironmentMap.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadOnly FLinearColor LowerHemisphereColor  
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly float MinOcclusion Controls the darkest that a fully occluded area can get.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly TEnumAsByte< enum EOcclusionCombineMode > OcclusionCombineMode Controls how occlusion from Distance Field Ambient Occlusion is combined with Screen Space Ambient Occlusion.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly float OcclusionExponent Exponent applied to the computed AO.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly float OcclusionMaxDistance Max distance that the occlusion of one point will affect another.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly FColor OcclusionTint Tint color on occluded areas, artistic control.
Protected variable int32 PreEditCubemapResolution Shadow copy saved before effects of PostEditChange() to provide option to roll back edit.
Protected variable TRefCountPtr< FSkyTextureCubeResource > ProcessedSkyTexture  
Protected variable FRenderCommandFence ReleaseResourcesFence Fence used to track progress of releasing resources on the rendering thread.
Protected variable FSkyLightSceneProxy * SceneProxy  
Protected variable float SecondsSinceLastCapture  
Public variable UProperty Category, EditAnywhere BlueprintReadOnly float SkyDistanceThreshold Distance from the sky light at which any geometry should be treated as part of the sky.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly float SourceCubemapAngle Angle to rotate the source cubemap when SourceType is set to SLS_SpecifiedCubemap.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly TEnumAsByte< enum ESkyLightSourceType > SourceType Indicates where to get the light contribution from.
Protected variable FLinearColor SpecifiedCubemapColorScale  

Constructors

  Type Name Description
Public function  

USkyLightComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function void  
Public function Const void Computes a radiance map using only emissive contribution from the sky light.
Public function Const FSkyLightSceneProxy *  
Public function FSHVectorRGB3  
Public function Const const FTexture *  
Public function Const bool Whether sky occlusion is supported by current feature level
Public function Const bool  
Public function UFunction BlueprintCallable, Category void Recaptures the scene for the skylight.
Public function void  
Public function void  
Public function void Indicates that the capture needs to recapture the scene, adds it to the recapture queue.
Public function UFunction BlueprintCallable, Category void

SetCubemap ( UTextureCube* NewCubemap
)

 Sets the cubemap used when SourceType is set to SpecifiedCubemap, and causes a skylight update on the next tick.
Public function UFunction BlueprintCallable, Category void

SetCubemapBlend ( UTextureCube* SourceCubemap,
UTextureCube* DestinationCubemap,
float InBlendFraction
)

 Creates sky lighting from a blend between two cubemaps, which is only valid when SourceType is set to SpecifiedCubemap.
Public function UFunction BlueprintCallable, Category void

SetIndirectLightingIntensity ( float NewIntensity
)

  
Public function UFunction BlueprintCallable, Category void

SetIntensity ( float NewIntensity
)

 Set brightness of the light
Public function UFunction BlueprintCallable, Category void

SetLightColor ( FLinearColor NewLightColor
)

 Set color of the light
Public function UFunction BlueprintCallable, Category void

SetLowerHemisphereColor ( const FLinearColor& InLowerHemisphereColor
)

  
Public function UFunction BlueprintCallable, Category void

SetMinOcclusion ( float InMinOcclusion
)

  
Public function UFunction BlueprintCallable, Category void

SetOcclusionContrast ( float InOcclusionContrast
)

  
Public function UFunction BlueprintCallable, Category void

SetOcclusionExponent ( float InOcclusionExponent
)

  
Public function UFunction BlueprintCallable, Category void

SetOcclusionTint ( const FColor& InTint
)

  
Public function void

SetRealTimeCaptureEnabled ( bool bNewRealTimeCaptureEnabled
)

  
Public function UFunction BlueprintCallable, Category void

SetSourceCubemapAngle ( float NewValue
)

 Sets the angle of the cubemap used when SourceType is set to SpecifiedCubemap and it is non static.
Public function UFunction BlueprintCallable, Category void

SetVolumetricScatteringIntensity ( float NewIntensity
)

  
Protected function void 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.
Protected function void  
Public function Static void

UpdateSkyCaptureContents ( UWorld* WorldToUpdate
)

 Called each tick to recapture and queued sky captures.
Public function Static void

UpdateSkyCaptureContentsArray ( UWorld* WorldToUpdate,
TArray< USkyLightComponent* >& ComponentArray,
bool bBlendSources
)

  

Overridden from USceneComponent

  Type Name Description
Protected function Virtual void Overridable internal function to respond to changes in the visibility of the component.

Overridden from UActorComponent

  Type Name Description
Public function Virtual void 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.
Protected function Virtual void Used to create any rendering thread information for this component
Protected function Virtual void Used to shut down any rendering thread structure for this component
Public function Virtual Const TStructOnScope< FActorComponentInstanceData > Called before we throw away components during RerunConstructionScripts, to cache any data we wish to persist across that operation
Protected function Virtual void Called to send a transform update for this component to the rendering thread

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual Const bool

CanEditChange ( const FProperty* InProperty
)

 Called by the editor to query whether a property of this object is allowed to be modified.
Public function Virtual bool Called to check if the object is ready for FinishDestroy.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
Public function Virtual void UObject Interface
Public function Virtual void

PreEditChange ( FProperty* PropertyAboutToChange
)

 This is called when a property is about to be modified externally
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Constants

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page