diff options
author | RĂ©mi Verschelde <remi@verschelde.fr> | 2021-10-28 16:05:55 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-10-28 16:05:55 +0200 |
commit | e2deec67b9b3258f1c4fc7ee8c9a375676a0571a (patch) | |
tree | 0acf54e7ea1b7b3defb52032db7ca1eb01935bfb /doc/classes | |
parent | 6b090e325a49ab9a890700925873f33232d06b2b (diff) | |
parent | c571e4a7f4a5cc34fa9b7efeff37ee69fcf6249d (diff) |
Merge pull request #54222 from JFonS/instance-fade
Diffstat (limited to 'doc/classes')
-rw-r--r-- | doc/classes/GeometryInstance3D.xml | 17 | ||||
-rw-r--r-- | doc/classes/RenderingServer.xml | 18 |
2 files changed, 34 insertions, 1 deletions
diff --git a/doc/classes/GeometryInstance3D.xml b/doc/classes/GeometryInstance3D.xml index 97cef205c3..0a2c0fbe81 100644 --- a/doc/classes/GeometryInstance3D.xml +++ b/doc/classes/GeometryInstance3D.xml @@ -49,6 +49,9 @@ The material override for the whole geometry. If a material is assigned to this property, it will be used instead of any material set in any material slot of the mesh. </member> + <member name="transparency" type="float" setter="set_transparency" getter="get_transparency" default="0.0"> + Transparency applied to the whole geometry. In spatial shaders, transparency is set as the default value of the [code]ALPHA[/code] built-in. + </member> <member name="visibility_range_begin" type="float" setter="set_visibility_range_begin" getter="get_visibility_range_begin" default="0.0"> Starting distance from which the GeometryInstance3D will be visible, taking [member visibility_range_begin_margin] into account as well. The default value of 0 is used to disable the range check. </member> @@ -56,11 +59,14 @@ Margin for the [member visibility_range_begin] threshold. The GeometryInstance3D will only change its visibility state when it goes over or under the [member visibility_range_begin] threshold by this amount. </member> <member name="visibility_range_end" type="float" setter="set_visibility_range_end" getter="get_visibility_range_end" default="0.0"> - Distance from which the GeometryInstance3D will be hidden, taking [member visibility_range_end_margin] into account as well. The default value of 0 is used to disable the range check.. + Distance from which the GeometryInstance3D will be hidden, taking [member visibility_range_end_margin] into account as well. The default value of 0 is used to disable the range check. </member> <member name="visibility_range_end_margin" type="float" setter="set_visibility_range_end_margin" getter="get_visibility_range_end_margin" default="0.0"> Margin for the [member visibility_range_end] threshold. The GeometryInstance3D will only change its visibility state when it goes over or under the [member visibility_range_end] threshold by this amount. </member> + <member name="visibility_range_fade_mode" type="int" setter="set_visibility_range_fade_mode" getter="get_visibility_range_fade_mode" enum="GeometryInstance3D.VisibilityRangeFadeMode" default="0"> + Controls which instances will be faded when approaching the limits of the visibility range. See [enum VisibilityRangeFadeMode] for possible values. + </member> </members> <constants> <constant name="SHADOW_CASTING_SETTING_OFF" value="0" enum="ShadowCastingSetting"> @@ -94,5 +100,14 @@ </constant> <constant name="LIGHTMAP_SCALE_MAX" value="4" enum="LightmapScale"> </constant> + <constant name="VISIBILITY_RANGE_FADE_DISABLED" value="0" enum="VisibilityRangeFadeMode"> + Will not fade itself nor its visibility dependencies, hysteresis will be used instead. See [member visibility_range_begin] and [member Node3D.visibility_parent] for more information. + </constant> + <constant name="VISIBILITY_RANGE_FADE_SELF" value="1" enum="VisibilityRangeFadeMode"> + Will fade-out itself when reaching the limits of its own visibility range. The fading range is determined by [member visibility_range_begin_margin] and [member visibility_range_end_margin]. + </constant> + <constant name="VISIBILITY_RANGE_FADE_DEPENDENCIES" value="2" enum="VisibilityRangeFadeMode"> + Will fade-in its visibility dependencies (see [member Node3D.visibility_parent]) when reaching the limits of its own visibility range. The fading range is determined by [member visibility_range_begin_margin] and [member visibility_range_end_margin]. + </constant> </constants> </class> diff --git a/doc/classes/RenderingServer.xml b/doc/classes/RenderingServer.xml index 973f8cdb1e..b53233add5 100644 --- a/doc/classes/RenderingServer.xml +++ b/doc/classes/RenderingServer.xml @@ -1377,6 +1377,14 @@ <description> </description> </method> + <method name="instance_geometry_set_transparency"> + <return type="void" /> + <argument index="0" name="instance" type="RID" /> + <argument index="1" name="transparency" type="float" /> + <description> + Sets the transparency for the given geometry instance. Equivalent to [member GeometryInstance3D.transparency]. + </description> + </method> <method name="instance_geometry_set_visibility_range"> <return type="void" /> <argument index="0" name="instance" type="RID" /> @@ -1384,6 +1392,7 @@ <argument index="2" name="max" type="float" /> <argument index="3" name="min_margin" type="float" /> <argument index="4" name="max_margin" type="float" /> + <argument index="5" name="fade_mode" type="int" enum="RenderingServer.VisibilityRangeFadeMode" /> <description> Sets the visibility range values for the given geometry instance. Equivalent to [member GeometryInstance3D.visibility_range_begin] and related properties. </description> @@ -4178,6 +4187,15 @@ <constant name="SHADOW_CASTING_SETTING_SHADOWS_ONLY" value="3" enum="ShadowCastingSetting"> Only render the shadows from the object. The object itself will not be drawn. </constant> + <constant name="VISIBILITY_RANGE_FADE_DISABLED" value="0" enum="VisibilityRangeFadeMode"> + Disable visibility range fading for the given instance. + </constant> + <constant name="VISIBILITY_RANGE_FADE_SELF" value="1" enum="VisibilityRangeFadeMode"> + Fade-out the given instance when it approaches its visibility range limits. + </constant> + <constant name="VISIBILITY_RANGE_FADE_DEPENDENCIES" value="2" enum="VisibilityRangeFadeMode"> + Fade-in the given instance's dependencies when reaching its visibility range limits. + </constant> <constant name="BAKE_CHANNEL_ALBEDO_ALPHA" value="0" enum="BakeChannels"> </constant> <constant name="BAKE_CHANNEL_NORMAL" value="1" enum="BakeChannels"> |