asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

doc: Sync classref with current source

Browse source
This commit is contained in:
Rémi Verschelde 2020-06-25 10:51:46 +02:00
parent e8706848e6
commit 2446dbfba1
5 changed files with 20 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/classes/DirectionalLight3D.xml
View file

@ -39,6 +39,8 @@
<member name="directional_shadow_split_3" type="float" setter="set_param" getter="get_param" default="0.5"> <member name="directional_shadow_split_3" type="float" setter="set_param" getter="get_param" default="0.5">
The distance from shadow split 2 to split 3. Relative to [member directional_shadow_max_distance]. Only used when [member directional_shadow_mode] is [code]SHADOW_PARALLEL_4_SPLITS[/code]. The distance from shadow split 2 to split 3. Relative to [member directional_shadow_max_distance]. Only used when [member directional_shadow_mode] is [code]SHADOW_PARALLEL_4_SPLITS[/code].
</member> </member>
<member name="shadow_bias" type="float" setter="set_param" getter="get_param" override="true" default="0.05" />
<member name="shadow_normal_bias" type="float" setter="set_param" getter="get_param" override="true" default="1.0" />
</members> </members>
<constants> <constants>
<constant name="SHADOW_ORTHOGONAL" value="0" enum="ShadowMode"> <constant name="SHADOW_ORTHOGONAL" value="0" enum="ShadowMode">

4
doc/classes/Light3D.xml
View file

@ -65,7 +65,7 @@
<member name="light_specular" type="float" setter="set_param" getter="get_param" default="0.5"> <member name="light_specular" type="float" setter="set_param" getter="get_param" default="0.5">
The intensity of the specular blob in objects affected by the light. At [code]0[/code], the light becomes a pure diffuse light. When not baking emission, this can be used to avoid unrealistic reflections when placing lights above an emissive surface. The intensity of the specular blob in objects affected by the light. At [code]0[/code], the light becomes a pure diffuse light. When not baking emission, this can be used to avoid unrealistic reflections when placing lights above an emissive surface.
</member> </member>
<member name="shadow_bias" type="float" setter="set_param" getter="get_param" default="0.02"> <member name="shadow_bias" type="float" setter="set_param" getter="get_param" default="0.1">
Used to adjust shadow appearance. Too small a value results in self-shadowing ("shadow acne"), while too large a value causes shadows to separate from casters ("peter-panning"). Adjust as needed. Used to adjust shadow appearance. Too small a value results in self-shadowing ("shadow acne"), while too large a value causes shadows to separate from casters ("peter-panning"). Adjust as needed.
</member> </member>
<member name="shadow_blur" type="float" setter="set_param" getter="get_param" default="1.0"> <member name="shadow_blur" type="float" setter="set_param" getter="get_param" default="1.0">
@ -77,7 +77,7 @@
<member name="shadow_enabled" type="bool" setter="set_shadow" getter="has_shadow" default="false"> <member name="shadow_enabled" type="bool" setter="set_shadow" getter="has_shadow" default="false">
If [code]true[/code], the light will cast shadows. If [code]true[/code], the light will cast shadows.
</member> </member>
<member name="shadow_normal_bias" type="float" setter="set_param" getter="get_param" default="1.0"> <member name="shadow_normal_bias" type="float" setter="set_param" getter="get_param" default="2.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. 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>
<member name="shadow_reverse_cull_face" type="bool" setter="set_shadow_reverse_cull_face" getter="get_shadow_reverse_cull_face" default="false"> <member name="shadow_reverse_cull_face" type="bool" setter="set_shadow_reverse_cull_face" getter="get_shadow_reverse_cull_face" default="false">

2
doc/classes/RichTextLabel.xml
View file

@ -52,7 +52,7 @@
Clears the tag stack and sets [member bbcode_text] to an empty string. Clears the tag stack and sets [member bbcode_text] to an empty string.
</description> </description>
</method> </method>
<method name="get_content_height"> <method name="get_content_height" qualifiers="const">
<return type="int"> <return type="int">
</return> </return>
<description> <description>

2
doc/classes/SpotLight3D.xml
View file

@ -12,6 +12,8 @@
<methods> <methods>
</methods> </methods>
<members> <members>
<member name="shadow_bias" type="float" setter="set_param" getter="get_param" override="true" default="0.02" />
<member name="shadow_normal_bias" type="float" setter="set_param" getter="get_param" override="true" default="1.0" />
<member name="spot_angle" type="float" setter="set_param" getter="get_param" default="45.0"> <member name="spot_angle" type="float" setter="set_param" getter="get_param" default="45.0">
The spotlight's angle in degrees. The spotlight's angle in degrees.
</member> </member>

13
doc/classes/VisualShaderNodeTexture2DArrayUniform.xml Normal file
View file

@ -0,0 +1,13 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualShaderNodeTexture2DArrayUniform" inherits="VisualShaderNodeTextureUniform" version="4.0">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<constants>
</constants>
</class>