Class Light2D

Class Light2D is a 2D light which can be used with the 2D Renderer.

Inheritance
Object
Object
Component
Behaviour
MonoBehaviour
Light2D
Inherited Members
UnityEngine.Object.FindObjectsOfType<T>(System.Boolean)
UnityEngine.Object.FindObjectOfType<T>(System.Boolean)
Namespace: UnityEngine.Experimental.Rendering.Universal
Syntax
[ExecuteAlways]
[DisallowMultipleComponent]
[AddComponentMenu("Rendering/2D/Light 2D")]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.render-pipelines.universal@latest/index.html?subfolder=/manual/2DLightProperties.html")]
public sealed class Light2D : MonoBehaviour, ISerializationCallbackReceiver

Properties

blendStyleIndex

The lights current operation index

Declaration
public int blendStyleIndex { get; set; }
Property Value
Type Description
Int32

color

The lights current color

Declaration
public Color color { get; set; }
Property Value
Type Description
Color

falloffIntensity

Declaration
public float falloffIntensity { get; }
Property Value
Type Description
Single

intensity

The lights current intensity

Declaration
public float intensity { get; set; }
Property Value
Type Description
Single

lightCookieSprite

Declaration
public Sprite lightCookieSprite { get; }
Property Value
Type Description
Sprite

lightOrder

Declaration
public int lightOrder { get; set; }
Property Value
Type Description
Int32

lightType

The lights current type

Declaration
public Light2D.LightType lightType { get; set; }
Property Value
Type Description
Light2D.LightType

normalMapDistance

Declaration
public float normalMapDistance { get; }
Property Value
Type Description
Single

normalMapQuality

Declaration
public Light2D.NormalMapQuality normalMapQuality { get; }
Property Value
Type Description
Light2D.NormalMapQuality

overlapOperation

Declaration
public Light2D.OverlapOperation overlapOperation { get; }
Property Value
Type Description
Light2D.OverlapOperation

pointLightInnerAngle

Declaration
public float pointLightInnerAngle { get; set; }
Property Value
Type Description
Single

pointLightInnerRadius

Declaration
public float pointLightInnerRadius { get; set; }
Property Value
Type Description
Single

pointLightOuterAngle

Declaration
public float pointLightOuterAngle { get; set; }
Property Value
Type Description
Single

pointLightOuterRadius

Declaration
public float pointLightOuterRadius { get; set; }
Property Value
Type Description
Single

shadowIntensity

Specifies the darkness of the shadow

Declaration
public float shadowIntensity { get; set; }
Property Value
Type Description
Single

shadowsEnabled

Specifies that the shadows are enabled

Declaration
public bool shadowsEnabled { get; set; }
Property Value
Type Description
Boolean

shadowVolumeIntensity

Specifies the darkness of the shadow

Declaration
public float shadowVolumeIntensity { get; set; }
Property Value
Type Description
Single

shapeLightFalloffSize

Declaration
public float shapeLightFalloffSize { get; }
Property Value
Type Description
Single

shapeLightParametricAngleOffset

Declaration
public float shapeLightParametricAngleOffset { get; }
Property Value
Type Description
Single

shapeLightParametricRadius

Declaration
public float shapeLightParametricRadius { get; }
Property Value
Type Description
Single

shapeLightParametricSides

Declaration
public int shapeLightParametricSides { get; }
Property Value
Type Description
Int32

shapePath

Declaration
public Vector3[] shapePath { get; }
Property Value
Type Description
Vector3[]

volumeIntensity

Declaration
public float volumeIntensity { get; }
Property Value
Type Description
Single

volumeIntensityEnabled

Declaration
public bool volumeIntensityEnabled { get; set; }
Property Value
Type Description
Boolean

volumetricShadowsEnabled

Specifies that the volumetric shadows are enabled

Declaration
public bool volumetricShadowsEnabled { get; set; }
Property Value
Type Description
Boolean

Methods

OnAfterDeserialize()

Declaration
public void OnAfterDeserialize()
Implements

OnBeforeSerialize()

Declaration
public void OnBeforeSerialize()
Implements