Skip to content

Commit

Permalink
Merge pull request #45522 from akien-mga/doc-sync
Browse files Browse the repository at this point in the history 
doc: Sync classref with current source
  • Loading branch information
@akien-mga
akien-mga authored Jan 28, 2021
2 parents b441592 + fb01d05 commit 726967f
Show file tree
Hide file tree
Showing 15 changed files with 157 additions and 47 deletions.
2 changes: 2 additions & 0 deletions doc/classes/ArrayMesh.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
6 changes: 3 additions & 3 deletions doc/classes/LineEdit.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
6 changes: 6 additions & 0 deletions doc/classes/Material.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand Down
16 changes: 8 additions & 8 deletions doc/classes/OS.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down
6 changes: 3 additions & 3 deletions doc/classes/PopupMenu.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
16 changes: 13 additions & 3 deletions doc/classes/ProjectSettings.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand All @@ -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>
Expand Down Expand Up @@ -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">
Expand Down Expand Up @@ -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/frames_to_update_lights" type="int" setter="" getter="" default="2">
</member>
<member name="rendering/sdfgi/probe_ray_count" type="int" setter="" getter="" default="2">
<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>
Expand Down
106 changes: 93 additions & 13 deletions doc/classes/RenderingDevice.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand All @@ -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>
Expand All @@ -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>
Expand Down Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand All @@ -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>
Expand Down Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand All @@ -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>
Expand Down Expand Up @@ -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>
Expand All @@ -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>
Expand Down Expand Up @@ -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">
Expand Down Expand Up @@ -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_KEEP" value="2" enum="InitialAction">
</constant>
<constant name="INITIAL_ACTION_DROP" value="2" enum="InitialAction">
<constant name="INITIAL_ACTION_DROP" value="3" enum="InitialAction">
</constant>
<constant name="INITIAL_ACTION_CONTINUE" value="3" enum="InitialAction">
<constant name="INITIAL_ACTION_CONTINUE" value="4" enum="InitialAction">
</constant>
<constant name="INITIAL_ACTION_MAX" value="4" enum="InitialAction">
<constant name="INITIAL_ACTION_MAX" value="5" enum="InitialAction">
</constant>
<constant name="FINAL_ACTION_READ" value="0" enum="FinalAction">
</constant>
Expand Down
2 changes: 2 additions & 0 deletions doc/classes/RenderingServer.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
6 changes: 3 additions & 3 deletions doc/classes/RichTextLabel.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
6 changes: 3 additions & 3 deletions doc/classes/TabContainer.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
Loading

0 comments on commit 726967f

Please sign in to comment.