Merge pull request #110423 from Calinou/doc-light3d-cull-mask-gi

Document the interaction between Light3D cull mask and GI/volumetric fog
This commit is contained in:
Thaddeus Crews 2025-09-18 12:42:26 -05:00
commit d5512dfe71
No known key found for this signature in database
GPG key ID: 8C6E5FEB5FC03CCC

View file

@ -68,6 +68,7 @@
</member> </member>
<member name="light_cull_mask" type="int" setter="set_cull_mask" getter="get_cull_mask" default="4294967295"> <member name="light_cull_mask" type="int" setter="set_cull_mask" getter="get_cull_mask" default="4294967295">
The light will affect objects in the selected layers. The light will affect objects in the selected layers.
[b]Note:[/b] The light cull mask is ignored by [VoxelGI], SDFGI, [LightmapGI], and volumetric fog. These will always render lights in a way that ignores the cull mask. See also [member VisualInstance3D.layers].
</member> </member>
<member name="light_energy" type="float" setter="set_param" getter="get_param" default="1.0"> <member name="light_energy" type="float" setter="set_param" getter="get_param" default="1.0">
The light's strength multiplier (this is not a physical unit). For [OmniLight3D] and [SpotLight3D], changing this value will only change the light color's intensity, not the light's radius. The light's strength multiplier (this is not a physical unit). For [OmniLight3D] and [SpotLight3D], changing this value will only change the light color's intensity, not the light's radius.