Class Light2D
Class Light2D is a 2D light which can be used with the 2D Renderer.
Inherited Members
UnityEngine.Object.FindObjectsOfType<T>(System.Boolean)
UnityEngine.Object.FindObjectOfType<T>(System.Boolean)
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
color
Declaration
public Color color { get; set; }
Property Value
falloffIntensity
Declaration
public float falloffIntensity { get; }
Property Value
intensity
The lights current intensity
Declaration
public float intensity { get; set; }
Property Value
lightCookieSprite
Declaration
public Sprite lightCookieSprite { get; }
Property Value
lightOrder
Declaration
public int lightOrder { get; set; }
Property Value
lightType
Declaration
public Light2D.LightType lightType { get; set; }
Property Value
normalMapDistance
Declaration
public float normalMapDistance { get; }
Property Value
normalMapQuality
Declaration
public Light2D.NormalMapQuality normalMapQuality { get; }
Property Value
overlapOperation
Declaration
public Light2D.OverlapOperation overlapOperation { get; }
Property Value
pointLightInnerAngle
Declaration
public float pointLightInnerAngle { get; set; }
Property Value
pointLightInnerRadius
Declaration
public float pointLightInnerRadius { get; set; }
Property Value
pointLightOuterAngle
Declaration
public float pointLightOuterAngle { get; set; }
Property Value
pointLightOuterRadius
Declaration
public float pointLightOuterRadius { get; set; }
Property Value
shadowIntensity
Specifies the darkness of the shadow
Declaration
public float shadowIntensity { get; set; }
Property Value
shadowsEnabled
Specifies that the shadows are enabled
Declaration
public bool shadowsEnabled { get; set; }
Property Value
shadowVolumeIntensity
Specifies the darkness of the shadow
Declaration
public float shadowVolumeIntensity { get; set; }
Property Value
shapeLightFalloffSize
Declaration
public float shapeLightFalloffSize { get; }
Property Value
shapeLightParametricAngleOffset
Declaration
public float shapeLightParametricAngleOffset { get; }
Property Value
shapeLightParametricRadius
Declaration
public float shapeLightParametricRadius { get; }
Property Value
shapeLightParametricSides
Declaration
public int shapeLightParametricSides { get; }
Property Value
shapePath
Declaration
public Vector3[] shapePath { get; }
Property Value
volumeIntensity
Declaration
public float volumeIntensity { get; }
Property Value
volumeIntensityEnabled
Declaration
public bool volumeIntensityEnabled { get; set; }
Property Value
volumetricShadowsEnabled
Specifies that the volumetric shadows are enabled
Declaration
public bool volumetricShadowsEnabled { get; set; }
Property Value
Methods
OnAfterDeserialize()
Declaration
public void OnAfterDeserialize()
Implements
OnBeforeSerialize()
Declaration
public void OnBeforeSerialize()
Implements
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.