Version: 2022.3
LanguageEnglish
  • C#
Experimental: this API is experimental and might be changed or removed in the future.

LightDataGI

struct in UnityEngine.Experimental.GlobalIllumination

/

Implemented in:UnityEngine.CoreModule

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

The interop structure to pass light information to the light baking backends. There are helper structures for Directional, Point, Spot and Rectangle lights to correctly initialize this structure.

Properties

colorThe color of the light.
coneAngleThe cone angle for spot lights.
cookieIDThe cookie texture's instance id projected by the light.
cookieScaleThe uniform scale factor for downscaling cookies during lightmapping. Can be used as an optimization when full resolution cookies are not needed for indirect lighting.
falloffThe falloff model to use for baking point and spot lights.
indirectColorThe indirect color of the light.
innerConeAngleThe inner cone angle for spot lights.
instanceIDThe light's instanceID.
modeThe lightmap mode for the light.
orientationThe orientation of the light.
positionThe position of the light.
rangeThe range of the light. Unused for directional lights.
shadowSet to 1 for shadow casting lights, 0 otherwise.
shape0The light's sphere radius for point and spot lights, or the width for rectangle lights.
shape1The height for rectangle lights.
typeThe type of the light.

Public Methods

InitInitialize the struct with the parameters from the given light type.
InitNoBakeInitialize a light so that the baking backends ignore it.