SkyLightComponent.cpp File Reference

#include "Components/SkyLightComponent.h"
#include "Engine/Level.h"
#include "Engine/Texture2D.h"
#include "Engine/World.h"
#include "GameFramework/Info.h"
#include "SceneManagement.h"
#include "Misc/QueuedThreadPool.h"
#include "UObject/ConstructorHelpers.h"
#include "RenderUtils.h"
#include "UObject/UObjectIterator.h"
#include "Engine/SkyLight.h"
#include "Logging/MessageLog.h"
#include "Misc/UObjectToken.h"
#include "Net/UnrealNetwork.h"
#include "Misc/MapErrors.h"
#include "Misc/ScopeLock.h"
#include "SceneInterface.h"
#include "SceneProxies/SkyLightSceneProxy.h"
#include "ShaderCompiler.h"
#include "Components/BillboardComponent.h"
#include "UObject/ReleaseObjectVersion.h"
#include "UObject/UE5MainStreamObjectVersion.h"
#include "Engine/TextureCube.h"
#include "ComponentRecreateRenderStateContext.h"

Macros
#define	LOCTEXT_NAMESPACE   "SkyLightComponent"

Functions
void	OnUpdateSkylights (UWorld *InWorld)
FAutoConsoleVariableRef	CVarSkylightIntensityMultiplier (TEXT("r.SkylightIntensityMultiplier"), GSkylightIntensityMultiplier, TEXT("Intensity scale on Stationary and Movable skylights. This is useful to control overall lighting contrast in dynamically lit games with scalability levels which disable Ambient Occlusion. For example, if medium quality disables SSAO and DFAO, reduce skylight intensity."), ECVF_Scalability|ECVF_RenderThreadSafe)
void	OnChangeSkylightRealTimeReflectionCapture (IConsoleVariable *Var)
FAutoConsoleVariableRef	CVarSkylightRealTimeReflectionCapture (TEXT("r.SkyLight.RealTimeReflectionCapture"), GSkylightRealTimeReflectionCapture, TEXT("Make sure the sky light real time capture is not run on platform where it is considered out of budget. Cannot be changed at runtime."), FConsoleVariableDelegate::CreateStatic(&OnChangeSkylightRealTimeReflectionCapture), ECVF_Scalability)

Variables
FAutoConsoleCommandWithWorld	CaptureConsoleCommand (TEXT("r.SkylightRecapture"), TEXT("Updates all stationary and movable skylights, useful for debugging the capture pipeline"), FConsoleCommandWithWorldDelegate::CreateStatic(OnUpdateSkylights))
int32	GUpdateSkylightsEveryFrame = 0
FAutoConsoleVariableRef	CVarUpdateSkylightsEveryFrame (TEXT("r.SkylightUpdateEveryFrame"), GUpdateSkylightsEveryFrame, TEXT("Whether to update all skylights every frame. Useful for debugging."), ECVF_Default)
float	GSkylightIntensityMultiplier = 1.0f
int32	GSkylightRealTimeReflectionCapture = 1
int32	GSkylightCubemapMaxResolution = -1
FAutoConsoleVariableRef	CVarSkylightCubemapMaxResolution (TEXT("r.SkyLight.CubemapMaxResolution"), GSkylightCubemapMaxResolution,)
constexpr EPixelFormat	SKYLIGHT_CUBEMAP_FORMAT = PF_FloatRGBA

Macro Definition Documentation

LOCTEXT_NAMESPACE

#define LOCTEXT_NAMESPACE   "SkyLightComponent"

Function Documentation

CVarSkylightIntensityMultiplier()

FAutoConsoleVariableRef CVarSkylightIntensityMultiplier	(	TEXT("r.SkylightIntensityMultiplier")	,
		GSkylightIntensityMultiplier	,
		TEXT("Intensity scale on Stationary and Movable skylights. This is useful to control overall lighting contrast in dynamically lit games with scalability levels which disable Ambient Occlusion. For example, if medium quality disables SSAO and DFAO, reduce skylight intensity.")	,
		ECVF_Scalability|	ECVF_RenderThreadSafe
	)

CVarSkylightRealTimeReflectionCapture()

FAutoConsoleVariableRef CVarSkylightRealTimeReflectionCapture	(	TEXT("r.SkyLight.RealTimeReflectionCapture")	,
		GSkylightRealTimeReflectionCapture	,
		TEXT("Make sure the sky light real time capture is not run on platform where it is considered out of budget. Cannot be changed at runtime.")	,
		FConsoleVariableDelegate::CreateStatic &	OnChangeSkylightRealTimeReflectionCapture,
		ECVF_Scalability
	)

OnChangeSkylightRealTimeReflectionCapture()

void OnChangeSkylightRealTimeReflectionCapture

(

IConsoleVariable *

Var

)

OnUpdateSkylights()

void OnUpdateSkylights

(

UWorld *

InWorld

)

Variable Documentation

CaptureConsoleCommand

FAutoConsoleCommandWithWorld CaptureConsoleCommand(TEXT("r.SkylightRecapture"), TEXT("Updates all stationary and movable skylights, useful for debugging the capture pipeline"), FConsoleCommandWithWorldDelegate::CreateStatic(OnUpdateSkylights))	(	TEXT("r.SkylightRecapture")	,
		TEXT("Updates all stationary and movable skylights, useful for debugging the capture pipeline")	,
		FConsoleCommandWithWorldDelegate::CreateStatic(OnUpdateSkylights)
	)

CVarSkylightCubemapMaxResolution

FAutoConsoleVariableRef CVarSkylightCubemapMaxResolution(TEXT("r.SkyLight.CubemapMaxResolution"), GSkylightCubemapMaxResolution,)	(	TEXT("r.SkyLight.CubemapMaxResolution")	,
		GSkylightCubemapMaxResolution
	)

CVarUpdateSkylightsEveryFrame

FAutoConsoleVariableRef CVarUpdateSkylightsEveryFrame(TEXT("r.SkylightUpdateEveryFrame"), GUpdateSkylightsEveryFrame, TEXT("Whether to update all skylights every frame. Useful for debugging."), ECVF_Default)	(	TEXT("r.SkylightUpdateEveryFrame")	,
		GUpdateSkylightsEveryFrame	,
		TEXT("Whether to update all skylights every frame. Useful for debugging.")	,
		ECVF_Default
	)

GSkylightCubemapMaxResolution

int32 GSkylightCubemapMaxResolution = -1

GSkylightIntensityMultiplier

float GSkylightIntensityMultiplier = 1.0f

GSkylightRealTimeReflectionCapture

int32 GSkylightRealTimeReflectionCapture = 1

GUpdateSkylightsEveryFrame

int32 GUpdateSkylightsEveryFrame = 0

SKYLIGHT_CUBEMAP_FORMAT

constexpr EPixelFormat SKYLIGHT_CUBEMAP_FORMAT = PF_FloatRGBA

constexpr