From ee03e39da746b41cd9f1b8785e94a8f827eaf731 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Mon, 31 Aug 2020 11:25:11 +0200 Subject: [PATCH] doc: Sync classref with current source --- doc/classes/EditorExportPlugin.xml | 18 ++++----- doc/classes/Environment.xml | 65 ++++++++++++++---------------- doc/classes/Light3D.xml | 8 +++- doc/classes/Object.xml | 4 +- doc/classes/ProjectSettings.xml | 10 +++++ doc/classes/RenderingServer.xml | 55 +++++-------------------- 6 files changed, 69 insertions(+), 91 deletions(-) diff --git a/doc/classes/EditorExportPlugin.xml b/doc/classes/EditorExportPlugin.xml index 6bcaabc39eb..9ef2bd21cca 100644 --- a/doc/classes/EditorExportPlugin.xml +++ b/doc/classes/EditorExportPlugin.xml @@ -70,15 +70,6 @@ - - - - - - - Adds a static library (*.a) or dynamic library (*.dylib, *.framework) to Linking Phase in iOS's Xcode project. - - @@ -90,6 +81,15 @@ This method should not be used for System libraries as they are already present on the device. + + + + + + + Adds a static library (*.a) or dynamic library (*.dylib, *.framework) to Linking Phase in iOS's Xcode project. + + diff --git a/doc/classes/Environment.xml b/doc/classes/Environment.xml index bbab0bf8cf0..d90b9266476 100644 --- a/doc/classes/Environment.xml +++ b/doc/classes/Environment.xml @@ -95,47 +95,20 @@ The background mode. See [enum BGMode] for possible values. - - The fog's [Color]. - - - The fog's depth starting distance from the camera. - - - The fog depth's intensity curve. A number of presets are available in the [b]Inspector[/b] by right-clicking the curve. - - - If [code]true[/code], the depth fog effect is enabled. When enabled, fog will appear in the distance (relative to the camera). - - - The fog's depth end distance from the camera. If this value is set to 0, it will be equal to the current camera's [member Camera3D.far] value. + - If [code]true[/code], fog effects are enabled. [member fog_height_enabled] and/or [member fog_depth_enabled] must be set to [code]true[/code] to actually display fog. + If [code]true[/code], fog effects are enabled. - - The height fog's intensity. A number of presets are available in the [b]Inspector[/b] by right-clicking the curve. + - - If [code]true[/code], the height fog effect is enabled. When enabled, fog will appear in a defined height range, regardless of the distance from the camera. This can be used to simulate "deep water" effects with a lower performance cost compared to a dedicated shader. + - - The Y coordinate where the height fog will be the most intense. If this value is greater than [member fog_height_min], fog will be displayed from bottom to top. Otherwise, it will be displayed from top to bottom. + - - The Y coordinate where the height fog will be the least intense. If this value is greater than [member fog_height_max], fog will be displayed from top to bottom. Otherwise, it will be displayed from bottom to top. + - - The intensity of the depth fog color transition when looking towards the sun. The sun's direction is determined automatically using the DirectionalLight3D node in the scene. - - - The depth fog's [Color] when looking towards the sun. - - - The intensity of the fog light transmittance effect. Amount of light that the fog transmits. - - - Enables fog's light transmission effect. If [code]true[/code], light will be more visible in the fog to simulate light scattering as in real life. + The glow blending mode. @@ -265,6 +238,22 @@ The white reference value for tonemapping. Only effective if the [member tonemap_mode] isn't set to [constant TONE_MAPPER_LINEAR]. + + + + + + + + + + + + + + + + @@ -360,5 +349,13 @@ + + + + + + + + diff --git a/doc/classes/Light3D.xml b/doc/classes/Light3D.xml index 6979efa5698..d4d574627f8 100644 --- a/doc/classes/Light3D.xml +++ b/doc/classes/Light3D.xml @@ -77,6 +77,8 @@ If [code]true[/code], the light will cast shadows. + + 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. @@ -138,10 +140,12 @@ Constant for accessing [member shadow_blur]. - + + + Constant for accessing [member shadow_transmittance_bias]. - + Represents the size of the [enum Param] enum. diff --git a/doc/classes/Object.xml b/doc/classes/Object.xml index 077067a0f4f..2395ccd211f 100644 --- a/doc/classes/Object.xml +++ b/doc/classes/Object.xml @@ -495,7 +495,7 @@ Translates a message using translation catalogs configured in the Project Settings. An additional context could be used to specify the translation context. Only works if message translation is enabled (which it is by default), otherwise it returns the [code]message[/code] unchanged. See [method set_message_translation]. - See https://docs.godotengine.org/en/latest/tutorials/i18n/internationalizing_games.html for examples of the usage of this method. + See [url=https://docs.godotengine.org/en/latest/tutorials/i18n/internationalizing_games.html]Internationalizing games[/url] for examples of the usage of this method. @@ -514,7 +514,7 @@ Only works if message translation is enabled (which it is by default), otherwise it returns the [code]message[/code] or [code]plural_message[/code] unchanged. See [method set_message_translation]. The number [code]n[/code] is the number or quantity of the plural object. It will be used to guide the translation system to fetch the correct plural form for the selected language. [b]Note:[/b] Negative and floating-point values usually represent physical entities for which singular and plural don't clearly apply. In such cases, use [method tr]. - See https://docs.godotengine.org/en/latest/tutorials/i18n/localization_using_gettext.html for examples of the usage of this method. + See [url=https://docs.godotengine.org/en/latest/tutorials/i18n/localization_using_gettext.html]Localization using gettext[/url] for examples of the usage of this method. diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index 793249afc5e..f1feade59d1 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -1158,6 +1158,16 @@ Thread model for rendering. Rendering on a thread can vastly improve performance, but synchronizing to the main thread can cause a bit more jitter. + + + + + + + + + + If [code]true[/code], the texture importer will import VRAM-compressed textures using the BPTC algorithm. This texture compression algorithm is only supported on desktop platforms, and only when using the Vulkan renderer. diff --git a/doc/classes/RenderingServer.xml b/doc/classes/RenderingServer.xml index 85eaac454f4..24a52d30f7f 100644 --- a/doc/classes/RenderingServer.xml +++ b/doc/classes/RenderingServer.xml @@ -690,52 +690,19 @@ - + - + - + + + + + + + - Sets the variables to be used with the scene fog. See [Environment] for more details. - - - - - - - - - - - - - - - - - - - - - Sets the variables to be used with the fog depth effect. See [Environment] for more details. - - - - - - - - - - - - - - - - - Sets the variables to be used with the fog height effect. See [Environment] for more details. @@ -3252,9 +3219,9 @@ Blurs the edges of the shadow. Can be used to hide pixel artifacts in low resolution shadow maps. A high value can make shadows appear grainy and can cause other unwanted artifacts. Try to keep as near default as possible. - + - + Represents the size of the [enum LightParam] enum.