From fb01d057af3d167f0573aa3b76e1695757c0124b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Thu, 28 Jan 2021 11:26:37 +0100 Subject: [PATCH] doc: Sync classref with current source --- doc/classes/ArrayMesh.xml | 2 + doc/classes/LineEdit.xml | 6 +- doc/classes/Material.xml | 6 + doc/classes/OS.xml | 16 +-- doc/classes/PopupMenu.xml | 6 +- doc/classes/ProjectSettings.xml | 16 ++- doc/classes/RenderingDevice.xml | 106 +++++++++++++++--- doc/classes/RenderingServer.xml | 2 + doc/classes/RichTextLabel.xml | 6 +- doc/classes/TabContainer.xml | 6 +- doc/classes/Tabs.xml | 6 +- doc/classes/Viewport.xml | 14 ++- doc/classes/VisualShaderNodeSDFRaymarch.xml | 4 +- .../resources/default_theme/default_theme.cpp | 4 +- servers/rendering/rendering_device.cpp | 4 +- 15 files changed, 157 insertions(+), 47 deletions(-) diff --git a/doc/classes/ArrayMesh.xml b/doc/classes/ArrayMesh.xml index 1f532f4843c..e2c4ed14300 100644 --- a/doc/classes/ArrayMesh.xml +++ b/doc/classes/ArrayMesh.xml @@ -215,6 +215,8 @@ 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. + + diff --git a/doc/classes/LineEdit.xml b/doc/classes/LineEdit.xml index 790bf58359d..61ecff52e32 100644 --- a/doc/classes/LineEdit.xml +++ b/doc/classes/LineEdit.xml @@ -383,12 +383,12 @@ Font color for selected text (inside the selection rectangle). - - Font color when editing is disabled. - Font size of the [LineEdit]'s text. + + Font color when editing is disabled. + 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). diff --git a/doc/classes/Material.xml b/doc/classes/Material.xml index 10a7061befb..0d287a5d1d0 100644 --- a/doc/classes/Material.xml +++ b/doc/classes/Material.xml @@ -11,6 +11,12 @@ https://godotengine.org/asset-library/asset/678 + + + + + + diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml index e209fc9ad96..8620de1378d 100644 --- a/doc/classes/OS.xml +++ b/doc/classes/OS.xml @@ -136,14 +136,6 @@ Returns the keycode of the given string (e.g. "Escape"). - - - - - 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. - - @@ -330,6 +322,14 @@ [b]Note:[/b] This method is implemented on Windows. + + + + + 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. + + diff --git a/doc/classes/PopupMenu.xml b/doc/classes/PopupMenu.xml index 4be81e256ea..47e8e57a4ee 100644 --- a/doc/classes/PopupMenu.xml +++ b/doc/classes/PopupMenu.xml @@ -717,12 +717,12 @@ [Font] used for the menu items. - - The default text [Color] for menu items' names. - 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. + + The default text [Color] for menu items' names. + [Color] used for disabled menu items' text. diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index a82cf9a2a91..fc618206edf 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -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. + + 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]. @@ -1116,6 +1118,8 @@ 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. + + 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. @@ -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. + + If [code]true[/code], take additional samples when rendering objects affected by a [GIProbe] to reduce artifacts from only sampling in one direction. @@ -1225,7 +1231,9 @@ Lower-end override for [member rendering/quality/shading/force_vertex_shading] on mobile devices, due to performance concerns or driver support. - + + + Subdivision quadrant size for shadow mapping. See shadow mapping documentation. @@ -1285,9 +1293,11 @@ 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. - + - + + + diff --git a/doc/classes/RenderingDevice.xml b/doc/classes/RenderingDevice.xml index 7cdc9ffaca5..d0fb2b9d472 100644 --- a/doc/classes/RenderingDevice.xml +++ b/doc/classes/RenderingDevice.xml @@ -7,6 +7,30 @@ + + + + + + + + + + + + + + + + + + + + + + + + @@ -26,7 +50,7 @@ - + @@ -36,8 +60,6 @@ - - @@ -94,6 +116,8 @@ + + @@ -131,6 +155,32 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -272,6 +322,8 @@ + + @@ -302,7 +354,9 @@ - + + + @@ -318,7 +372,7 @@ - + @@ -347,6 +401,12 @@ + + + + + + @@ -485,6 +545,16 @@ + + + + + + + + + + @@ -562,7 +632,7 @@ - + @@ -588,7 +658,7 @@ - + @@ -674,7 +744,7 @@ - + @@ -688,7 +758,7 @@ - + @@ -745,6 +815,14 @@ + + + + + + + + @@ -1507,13 +1585,15 @@ - + - + - + - + + + diff --git a/doc/classes/RenderingServer.xml b/doc/classes/RenderingServer.xml index 4be97b7d3d5..efc751bb94e 100644 --- a/doc/classes/RenderingServer.xml +++ b/doc/classes/RenderingServer.xml @@ -2949,6 +2949,8 @@ + + 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. diff --git a/doc/classes/RichTextLabel.xml b/doc/classes/RichTextLabel.xml index 2c18bc493a5..35eae32c7b8 100644 --- a/doc/classes/RichTextLabel.xml +++ b/doc/classes/RichTextLabel.xml @@ -597,12 +597,12 @@ The background The background used when the [RichTextLabel] is focused. + + The color of selected text, used when [member selection_enabled] is [code]true[/code]. + The color of the font's shadow. - - The color of selected text, used when [member selection_enabled] is [code]true[/code]. - The font used for italics text. diff --git a/doc/classes/TabContainer.xml b/doc/classes/TabContainer.xml index ba687357ec6..52577e61021 100644 --- a/doc/classes/TabContainer.xml +++ b/doc/classes/TabContainer.xml @@ -204,12 +204,12 @@ Font color of the currently selected tab. - - Font color of the other, unselected tabs. - Font size of the tab names. + + Font color of the other, unselected tabs. + Space between tab's name and its icon. diff --git a/doc/classes/Tabs.xml b/doc/classes/Tabs.xml index 1c926ac36d6..0c7b992cbff 100644 --- a/doc/classes/Tabs.xml +++ b/doc/classes/Tabs.xml @@ -365,12 +365,12 @@ Font color of the currently selected tab. - - Font color of the other, unselected tabs. - Font size of the tab names. + + Font color of the other, unselected tabs. + The horizontal separation between the tabs. diff --git a/doc/classes/Viewport.xml b/doc/classes/Viewport.xml index e66b8353a81..8120ae539e7 100644 --- a/doc/classes/Viewport.xml +++ b/doc/classes/Viewport.xml @@ -240,6 +240,8 @@ + + The subdivision amount of the first quadrant on the shadow atlas. @@ -252,9 +254,9 @@ The subdivision amount of the fourth quadrant on the shadow atlas. - + 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. @@ -409,6 +411,14 @@ + + + + + + + + The texture filter reads from the nearest pixel only. The simplest and fastest method of filtering, but the texture will look pixelized. diff --git a/doc/classes/VisualShaderNodeSDFRaymarch.xml b/doc/classes/VisualShaderNodeSDFRaymarch.xml index d700761fdb7..775f2814c2e 100644 --- a/doc/classes/VisualShaderNodeSDFRaymarch.xml +++ b/doc/classes/VisualShaderNodeSDFRaymarch.xml @@ -1,10 +1,10 @@ - SDF raymarching algorithm to be used within the visual shader graph. + SDF raymarching algorithm to be used within the visual shader graph. - 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. diff --git a/scene/resources/default_theme/default_theme.cpp b/scene/resources/default_theme/default_theme.cpp index 242c3b8ec4f..a0b65e97996 100644 --- a/scene/resources/default_theme/default_theme.cpp +++ b/scene/resources/default_theme/default_theme.cpp @@ -318,7 +318,7 @@ void fill_default_theme(Ref &theme, const Ref &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, const Ref &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); diff --git a/servers/rendering/rendering_device.cpp b/servers/rendering/rendering_device.cpp index 67f9246b5b7..70497bcdb31 100644 --- a/servers/rendering/rendering_device.cpp +++ b/servers/rendering/rendering_device.cpp @@ -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);