diff options
Diffstat (limited to 'doc/classes/Light3D.xml')
| -rw-r--r-- | doc/classes/Light3D.xml | 24 |
1 files changed, 15 insertions, 9 deletions
diff --git a/doc/classes/Light3D.xml b/doc/classes/Light3D.xml index 0ebd83c882..80ff83ec46 100644 --- a/doc/classes/Light3D.xml +++ b/doc/classes/Light3D.xml @@ -13,15 +13,15 @@ <methods> <method name="get_param" qualifiers="const"> <return type="float" /> - <argument index="0" name="param" type="int" enum="Light3D.Param" /> + <param index="0" name="param" type="int" enum="Light3D.Param" /> <description> Returns the value of the specified [enum Light3D.Param] parameter. </description> </method> <method name="set_param"> <return type="void" /> - <argument index="0" name="param" type="int" enum="Light3D.Param" /> - <argument index="1" name="value" type="float" /> + <param index="0" name="param" type="int" enum="Light3D.Param" /> + <param index="1" name="value" type="float" /> <description> Sets the value of the specified [enum Light3D.Param] parameter. </description> @@ -37,13 +37,12 @@ [b]Note:[/b] Only effective for [OmniLight3D] and [SpotLight3D]. </member> <member name="distance_fade_length" type="float" setter="set_distance_fade_length" getter="get_distance_fade_length" default="10.0"> - Distance over which the light fades. The light's energy is progressively reduced over this distance and is completely invisible at the end. + Distance over which the light and its shadow fades. The light's energy and shadow's opacity is progressively reduced over this distance and is completely invisible at the end. [b]Note:[/b] Only effective for [OmniLight3D] and [SpotLight3D]. </member> <member name="distance_fade_shadow" type="float" setter="set_distance_fade_shadow" getter="get_distance_fade_shadow" default="50.0"> The distance from the camera at which the light's shadow cuts off (in 3D units). Set this to a value lower than [member distance_fade_begin] + [member distance_fade_length] to further improve performance, as shadow rendering is often more expensive than light rendering itself. [b]Note:[/b] Only effective for [OmniLight3D] and [SpotLight3D], and only when [member shadow_enabled] is [code]true[/code]. - [b]Note:[/b] Due to a rendering engine limitation, shadows will be disabled instantly instead of fading smoothly according to [member distance_fade_length]. This may result in visible pop-in depending on the scene topography. </member> <member name="editor_only" type="bool" setter="set_editor_only" getter="is_editor_only" default="false"> If [code]true[/code], the light only appears in the editor and will not be visible at runtime. @@ -95,6 +94,9 @@ <member name="shadow_normal_bias" type="float" setter="set_param" getter="get_param" default="1.0"> Offsets the lookup into the shadow map by the object's normal. This can be used to reduce self-shadowing artifacts without using [member shadow_bias]. In practice, this value should be tweaked along with [member shadow_bias] to reduce artifacts as much as possible. </member> + <member name="shadow_opacity" type="float" setter="set_param" getter="get_param" default="1.0"> + The opacity to use when rendering the light's shadow map. Values lower than [code]1.0[/code] make the light appear through shadows. This can be used to fake global illumination at a low performance cost. + </member> <member name="shadow_reverse_cull_face" type="bool" setter="set_shadow_reverse_cull_face" getter="get_shadow_reverse_cull_face" default="false"> If [code]true[/code], reverses the backface culling of the mesh. This can be useful when you have a flat mesh that has a light behind it. If you need to cast a shadow on both sides of the mesh, set the mesh to use double-sided shadows with [constant GeometryInstance3D.SHADOW_CASTING_SETTING_DOUBLE_SIDED]. </member> @@ -150,15 +152,19 @@ <constant name="PARAM_SHADOW_PANCAKE_SIZE" value="15" enum="Param"> Constant for accessing [member DirectionalLight3D.directional_shadow_pancake_size]. </constant> - <constant name="PARAM_SHADOW_BLUR" value="16" enum="Param"> + <constant name="PARAM_SHADOW_OPACITY" value="16" enum="Param"> + Constant for accessing [member shadow_opacity]. + </constant> + <constant name="PARAM_SHADOW_BLUR" value="17" enum="Param"> Constant for accessing [member shadow_blur]. </constant> - <constant name="PARAM_SHADOW_VOLUMETRIC_FOG_FADE" value="17" enum="Param"> + <constant name="PARAM_SHADOW_VOLUMETRIC_FOG_FADE" value="18" enum="Param"> + Constant for accessing [member shadow_fog_fade]. </constant> - <constant name="PARAM_TRANSMITTANCE_BIAS" value="18" enum="Param"> + <constant name="PARAM_TRANSMITTANCE_BIAS" value="19" enum="Param"> Constant for accessing [member shadow_transmittance_bias]. </constant> - <constant name="PARAM_MAX" value="19" enum="Param"> + <constant name="PARAM_MAX" value="20" enum="Param"> Represents the size of the [enum Param] enum. </constant> <constant name="BAKE_DISABLED" value="0" enum="BakeMode"> |