UGPULightmassSettings | Unreal Engine 5.7 Documentation

API > API/Plugins > API/Plugins/GPULightmass


Name	UGPULightmassSettings
Type	class
Header File	/Engine/Plugins/Experimental/GPULightmass/Source/GPULightmass/Public/GPULightmassSettings.h
Include Path	#include "GPULightmassSettings.h"

Syntax

UCLASS (BlueprintType)  
class UGPULightmassSettings : public UObject

Inheritance Hierarchy

UObjectBase → UObjectBaseUtility → UObject → UGPULightmassSettings

Variables

Public

Name	Type	Remarks	Include Path	Unreal Specifiers
bCompressLightmaps	bool	Whether to compress lightmap textures.	GPULightmassSettings.h	EditAnywhere BlueprintReadWrite Category=General
bShowProgressBars	bool	If true, draw a green progress bar within each tile as it renders.	GPULightmassSettings.h	EditAnywhere BlueprintReadWrite Category=General
bUseFirstBounceRayGuiding	bool	If Irradiance Caching is enabled, First Bounce Ray Guiding will search the hemisphere over each first bounce sample to find the brightest directions to weigh the rest of the samples towards.	GPULightmassSettings.h	EditAnywhere BlueprintReadWrite Category=GlobalIllumination Meta=(EditCondition="bUseIrradianceCaching")
bUseIrradianceCacheBackfaceDetection	bool	Further prevent leaks caused by irradiance cache cells being placed inside geometry, at the cost of more fireflies and slower sampling speed. Recommended to be used with higher irradiance cache quality (>=256)	GPULightmassSettings.h	EditAnywhere BlueprintReadWrite AdvancedDisplay Category=IrradianceCaching DisplayName="Aggressive Leak Prevention" Meta=(EditCondition="bUseIrradianceCaching")
bUseIrradianceCaching	bool	Irradiance Caching should be enabled with interior scenes to achieve more physically correct GI intensities, albeit with some biasing.	GPULightmassSettings.h	EditAnywhere BlueprintReadWrite Category=GlobalIllumination
bVisualizeIrradianceCache	bool	If true, visualize the Irradiance Cache cells.	GPULightmassSettings.h	EditAnywhere BlueprintReadWrite AdvancedDisplay Category=IrradianceCaching DisplayName="Debug: Visualize" Meta=(EditCondition="bUseIrradianceCaching")
Denoiser	EGPULightmassDenoiser		GPULightmassSettings.h	EditAnywhere BlueprintReadWrite Category=Denoising Meta=(EditCondition="DenoisingOptions != EGPULightmassDenoisingOptions::None")
DenoisingOptions	EGPULightmassDenoisingOptions	If enabled, denoise the results on the CPU after rendering.	GPULightmassSettings.h	EditAnywhere BlueprintReadWrite Category=Denoising DisplayName="Denoise when"
FirstBounceRayGuidingTrialSamples	int32	Number of samples used for First Bounce Ray Guiding, which are thrown away before sampling for lighting.	GPULightmassSettings.h	EditAnywhere BlueprintReadWrite Category=FirstBounceRayGuiding DisplayName="Trial Samples" Meta=(EditCondition="bUseFirstBounceRayGuiding")
GISamples	int32	Total number of ray paths executed per texel across all bounces.	GPULightmassSettings.h	EditAnywhere BlueprintReadWrite Category=GlobalIllumination DisplayName="GI Samples" Meta=(ClampMin="32", ClampMax="65536", UIMax="8192")
IrradianceCacheCornerRejection	float	Reject IC entries around corners to help reduce leaking and artifacts.	GPULightmassSettings.h	EditAnywhere BlueprintReadWrite AdvancedDisplay Category=IrradianceCaching DisplayName="Corner Rejection" Meta=(EditCondition="bUseIrradianceCaching", ClampMin="0.0", ClampMax="8.0")
IrradianceCacheQuality	int32	Number of samples per Irradiance Cache cell.	GPULightmassSettings.h	EditAnywhere BlueprintReadWrite Category=IrradianceCaching DisplayName="Quality" Meta=(EditCondition="bUseIrradianceCaching", ClampMin="4", ClampMax="65536", UIMax="8192")
IrradianceCacheSpacing	int32	Size of each Irradiance Cache cell. Smaller sizes will be slower but more accurate.	GPULightmassSettings.h	EditAnywhere BlueprintReadWrite AdvancedDisplay Category=IrradianceCaching DisplayName="Size" Meta=(EditCondition="bUseIrradianceCaching", ClampMin="4", ClampMax="1024")
LightmapTilePoolSize	int32	GPU Lightmass manages a pool for calculations of visible tiles.	GPULightmassSettings.h	EditAnywhere BlueprintReadWrite Category=System Meta=(ClampMin="16", ClampMax="128")
Mode	EGPULightmassMode	Full Bake mode renders the full lightmap resolution for every object in the scene.	GPULightmassSettings.h	EditAnywhere BlueprintReadWrite Category=General
StationaryLightShadowSamples	int32	Number of samples for stationary shadows, which are calculated and stored separately from GI.	GPULightmassSettings.h	EditAnywhere BlueprintReadWrite Category=GlobalIllumination Meta=(ClampMin="32", ClampMax="65536", UIMax="8192")
TilePassesInFullSpeedMode	int32	Baking speed multiplier when Realtime is disabled in the viewer.	GPULightmassSettings.h	EditAnywhere BlueprintReadWrite Category=System DisplayName="Non-Realtime Workload Factor" Meta=(ClampMin="1", ClampMax="1024")
TilePassesInSlowMode	int32	Baking speed multiplier when Realtime is enabled in the viewer.	GPULightmassSettings.h	EditAnywhere BlueprintReadWrite Category=System DisplayName="Realtime Workload Factor" Meta=(ClampMin="1", ClampMax="1024")
VolumetricLightmapDetailCellSize	int32	Size of an Volumetric Lightmap voxel at the highest density (used around geometry), in world space units.	GPULightmassSettings.h	EditAnywhere BlueprintReadWrite Category=VolumetricLightmap DisplayName="Detail Cell Size" Meta=(ClampMin="1", ClampMax="20000", UIMax="2000")
VolumetricLightmapQualityMultiplier	int32		GPULightmassSettings.h	EditAnywhere BlueprintReadWrite Category=VolumetricLightmap DisplayName="Quality Multiplier" Meta=(ClampMin="1", ClampMax="256", UIMax="32")

Functions

Public

Name	Remarks	Include Path	Unreal Specifiers
void ApplyImmediateSettingsToRunningInstances()		GPULightmassSettings.h
virtual bool CanEditChange ( const FProperty* InProperty ) const		GPULightmassSettings.h
virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent )		GPULightmassSettings.h

Navigation

Syntax

Inheritance Hierarchy

Variables

Public

Functions

Public