Nixyri/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-11-10 14:12:51 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc: Sync classref with current source

Browse Source
This commit is contained in:
Rémi Verschelde 2021-02-08 12:34:28 +01:00
parent 332a33503b
commit 9b623635c8
No known key found for this signature in database
GPG Key ID: C3336907360768E1
5 changed files with 35 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/classes/Environment.xml
View File

@ -265,7 +265,9 @@
</member>
<member name="volumetric_fog_light_energy" type="float" setter="set_volumetric_fog_light_energy" getter="get_volumetric_fog_light_energy" default="1.0">
</member>
<member name="volumetric_fog_shadow_filter" type="int" setter="set_volumetric_fog_shadow_filter" getter="get_volumetric_fog_shadow_filter" enum="Environment.VolumetricFogShadowFilter" default="1">
<member name="volumetric_fog_temporal_reprojection_amount" type="float" setter="set_volumetric_fog_temporal_reprojection_amount" getter="get_volumetric_fog_temporal_reprojection_amount" default="0.9">
</member>
<member name="volumetric_fog_temporal_reprojection_enabled" type="bool" setter="set_volumetric_fog_temporal_reprojection_enabled" getter="is_volumetric_fog_temporal_reprojection_enabled" default="true">
</member>
</members>
<constants>

2
doc/classes/Light3D.xml
View File

@ -78,7 +78,7 @@
<member name="shadow_enabled" type="bool" setter="set_shadow" getter="has_shadow" default="false">
If [code]true[/code], the light will cast shadows.
</member>
<member name="shadow_fog_fade" type="float" setter="set_param" getter="get_param" default="1.0">
<member name="shadow_fog_fade" type="float" setter="set_param" getter="get_param" default="0.1">
</member>
<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.

9
doc/classes/ProjectSettings.xml
View File

@ -1088,9 +1088,6 @@
</member>
<member name="rendering/lightmapper/probe_capture_update_speed" type="float" setter="" getter="" default="15">
</member>
<member name="rendering/limits/rendering/max_renderable_elements" type="int" setter="" getter="" default="128000">
Max amount of elements renderable in a frame. If more than this are visible per frame, they will be dropped. Keep in mind elements refer to mesh surfaces and not meshes themselves.
</member>
<member name="rendering/limits/time/time_rollover_secs" type="float" setter="" getter="" default="3600">
</member>
<member name="rendering/quality/2d/snap_2d_transforms_to_pixel" type="bool" setter="" getter="" default="false">
@ -1306,11 +1303,7 @@
<member name="rendering/threads/thread_model" type="int" setter="" getter="" default="1">
Thread model for rendering. Rendering on a thread can vastly improve performance, but synchronizing to the main thread can cause a bit more jitter.
</member>
<member name="rendering/volumetric_fog/directional_shadow_shrink" type="int" setter="" getter="" default="512">
</member>
<member name="rendering/volumetric_fog/positional_shadow_shrink" type="int" setter="" getter="" default="512">
</member>
<member name="rendering/volumetric_fog/use_filter" type="int" setter="" getter="" default="0">
<member name="rendering/volumetric_fog/use_filter" type="int" setter="" getter="" default="1">
</member>
<member name="rendering/volumetric_fog/volume_depth" type="int" setter="" getter="" default="128">
</member>

32
doc/classes/RenderingDevice.xml
View File

@ -74,6 +74,8 @@
<method name="compute_list_begin">
<return type="int">
</return>
<argument index="0" name="allow_draw_overlap" type="bool" default="false">
</argument>
<description>
</description>
</method>
@ -443,6 +445,24 @@
<description>
</description>
</method>
<method name="get_device_name" qualifiers="const">
<return type="String">
</return>
<description>
</description>
</method>
<method name="get_device_pipeline_cache_uuid" qualifiers="const">
<return type="String">
</return>
<description>
</description>
</method>
<method name="get_device_vendor_name" qualifiers="const">
<return type="String">
</return>
<description>
</description>
</method>
<method name="get_frame_delay" qualifiers="const">
<return type="int">
</return>
@ -823,6 +843,8 @@
</constant>
<constant name="BARRIER_MASK_ALL" value="7">
</constant>
<constant name="BARRIER_MASK_NO_BARRIER" value="8">
</constant>
<constant name="DATA_FORMAT_R4G4_UNORM_PACK8" value="0" enum="DataFormat">
</constant>
<constant name="DATA_FORMAT_R4G4B4A4_UNORM_PACK16" value="1" enum="DataFormat">
@ -1587,13 +1609,15 @@
</constant>
<constant name="INITIAL_ACTION_CLEAR_REGION" value="1" enum="InitialAction">
</constant>
<constant name="INITIAL_ACTION_KEEP" value="2" enum="InitialAction">
<constant name="INITIAL_ACTION_CLEAR_REGION_CONTINUE" value="2" enum="InitialAction">
</constant>
<constant name="INITIAL_ACTION_DROP" value="3" enum="InitialAction">
<constant name="INITIAL_ACTION_KEEP" value="3" enum="InitialAction">
</constant>
<constant name="INITIAL_ACTION_CONTINUE" value="4" enum="InitialAction">
<constant name="INITIAL_ACTION_DROP" value="4" enum="InitialAction">
</constant>
<constant name="INITIAL_ACTION_MAX" value="5" enum="InitialAction">
<constant name="INITIAL_ACTION_CONTINUE" value="5" enum="InitialAction">
</constant>
<constant name="INITIAL_ACTION_MAX" value="6" enum="InitialAction">
</constant>
<constant name="FINAL_ACTION_READ" value="0" enum="FinalAction">
</constant>

4
doc/classes/SyntaxHighlighter.xml
View File

@ -15,7 +15,7 @@
<return type="void">
</return>
<description>
Virtual method which can be overridden to clear any local caches.
Virtual method which can be overridden to clear any local caches.
</description>
</method>
<method name="_get_line_syntax_highlighting" qualifiers="virtual">
@ -32,7 +32,7 @@
<return type="void">
</return>
<description>
Virtual method which can be overridden to update any local caches.
Virtual method which can be overridden to update any local caches.
</description>
</method>
<method name="clear_highlighting_cache">