Class SkyLightComponent

Sky Light Component

Inheritance
System.Object
UObject
ActorComponent
SceneComponent
LightComponentBase
SkyLightComponent
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: UE4.Engine
Assembly: UE4DotNet.dll
Syntax
public class SkyLightComponent : LightComponentBase

Properties

| Improve this Doc View Source

bCaptureEmissiveOnly

Declaration
public bool bCaptureEmissiveOnly { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

BlendDestinationCubemap

Blend Destination Cubemap

Declaration
public TextureCube BlendDestinationCubemap { get; set; }
Property Value
Type Description
TextureCube
| Improve this Doc View Source

bLowerHemisphereIsBlack

Declaration
public bool bLowerHemisphereIsBlack { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Contrast

Contrast S-curve applied to the computed AO. A value of 0 means no contrast increase, 1 is a significant contrast increase.

Declaration
public float Contrast { get; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

Cubemap

Cubemap to use for sky lighting if SourceType is set to SLS_SpecifiedCubemap.

Declaration
public TextureCube Cubemap { get; }
Property Value
Type Description
TextureCube
| Improve this Doc View Source

CubemapResolution

Maximum resolution for the very top processed cubemap mip. Must be a power of 2.

Declaration
public int CubemapResolution { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

DefaultObject

Get UE4 Default Object for this Class

Declaration
public static SkyLightComponent DefaultObject { get; }
Property Value
Type Description
SkyLightComponent
| Improve this Doc View Source

LowerHemisphereColor

Lower Hemisphere Color

Declaration
public LinearColor LowerHemisphereColor { get; }
Property Value
Type Description
LinearColor
| Improve this Doc View Source

MinOcclusion

Controls the darkest that a fully occluded area can get. This tends to destroy contact shadows, use Contrast or OcclusionExponent instead.

Declaration
public float MinOcclusion { get; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

OcclusionCombineMode

Controls how occlusion from Distance Field Ambient Occlusion is combined with Screen Space Ambient Occlusion.

Declaration
public byte OcclusionCombineMode { get; }
Property Value
Type Description
System.Byte
| Improve this Doc View Source

OcclusionExponent

Exponent applied to the computed AO. Values lower than 1 brighten occlusion overall without losing contact shadows.

Declaration
public float OcclusionExponent { get; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

OcclusionMaxDistance

Max distance that the occlusion of one point will affect another.

Declaration
public float OcclusionMaxDistance { get; }
Property Value
Type Description
System.Single
Remarks

Higher values increase the cost of Distance Field AO exponentially.

| Improve this Doc View Source

OcclusionTint

Tint color on occluded areas, artistic control.

Declaration
public Color OcclusionTint { get; }
Property Value
Type Description
Color
| Improve this Doc View Source

SkyDistanceThreshold

Distance from the sky light at which any geometry should be treated as part of the sky.

Declaration
public float SkyDistanceThreshold { get; }
Property Value
Type Description
System.Single
Remarks

This is also used by reflection captures, so update reflection captures to see the impact.

| Improve this Doc View Source

SourceCubemapAngle

Angle to rotate the source cubemap when SourceType is set to SLS_SpecifiedCubemap.

Declaration
public float SourceCubemapAngle { get; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

SourceType

Indicates where to get the light contribution from.

Declaration
public byte SourceType { get; }
Property Value
Type Description
System.Byte
| Improve this Doc View Source

StaticClass

Get UE4 Class

Declaration
public static Class StaticClass { get; }
Property Value
Type Description
Class

Methods

| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

Declaration
public static SkyLightComponent New(UObject obj = null, Name name = default(Name))
Parameters
Type Name Description
UObject obj
Name name
Returns
Type Description
SkyLightComponent
| Improve this Doc View Source

RecaptureSky()

Recaptures the scene for the skylight.

Declaration
public void RecaptureSky()
Remarks

This is useful for making sure the sky light is up to date after changing something in the world that it would capture. Warning: this is very costly and will definitely cause a hitch.

| Improve this Doc View Source

SetCubemap(TextureCube)

Sets the cubemap used when SourceType is set to SpecifiedCubemap, and causes a skylight update on the next tick.

Declaration
public void SetCubemap(TextureCube NewCubemap)
Parameters
Type Name Description
TextureCube NewCubemap
| Improve this Doc View Source

SetCubemapBlend(TextureCube, TextureCube, Single)

Creates sky lighting from a blend between two cubemaps, which is only valid when SourceType is set to SpecifiedCubemap.

Declaration
public void SetCubemapBlend(TextureCube SourceCubemap, TextureCube DestinationCubemap, float InBlendFraction)
Parameters
Type Name Description
TextureCube SourceCubemap
TextureCube DestinationCubemap
System.Single InBlendFraction
Remarks

This can be used to seamlessly transition sky lighting between different times of day. The caller should continue to update the blend until BlendFraction is 0 or 1 to reduce rendering cost. The caller is responsible for avoiding pops due to changing the source or destination.

| Improve this Doc View Source

SetIndirectLightingIntensity(Single)

Set Indirect Lighting Intensity

Declaration
public void SetIndirectLightingIntensity(float NewIntensity)
Parameters
Type Name Description
System.Single NewIntensity
| Improve this Doc View Source

SetIntensity(Single)

Set Intensity

Declaration
public void SetIntensity(float NewIntensity)
Parameters
Type Name Description
System.Single NewIntensity
| Improve this Doc View Source

SetLightColor(LinearColor)

Set color of the light

Declaration
public void SetLightColor(LinearColor NewLightColor)
Parameters
Type Name Description
LinearColor NewLightColor
| Improve this Doc View Source

SetLowerHemisphereColor(LinearColor)

Set Lower Hemisphere Color

Declaration
public void SetLowerHemisphereColor(LinearColor InLowerHemisphereColor)
Parameters
Type Name Description
LinearColor InLowerHemisphereColor
| Improve this Doc View Source

SetMinOcclusion(Single)

Set Min Occlusion

Declaration
public void SetMinOcclusion(float InMinOcclusion)
Parameters
Type Name Description
System.Single InMinOcclusion
| Improve this Doc View Source

SetOcclusionContrast(Single)

Set Occlusion Contrast

Declaration
public void SetOcclusionContrast(float InOcclusionContrast)
Parameters
Type Name Description
System.Single InOcclusionContrast
| Improve this Doc View Source

SetOcclusionExponent(Single)

Set Occlusion Exponent

Declaration
public void SetOcclusionExponent(float InOcclusionExponent)
Parameters
Type Name Description
System.Single InOcclusionExponent
| Improve this Doc View Source

SetOcclusionTint(Color)

Set Occlusion Tint

Declaration
public void SetOcclusionTint(Color InTint)
Parameters
Type Name Description
Color InTint
| Improve this Doc View Source

SetVolumetricScatteringIntensity(Single)

Set Volumetric Scattering Intensity

Declaration
public void SetVolumetricScatteringIntensity(float NewIntensity)
Parameters
Type Name Description
System.Single NewIntensity

Operators

| Improve this Doc View Source

Implicit(IntPtr to SkyLightComponent)

Convert from IntPtr to UObject

Declaration
public static implicit operator SkyLightComponent(IntPtr p)
Parameters
Type Name Description
System.IntPtr p
Returns
Type Description
SkyLightComponent