Module |
|
Header |
/Engine/Source/Runtime/Engine/Classes/Components/LightComponent.h |
Include |
#include "Components/LightComponent.h" |
class ULightComponent : public ULightComponentBase
Name | Description | ||
---|---|---|---|
|
uint32: 1 |
bAddedToSceneVisible |
True when this light component has been added to the scene as a normal visible light. |
|
uint32: 1 |
bAffectDynamicIndirectLighting |
Whether the light should be injected into the Light Propagation Volume |
|
uint32: 1 |
bCastShadowsFromCinematicObjectsOnly |
Whether the light should only cast shadows from components marked as bCastCinematicShadows. |
|
uint32: 1 |
bEnableLightShaftBloom |
Whether to render light shaft bloom from this light. |
|
uint32: 1 |
bForceCachedShadowsForMovablePrimitives |
Enables cached shadows for movable primitives for this light even if r.shadow.cachedshadowscastfrommovableprimitives is 0 |
|
float |
BloomMaxBrightness |
After exposure is applied, scene color brightness larger than BloomMaxBrightness will be rescaled down to BloomMaxBrightness. |
|
float |
BloomScale |
Scales the additive color. |
|
float |
BloomThreshold |
Scene color must be larger than this to create bloom in the light shafts. |
|
BloomTint |
Multiplies against scene color to create the bloom color. |
|
|
uint32: 1 |
bUseIESBrightness |
True: take light brightness from IES profile, false: use the light brightness - the maximum light in one direction is used to define no masking. |
|
bUseRayTracedDistanceFieldShadows |
Whether to use ray traced distance field area shadows. |
|
|
uint32: 1 |
bUseTemperature |
False: use white (D65) as illuminant. |
|
uint32: 1 |
CastTranslucentShadows |
Whether the light is allowed to cast dynamic shadows from translucency. |
|
float |
ContactShadowLength |
Length of screen space ray trace for sharp contact shadows. Zero is disabled. |
|
uint32: 1 |
ContactShadowLengthInWS |
Where Length of screen space ray trace for sharp contact shadows is in world space units or in screen space units. |
|
DestroyFence |
Fence used to track progress of render resource destruction. |
|
|
float |
DisabledBrightness |
Brightness factor applied to the light when the light function is specified but disabled, for example in scene captures that use SceneCapView_LitNoShadows. |
|
float |
IESBrightnessScale |
Global scale for IES brightness contribution. |
|
IESTexture |
IES texture (light profiles from real world measured data) |
|
|
float |
LightFunctionFadeDistance |
Distance at which the light function should be completely faded to DisabledBrightness. |
|
LightFunctionMaterial |
The light function material to be applied to this light. |
|
|
LightFunctionScale |
Scales the light function projection. |
|
|
LightingChannels |
Channels that this light should affect. |
|
|
float |
MaxDistanceFadeRange |
|
|
float |
MaxDrawDistance |
|
|
PreviewShadowMapChannel |
Transient shadowmap channel used to preview the results of stationary light shadowmap packing. |
|
|
float |
RayStartOffsetDepthScale |
Controls how large of an offset ray traced shadows have from the receiving surface as the camera gets further away. |
|
SceneProxy |
The light's scene info. |
|
|
float |
ShadowBias |
Controls how accurate self shadowing of whole scene shadows from this light are. |
|
float |
ShadowResolutionScale |
Scales the resolution of shadowmaps used to shadow this light. |
|
float |
ShadowSharpen |
Amount to sharpen shadow filtering |
|
float |
ShadowSlopeBias |
Controls how accurate self shadowing of whole scene shadows from this light are. |
|
float |
SpecularScale |
Multiplier on specular highlights. |
|
StaticShadowDepthMap |
||
|
float |
Temperature |
Color temperature in Kelvin of the blackbody illuminant. White (D65) is 6500K. |
Name | Description | |
---|---|---|
|
ULightComponent ( |
Updates/ resets light GUIDs. |
Name | Description | ||
---|---|---|---|
|
AffectsBounds ( |
Test whether the light affects the given bounding volume. |
|
|
AffectsPrimitive ( |
Test whether this light affects the given primitive. |
|
|
ApplyComponentInstanceData |
||
|
float |
ComputeLightBrightness() |
Compute current light brightness based on whether there is a valid IES profile texture attached, and whether IES brightness is enabled |
|
FLightSceneP... |
CreateSceneProxy() |
|
|
GetAtmosphereSunDiskColorScale() |
||
|
GetAtmosphereSunLightIndex() |
||
|
GetBoundingBox() |
Return the world-space bounding box of the light's influence. |
|
|
GetBoundingSphere() |
||
|
GetColoredLightBrightness() |
||
|
GetDirection() |
Script interface to retrieve light direction. |
|
|
const FLight... |
GetLightComponentMapBuildData() |
|
|
FLightmassLi... |
GetLightmassSettings() |
|
|
GetLightPosition() |
Return the homogenous position of the light. |
|
|
ELightCompon... |
GetLightType() |
|
|
UMaterialInt... |
GetMaterial ( |
|
|
GetNumMaterials() |
||
|
float |
GetUniformPenumbraSize() |
|
|
InitializeStaticShadowDepthMap() |
||
|
IsShadowCast ( |
Check whether a given primitive will cast shadows from this light. |
|
|
IsUsedAsAtmosphereSunLight() |
Whether to consider light as a sunlight for atmospheric scattering. |
|
|
ReassignStationaryLightChannels |
Iterates over ALL stationary light components in the target world and assigns their preview shadowmap channel, and updates light icons accordingly. |
|
|
SetAffectDynamicIndirectLighting ( |
||
|
SetAffectTranslucentLighting ( |
||
|
SetBloomMaxBrightness ( |
||
|
SetBloomScale ( |
||
|
SetBloomThreshold ( |
||
|
SetBloomTint ( |
||
|
SetEnableLightShaftBloom ( |
||
|
SetForceCachedShadowsForMovablePrimitives ( |
||
|
SetIESBrightnessScale ( |
||
|
SetIESTexture ( |
||
|
SetIndirectLightingIntensity ( |
||
|
SetIntensity ( |
Set intensity of the light Set brightness of the light |
|
|
SetLightBrightness ( |
Set the Intensity using the brightness. The unit of brightness depends on the light type. |
|
|
SetLightColor ( |
Set color of the light |
|
|
SetLightFunctionDisabledBrightness ( |
||
|
SetLightFunctionFadeDistance ( |
||
|
SetLightFunctionMaterial ( |
||
|
SetLightFunctionScale ( |
||
|
SetLightingChannels |
||
|
SetMaterial ( |
Set the MaterialInterface to use for the given element index (if valid) |
|
|
SetShadowBias ( |
||
|
SetShadowSlopeBias ( |
||
|
SetSpecularScale ( |
||
|
SetTemperature ( |
Set color temperature of the light |
|
|
SetTransmission ( |
||
|
SetUseIESBrightness ( |
||
|
SetUseTemperature ( |
||
|
SetVolumetricScatteringIntensity ( |
||
|
UpdateColorAndBrightness() |
Script interface to update the color and brightness on the render thread. |
Name | Description | ||
---|---|---|---|
|
UpdateLightSpriteTexture() |
Update the texture used on the editor sprite |
Name | Description | ||
---|---|---|---|
|
IsPrecomputedLightingValid() |
True if our precomputed lighting is up to date |
|
|
PropagateLightingScenarioChange() |
Updates any visuals after the lighting has changed |
Name | Description | ||
---|---|---|---|
|
CreateRenderState_Concurrent ( |
Used to create any rendering thread information for this component |
|
|
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 |
|
InvalidateLightingCacheDetailed |
Called when this actor component has moved, allowing it to discard statically cached lighting information. |
|
|
OnRegister() |
UActorComponent Interface |
|
|
SendRenderTransform_Concurrent() |
Called to send a transform update for this component to the rendering thread |
Name | Description | ||
---|---|---|---|
|
BeginDestroy() |
Called before destroying the object. |
|
|
CanEditChange ( |
Called by the editor to query whether a property of this object is allowed to be modified. |
|
|
IsReadyForFinishDestroy() |
Called to check if the object is ready for FinishDestroy. |
|
|
PostEditChangeProperty ( |
Called when a property on this object has been modified externally |
|
|
PostInterpChange ( |
Called when property is modified by InterpPropertyTracks |
|
|
PostLoad() |
Called after this UObject has been serialized |
|
|
PreSave ( |
Presave function. |
|
|
Serialize ( |
Handles reading, writing, and reference collecting using FArchive. |
Name |
Description |
---|---|
FOnUpdateColorAndBrightness |
Name |
Description |
---|---|
UpdateColorAndBrightnessEvent |
Called When light color or brightness needs update |
Name | Description | ||
---|---|---|---|
|
uint32: 1 |
InverseSquaredFalloff_DEPRECATED |
|
|
float |
MinRoughness_DEPRECATED |
Min roughness effective for this light. Used for softening specular highlights. |
|
ShadowMapChannel_DEPRECATED |
Legacy shadowmap channel from the lighting build, now stored in FLightComponentMapBuildData. |