godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #45522 from akien-mga/doc-sync 

doc: Sync classref with current source
This commit is contained in:
Rémi Verschelde 2021-01-28 12:13:40 +01:00 committed by GitHub
parent b441592372 fb01d057af
commit 726967f453
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
15 changed files with 157 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/classes/ArrayMesh.xml
View File

@ -215,6 +215,8 @@
<member name="custom_aabb" type="AABB" setter="set_custom_aabb" getter="get_custom_aabb" default="AABB( 0, 0, 0, 0, 0, 0 )">
Overrides the [AABB] with one defined by user for use with frustum culling. Especially useful to avoid unexpected culling when using a shader to offset vertices.
</member>
<member name="shadow_mesh" type="ArrayMesh" setter="set_shadow_mesh" getter="get_shadow_mesh">
</member>
</members>
<constants>
</constants>

6
doc/classes/LineEdit.xml
View File

@ -383,12 +383,12 @@
<theme_item name="font_selected_color" type="Color" default="Color( 0, 0, 0, 1 )">
Font color for selected text (inside the selection rectangle).
</theme_item>
<theme_item name="font_uneditable_color" type="Color" default="Color( 0.88, 0.88, 0.88, 0.5 )">
Font color when editing is disabled.
</theme_item>
<theme_item name="font_size" type="int">
Font size of the [LineEdit]'s text.
</theme_item>
<theme_item name="font_uneditable_color" type="Color" default="Color( 0.88, 0.88, 0.88, 0.5 )">
Font color when editing is disabled.
</theme_item>
<theme_item name="minimum_spaces" type="int" default="12">
Minimum horizontal space for the text (not counting the clear button and content margins). This value is measured in count of space characters (i.e. this amount of space characters can be displayed without scrolling).
</theme_item>

6
doc/classes/Material.xml
View File

@ -11,6 +11,12 @@
<link title="Third Person Shooter Demo">https://godotengine.org/asset-library/asset/678</link>
</tutorials>
<methods>
<method name="inspect_native_shader_code">
<return type="void">
</return>
<description>
</description>
</method>
</methods>
<members>
<member name="next_pass" type="Material" setter="set_next_pass" getter="get_next_pass">

16
doc/classes/OS.xml
View File

@ -136,14 +136,6 @@
Returns the keycode of the given string (e.g. "Escape").
</description>
</method>
<method name="get_thread_caller_id" qualifiers="const">
<return type="int">
</return>
<description>
Returns the ID of the current thread. This can be used in logs to ease debugging of multi-threaded applications.
[b]Note:[/b] Thread IDs are not deterministic and may be reused across application restarts.
</description>
</method>
<method name="get_cmdline_args">
<return type="PackedStringArray">
</return>
@ -330,6 +322,14 @@
[b]Note:[/b] This method is implemented on Windows.
</description>
</method>
<method name="get_thread_caller_id" qualifiers="const">
<return type="int">
</return>
<description>
Returns the ID of the current thread. This can be used in logs to ease debugging of multi-threaded applications.
[b]Note:[/b] Thread IDs are not deterministic and may be reused across application restarts.
</description>
</method>
<method name="get_ticks_msec" qualifiers="const">
<return type="int">
</return>

6
doc/classes/PopupMenu.xml
View File

@ -717,12 +717,12 @@
<theme_item name="font" type="Font">
[Font] used for the menu items.
</theme_item>
<theme_item name="font_color" type="Color" default="Color( 0.88, 0.88, 0.88, 1 )">
The default text [Color] for menu items' names.
</theme_item>
<theme_item name="font_accelerator_color" type="Color" default="Color( 0.7, 0.7, 0.7, 0.8 )">
The text [Color] used for shortcuts and accelerators that show next to the menu item name when defined. See [method get_item_accelerator] for more info on accelerators.
</theme_item>
<theme_item name="font_color" type="Color" default="Color( 0.88, 0.88, 0.88, 1 )">
The default text [Color] for menu items' names.
</theme_item>
<theme_item name="font_disabled_color" type="Color" default="Color( 0.4, 0.4, 0.4, 0.8 )">
[Color] used for disabled menu items' text.
</theme_item>

16
doc/classes/ProjectSettings.xml
View File

@ -1052,6 +1052,8 @@
Fix to improve physics jitter, specially on monitors where refresh rate is different than the physics FPS.
[b]Note:[/b] This property is only read when the project starts. To change the physics FPS at runtime, set [member Engine.physics_jitter_fix] instead.
</member>
<member name="rendering/cluster_builder/max_clustered_elements" type="float" setter="" getter="" default="512">
</member>
<member name="rendering/environment/default_clear_color" type="Color" setter="" getter="" default="Color( 0.3, 0.3, 0.3, 1 )">
Default background clear color. Overridable per [Viewport] using its [Environment]. See [member Environment.background_mode] and [member Environment.background_color] in particular. To change this default color programmatically, use [method RenderingServer.set_default_clear_color].
</member>
@ -1116,6 +1118,8 @@
<member name="rendering/quality/depth_prepass/enable" type="bool" setter="" getter="" default="true">
If [code]true[/code], performs a previous depth pass before rendering materials. This increases performance in scenes with high overdraw, when complex materials and lighting are used.
</member>
<member name="rendering/quality/directional_shadow/16_bits" type="bool" setter="" getter="" default="true">
</member>
<member name="rendering/quality/directional_shadow/size" type="int" setter="" getter="" default="4096">
The directional shadow's size in pixels. Higher values will result in sharper shadows, at the cost of performance. The value will be rounded up to the nearest power of 2.
</member>
@ -1134,6 +1138,8 @@
[b]FIXME:[/b] No longer valid after DisplayServer split:
In such cases, this property is not updated, so use [code]OS.get_current_video_driver[/code] to query it at run-time.
</member>
<member name="rendering/quality/gi/use_half_resolution" type="bool" setter="" getter="" default="false">
</member>
<member name="rendering/quality/gi_probes/anisotropic" type="bool" setter="" getter="" default="false">
If [code]true[/code], take additional samples when rendering objects affected by a [GIProbe] to reduce artifacts from only sampling in one direction.
</member>
@ -1225,7 +1231,9 @@
<member name="rendering/quality/shading/force_vertex_shading.mobile" type="bool" setter="" getter="" default="true">
Lower-end override for [member rendering/quality/shading/force_vertex_shading] on mobile devices, due to performance concerns or driver support.
</member>
<member name="rendering/quality/shadow_atlas/quadrant_0_subdiv" type="int" setter="" getter="" default="1">
<member name="rendering/quality/shadow_atlas/16_bits" type="bool" setter="" getter="" default="true">
</member>
<member name="rendering/quality/shadow_atlas/quadrant_0_subdiv" type="int" setter="" getter="" default="2">
Subdivision quadrant size for shadow mapping. See shadow mapping documentation.
</member>
<member name="rendering/quality/shadow_atlas/quadrant_1_subdiv" type="int" setter="" getter="" default="2">
@ -1285,9 +1293,11 @@
<member name="rendering/quality/texture_filters/use_nearest_mipmap_filter" type="bool" setter="" getter="" default="false">
If [code]true[/code], uses nearest-neighbor mipmap filtering when using mipmaps (also called "bilinear filtering"), which will result in visible seams appearing between mipmap stages. This may increase performance in mobile as less memory bandwidth is used. If [code]false[/code], linear mipmap filtering (also called "trilinear filtering") is used.
</member>
<member name="rendering/sdfgi/frames_to_converge" type="int" setter="" getter="" default="1">
<member name="rendering/sdfgi/frames_to_converge" type="int" setter="" getter="" default="4">
</member>
<member name="rendering/sdfgi/probe_ray_count" type="int" setter="" getter="" default="2">
<member name="rendering/sdfgi/frames_to_update_lights" type="int" setter="" getter="" default="2">
</member>
<member name="rendering/sdfgi/probe_ray_count" type="int" setter="" getter="" default="1">
</member>
<member name="rendering/spatial_indexer/threaded_cull_minimum_instances" type="int" setter="" getter="" default="1000">
</member>

106
doc/classes/RenderingDevice.xml
View File

@ -7,6 +7,30 @@
<tutorials>
</tutorials>
<methods>
<method name="barrier">
<return type="void">
</return>
<argument index="0" name="from" type="int" default="7">
</argument>
<argument index="1" name="to" type="int" default="7">
</argument>
<description>
</description>
</method>
<method name="buffer_clear">
<return type="int" enum="Error">
</return>
<argument index="0" name="buffer" type="RID">
</argument>
<argument index="1" name="offset" type="int">
</argument>
<argument index="2" name="size_bytes" type="int">
</argument>
<argument index="3" name="post_barrier" type="int" default="7">
</argument>
<description>
</description>
</method>
<method name="buffer_get_data">
<return type="PackedByteArray">
</return>
@ -26,7 +50,7 @@
</argument>
<argument index="3" name="data" type="PackedByteArray">
</argument>
<argument index="4" name="sync_with_draw" type="bool" default="true">
<argument index="4" name="post_barrier" type="int" default="7">
</argument>
<description>
</description>
@ -36,8 +60,6 @@
</return>
<argument index="0" name="name" type="String">
</argument>
<argument index="1" name="sync_to_draw" type="bool">
</argument>
<description>
</description>
</method>
@ -94,6 +116,8 @@
<method name="compute_list_end">
<return type="void">
</return>
<argument index="0" name="post_barrier" type="int" default="7">
</argument>
<description>
</description>
</method>
@ -131,6 +155,32 @@
<description>
</description>
</method>
<method name="draw_command_begin_label">
<return type="void">
</return>
<argument index="0" name="name" type="String">
</argument>
<argument index="1" name="color" type="Color">
</argument>
<description>
</description>
</method>
<method name="draw_command_end_label">
<return type="void">
</return>
<description>
</description>
</method>
<method name="draw_command_insert_label">
<return type="void">
</return>
<argument index="0" name="name" type="String">
</argument>
<argument index="1" name="color" type="Color">
</argument>
<description>
</description>
</method>
<method name="draw_list_begin">
<return type="int">
</return>
@ -272,6 +322,8 @@
<method name="draw_list_end">
<return type="void">
</return>
<argument index="0" name="post_barrier" type="int" default="7">
</argument>
<description>
</description>
</method>
@ -302,7 +354,9 @@
</return>
<argument index="0" name="size" type="Vector2i">
</argument>
<argument index="1" name="validate_with_format" type="int" default="-1">
<argument index="1" name="samples" type="int" enum="RenderingDevice.TextureSamples" default="0">
</argument>
<argument index="2" name="validate_with_format" type="int" default="-1">
</argument>
<description>
</description>
@ -318,7 +372,7 @@
<method name="framebuffer_format_create_empty">
<return type="int">
</return>
<argument index="0" name="size" type="Vector2i">
<argument index="0" name="samples" type="int" enum="RenderingDevice.TextureSamples" default="0">
</argument>
<description>
</description>
@ -347,6 +401,12 @@
<description>
</description>
</method>
<method name="full_barrier">
<return type="void">
</return>
<description>
</description>
</method>
<method name="get_captured_timestamp_cpu_time" qualifiers="const">
<return type="int">
</return>
@ -485,6 +545,16 @@
<description>
</description>
</method>
<method name="set_resource_name">
<return type="void">
</return>
<argument index="0" name="id" type="RID">
</argument>
<argument index="1" name="name" type="String">
</argument>
<description>
</description>
</method>
<method name="shader_compile_from_source">
<return type="RDShaderBytecode">
</return>
@ -562,7 +632,7 @@
</argument>
<argument index="5" name="layer_count" type="int">
</argument>
<argument index="6" name="sync_with_draw" type="bool" default="false">
<argument index="6" name="post_barrier" type="int" default="7">
</argument>
<description>
</description>
@ -588,7 +658,7 @@
</argument>
<argument index="8" name="dst_layer" type="int">
</argument>
<argument index="9" name="sync_with_draw" type="bool" default="false">
<argument index="9" name="post_barrier" type="int" default="7">
</argument>
<description>
</description>
@ -674,7 +744,7 @@
</argument>
<argument index="1" name="to_texture" type="RID">
</argument>
<argument index="2" name="sync_with_draw" type="bool" default="false">
<argument index="2" name="post_barrier" type="int" default="7">
</argument>
<description>
</description>
@ -688,7 +758,7 @@
</argument>
<argument index="2" name="data" type="PackedByteArray">
</argument>
<argument index="3" name="sync_with_draw" type="bool" default="false">
<argument index="3" name="post_barrier" type="int" default="7">
</argument>
<description>
</description>
@ -745,6 +815,14 @@
</method>
</methods>
<constants>
<constant name="BARRIER_MASK_RASTER" value="1">
</constant>
<constant name="BARRIER_MASK_COMPUTE" value="2">
</constant>
<constant name="BARRIER_MASK_TRANSFER" value="4">
</constant>
<constant name="BARRIER_MASK_ALL" value="7">
</constant>
<constant name="DATA_FORMAT_R4G4_UNORM_PACK8" value="0" enum="DataFormat">
</constant>
<constant name="DATA_FORMAT_R4G4B4A4_UNORM_PACK16" value="1" enum="DataFormat">
@ -1507,13 +1585,15 @@
</constant>
<constant name="INITIAL_ACTION_CLEAR" value="0" enum="InitialAction">
</constant>
<constant name="INITIAL_ACTION_KEEP" value="1" enum="InitialAction">
<constant name="INITIAL_ACTION_CLEAR_REGION" value="1" enum="InitialAction">
</constant>
<constant name="INITIAL_ACTION_DROP" value="2" enum="InitialAction">
<constant name="INITIAL_ACTION_KEEP" value="2" enum="InitialAction">
</constant>
<constant name="INITIAL_ACTION_CONTINUE" value="3" enum="InitialAction">
<constant name="INITIAL_ACTION_DROP" value="3" enum="InitialAction">
</constant>
<constant name="INITIAL_ACTION_MAX" value="4" enum="InitialAction">
<constant name="INITIAL_ACTION_CONTINUE" value="4" enum="InitialAction">
</constant>
<constant name="INITIAL_ACTION_MAX" value="5" enum="InitialAction">
</constant>
<constant name="FINAL_ACTION_READ" value="0" enum="FinalAction">
</constant>

2
doc/classes/RenderingServer.xml
View File

@ -2949,6 +2949,8 @@
</argument>
<argument index="1" name="size" type="int">
</argument>
<argument index="2" name="use_16_bits" type="bool" default="false">
</argument>
<description>
Sets the size of the shadow atlas's images (used for omni and spot lights). The value will be rounded up to the nearest power of 2.
</description>

6
doc/classes/RichTextLabel.xml
View File

@ -597,12 +597,12 @@
<theme_item name="focus" type="StyleBox">
The background The background used when the [RichTextLabel] is focused.
</theme_item>
<theme_item name="font_selected_color" type="Color" default="Color( 0, 0, 0, 1 )">
The color of selected text, used when [member selection_enabled] is [code]true[/code].
</theme_item>
<theme_item name="font_shadow_color" type="Color" default="Color( 0, 0, 0, 0 )">
The color of the font's shadow.
</theme_item>
<theme_item name="font_selected_color" type="Color" default="Color( 0.49, 0.49, 0.49, 1 )">
The color of selected text, used when [member selection_enabled] is [code]true[/code].
</theme_item>
<theme_item name="italics_font" type="Font">
The font used for italics text.
</theme_item>

6
doc/classes/TabContainer.xml
View File

@ -204,12 +204,12 @@
<theme_item name="font_selected_color" type="Color" default="Color( 0.94, 0.94, 0.94, 1 )">
Font color of the currently selected tab.
</theme_item>
<theme_item name="font_unselected_color" type="Color" default="Color( 0.69, 0.69, 0.69, 1 )">
Font color of the other, unselected tabs.
</theme_item>
<theme_item name="font_size" type="int">
Font size of the tab names.
</theme_item>
<theme_item name="font_unselected_color" type="Color" default="Color( 0.69, 0.69, 0.69, 1 )">
Font color of the other, unselected tabs.
</theme_item>
<theme_item name="icon_separation" type="int" default="4">
Space between tab's name and its icon.
</theme_item>

6
doc/classes/Tabs.xml
View File

@ -365,12 +365,12 @@
<theme_item name="font_selected_color" type="Color" default="Color( 0.94, 0.94, 0.94, 1 )">
Font color of the currently selected tab.
</theme_item>
<theme_item name="font_unselected_color" type="Color" default="Color( 0.69, 0.69, 0.69, 1 )">
Font color of the other, unselected tabs.
</theme_item>
<theme_item name="font_size" type="int">
Font size of the tab names.
</theme_item>
<theme_item name="font_unselected_color" type="Color" default="Color( 0.69, 0.69, 0.69, 1 )">
Font color of the other, unselected tabs.
</theme_item>
<theme_item name="hseparation" type="int" default="4">
The horizontal separation between the tabs.
</theme_item>

14
doc/classes/Viewport.xml
View File

@ -240,6 +240,8 @@
</member>
<member name="sdf_scale" type="int" setter="set_sdf_scale" getter="get_sdf_scale" enum="Viewport.SDFScale" default="1">
</member>
<member name="shadow_atlas_16_bits" type="bool" setter="set_shadow_atlas_16_bits" getter="get_shadow_atlas_16_bits" default="true">
</member>
<member name="shadow_atlas_quad_0" type="int" setter="set_shadow_atlas_quadrant_subdiv" getter="get_shadow_atlas_quadrant_subdiv" enum="Viewport.ShadowAtlasQuadrantSubdiv" default="2">
The subdivision amount of the first quadrant on the shadow atlas.
</member>
@ -252,9 +254,9 @@
<member name="shadow_atlas_quad_3" type="int" setter="set_shadow_atlas_quadrant_subdiv" getter="get_shadow_atlas_quadrant_subdiv" enum="Viewport.ShadowAtlasQuadrantSubdiv" default="4">
The subdivision amount of the fourth quadrant on the shadow atlas.
</member>
<member name="shadow_atlas_size" type="int" setter="set_shadow_atlas_size" getter="get_shadow_atlas_size" default="0">
<member name="shadow_atlas_size" type="int" setter="set_shadow_atlas_size" getter="get_shadow_atlas_size" default="2048">
The shadow atlas' resolution (used for omni and spot lights). The value will be rounded up to the nearest power of 2.
[b]Note:[/b] If this is set to 0, shadows won't be visible. Since user-created viewports default to a value of 0, this value must be set above 0 manually.
[b]Note:[/b] If this is set to 0, shadows won't be visible.
</member>
<member name="snap_2d_transforms_to_pixel" type="bool" setter="set_snap_2d_transforms_to_pixel" getter="is_snap_2d_transforms_to_pixel_enabled" default="false">
</member>
@ -409,6 +411,14 @@
</constant>
<constant name="DEBUG_DRAW_DISABLE_LOD" value="18" enum="DebugDraw">
</constant>
<constant name="DEBUG_DRAW_CLUSTER_OMNI_LIGHTS" value="19" enum="DebugDraw">
</constant>
<constant name="DEBUG_DRAW_CLUSTER_SPOT_LIGHTS" value="20" enum="DebugDraw">
</constant>
<constant name="DEBUG_DRAW_CLUSTER_DECALS" value="21" enum="DebugDraw">
</constant>
<constant name="DEBUG_DRAW_CLUSTER_REFLECTION_PROBES" value="22" enum="DebugDraw">
</constant>
<constant name="DEFAULT_CANVAS_ITEM_TEXTURE_FILTER_NEAREST" value="0" enum="DefaultCanvasItemTextureFilter">
The texture filter reads from the nearest pixel only. The simplest and fastest method of filtering, but the texture will look pixelized.
</constant>

4
doc/classes/VisualShaderNodeSDFRaymarch.xml
View File

@ -1,10 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualShaderNodeSDFRaymarch" inherits="VisualShaderNode" version="4.0">
<brief_description>
SDF raymarching algorithm to be used within the visual shader graph.
SDF raymarching algorithm to be used within the visual shader graph.
</brief_description>
<description>
Casts a ray against the screen SDF (signed-distance field) and returns the distance travelled.
Casts a ray against the screen SDF (signed-distance field) and returns the distance travelled.
</description>
<tutorials>
</tutorials>

4
scene/resources/default_theme/default_theme.cpp
View File

@ -318,7 +318,7 @@ void fill_default_theme(Ref<Theme> &theme, const Ref<Font> &default_font, const
theme->set_color("font_color", "CheckBox", control_font_color);
theme->set_color("font_pressed_color", "CheckBox", control_font_pressed_color);
theme->set_color("font_hover_color", "CheckBox", control_font_hover_color);
theme->set_color("font_hover_color_pressed", "CheckBox", control_font_pressed_color);
theme->set_color("font_hover_pressed_color", "CheckBox", control_font_pressed_color);
theme->set_color("font_disabled_color", "CheckBox", control_font_disabled_color);
theme->set_constant("hseparation", "CheckBox", 4 * scale);
@ -355,7 +355,7 @@ void fill_default_theme(Ref<Theme> &theme, const Ref<Font> &default_font, const
theme->set_color("font_color", "CheckButton", control_font_color);
theme->set_color("font_pressed_color", "CheckButton", control_font_pressed_color);
theme->set_color("font_hover_color", "CheckButton", control_font_hover_color);
theme->set_color("font_hover_color_pressed", "CheckButton", control_font_pressed_color);
theme->set_color("font_hover_pressed_color", "CheckButton", control_font_pressed_color);
theme->set_color("font_disabled_color", "CheckButton", control_font_disabled_color);
theme->set_constant("hseparation", "CheckButton", 4 * scale);

4
servers/rendering/rendering_device.cpp
View File

@ -288,7 +288,7 @@ void RenderingDevice::_bind_methods() {
ClassDB::bind_method(D_METHOD("uniform_set_is_valid", "uniform_set"), &RenderingDevice::uniform_set_is_valid);
ClassDB::bind_method(D_METHOD("buffer_update", "buffer", "offset", "size_bytes", "data", "post_barrier"), &RenderingDevice::_buffer_update, DEFVAL(BARRIER_MASK_ALL));
ClassDB::bind_method(D_METHOD("buffer_clear", "buffer", "offset", "size_bytes", "post_barrier"), &RenderingDevice::_buffer_update, DEFVAL(BARRIER_MASK_ALL));
ClassDB::bind_method(D_METHOD("buffer_clear", "buffer", "offset", "size_bytes", "post_barrier"), &RenderingDevice::buffer_clear, DEFVAL(BARRIER_MASK_ALL));
ClassDB::bind_method(D_METHOD("buffer_get_data", "buffer"), &RenderingDevice::buffer_get_data);
ClassDB::bind_method(D_METHOD("render_pipeline_create", "shader", "framebuffer_format", "vertex_format", "primitive", "rasterization_state", "multisample_state", "stencil_state", "color_blend_state", "dynamic_state_flags"), &RenderingDevice::_render_pipeline_create, DEFVAL(0));
@ -346,7 +346,7 @@ void RenderingDevice::_bind_methods() {
ClassDB::bind_method(D_METHOD("create_local_device"), &RenderingDevice::create_local_device);
ClassDB::bind_method(D_METHOD("set_resource_name"), &RenderingDevice::set_resource_name);
ClassDB::bind_method(D_METHOD("set_resource_name", "id", "name"), &RenderingDevice::set_resource_name);
ClassDB::bind_method(D_METHOD("draw_command_begin_label", "name", "color"), &RenderingDevice::draw_command_begin_label);
ClassDB::bind_method(D_METHOD("draw_command_insert_label", "name", "color"), &RenderingDevice::draw_command_insert_label);