Class Light

Inheritance
Object
Object
Component
Behaviour
Light
Inherited Members
Namespace: UnityEngine
Assembly: UnityEngine.dll
Syntax
[RequireComponent(typeof(Transform))]
[RequireComponent(typeof(Transform))]
public sealed class Light : Behaviour

Properties

| Improve this Doc View Source

alreadyLightmapped

Declaration
[Obsolete("Light.alreadyLightmapped is no longer supported. Use Light.bakingOutput instead. Allowing to describe mixed light on top of realtime and baked ones.", false)]
public bool alreadyLightmapped { get; set; }
Property Value
Type Description
Boolean

areaSize

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

attenuate

Declaration
[Obsolete("light.attenuate was removed; all lights always attenuate now", true)]
public bool attenuate { get; set; }
Property Value
Type Description
Boolean

bakingOutput

Declaration
public LightBakingOutput bakingOutput { get; set; }
Property Value
Type Description
LightBakingOutput

bounceIntensity

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

color

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

colorTemperature

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

commandBufferCount

Declaration
public int commandBufferCount { get; }
Property Value
Type Description
Int32
Declaration
public Texture cookie { get; set; }
Property Value
Type Description
Texture

cookieSize

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

cullingMask

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

flare

Declaration
public Flare flare { get; set; }
Property Value
Type Description
Flare

intensity

Declaration
public float intensity { get; set; }
Property Value
Type Description
Single
| Improve this Doc View Source

isBaked

Declaration
[Obsolete("Light.isBaked is no longer supported. Use Light.bakingOutput.isBaked (and other members of Light.bakingOutput) instead.", false)]
public bool isBaked { get; }
Property Value
Type Description
Boolean

layerShadowCullDistances

Declaration
public float[] layerShadowCullDistances { get; set; }
Property Value
Type Description
Single[]

lightmapBakeType

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

lightmappingMode

Declaration
[Obsolete("Light.lightmappingMode has been deprecated. Use Light.lightmapBakeType instead (UnityUpgradable) -> lightmapBakeType", true)]
public LightmappingMode lightmappingMode { get; set; }
Property Value
Type Description
LightmappingMode

lightShadowCasterMode

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

pixelLightCount

Declaration
[Obsolete("Use QualitySettings.pixelLightCount instead.")]
public static int pixelLightCount { get; set; }
Property Value
Type Description
Int32

range

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

renderMode

Declaration
public LightRenderMode renderMode { get; set; }
Property Value
Type Description
LightRenderMode

shadowAngle

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

shadowBias

Declaration
public float shadowBias { get; set; }
Property Value
Type Description
Single
| Improve this Doc View Source

shadowConstantBias

Declaration
[Obsolete("light.shadowConstantBias was removed, use light.shadowBias", true)]
public float shadowConstantBias { get; set; }
Property Value
Type Description
Single

shadowCustomResolution

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

shadowNearPlane

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

shadowNormalBias

Declaration
public float shadowNormalBias { get; set; }
Property Value
Type Description
Single
| Improve this Doc View Source

shadowObjectSizeBias

Declaration
[Obsolete("light.shadowObjectSizeBias was removed, use light.shadowBias", true)]
public float shadowObjectSizeBias { get; set; }
Property Value
Type Description
Single

shadowRadius

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

shadowResolution

Declaration
public LightShadowResolution shadowResolution { get; set; }
Property Value
Type Description
LightShadowResolution

shadows

Declaration
public LightShadows shadows { get; set; }
Property Value
Type Description
LightShadows

shadowStrength

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

spotAngle

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

type

Declaration
public LightType type { get; set; }
Property Value
Type Description
LightType

Methods

| Improve this Doc View Source

AddCommandBuffer(LightEvent, CommandBuffer)

Declaration
public void AddCommandBuffer(LightEvent evt, CommandBuffer buffer)
Parameters
Type Name Description
LightEvent evt
CommandBuffer buffer

AddCommandBuffer(LightEvent, CommandBuffer, ShadowMapPass)

Declaration
public void AddCommandBuffer(LightEvent evt, CommandBuffer buffer, ShadowMapPass shadowPassMask)
Parameters
Type Name Description
LightEvent evt
CommandBuffer buffer
ShadowMapPass shadowPassMask
| Improve this Doc View Source

AddCommandBufferAsync(LightEvent, CommandBuffer, ComputeQueueType)

Declaration
public void AddCommandBufferAsync(LightEvent evt, CommandBuffer buffer, ComputeQueueType queueType)
Parameters
Type Name Description
LightEvent evt
CommandBuffer buffer
ComputeQueueType queueType

AddCommandBufferAsync(LightEvent, CommandBuffer, ShadowMapPass, ComputeQueueType)

Declaration
public void AddCommandBufferAsync(LightEvent evt, CommandBuffer buffer, ShadowMapPass shadowPassMask, ComputeQueueType queueType)
Parameters
Type Name Description
LightEvent evt
CommandBuffer buffer
ShadowMapPass shadowPassMask
ComputeQueueType queueType

GetCommandBuffers(LightEvent)

Declaration
public CommandBuffer[] GetCommandBuffers(LightEvent evt)
Parameters
Type Name Description
LightEvent evt
Returns
Type Description
CommandBuffer[]

GetLights(LightType, Int32)

Declaration
public static Light[] GetLights(LightType type, int layer)
Parameters
Type Name Description
LightType type
Int32 layer
Returns
Type Description
Light[]

RemoveAllCommandBuffers()

Declaration
public void RemoveAllCommandBuffers()

RemoveCommandBuffer(LightEvent, CommandBuffer)

Declaration
public void RemoveCommandBuffer(LightEvent evt, CommandBuffer buffer)
Parameters
Type Name Description
LightEvent evt
CommandBuffer buffer

RemoveCommandBuffers(LightEvent)

Declaration
public void RemoveCommandBuffers(LightEvent evt)
Parameters
Type Name Description
LightEvent evt

Reset()

Declaration
public void Reset()

SetLightDirty()

Declaration
public void SetLightDirty()

Extension Methods