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 (Experimental)")]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.render-pipelines.universal@latest/index.html?subfolder=/manual/2DLightProperties.html")]
public sealed class Light2D : MonoBehaviour

Properties

alphaBlendOnOverlap

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

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

pointLightDistance

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

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

pointLightQuality

Declaration
public Light2D.PointLightQuality pointLightQuality { get; }
Property Value
Type Description
Light2D.PointLightQuality

shadowIntensity

Specifies the darkness of the shadow

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

shadowVolumeIntensity

Specifies the darkness of the shadow

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

shapeLightFalloffOffset

Declaration
public Vector2 shapeLightFalloffOffset { get; }
Property Value
Type Description
Vector2

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[]

useNormalMap

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

volumeOpacity

The lights current intensity

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