From 43f62a588b7367e7f932269e06943319ed8209b7 Mon Sep 17 00:00:00 2001 From: Haoyu Qiu Date: Fri, 24 Feb 2023 10:42:07 +0800 Subject: [PATCH] More class reference fixes Mostly typos. Also renamed the remaining "Vulkan Clustered" to "Forward+". --- doc/classes/Color.xml | 2 +- doc/classes/LightmapGI.xml | 4 ++-- doc/classes/LightmapperRD.xml | 2 +- doc/classes/Mesh.xml | 2 +- doc/classes/NavigationServer2D.xml | 8 ++++---- doc/classes/NavigationServer3D.xml | 8 ++++---- doc/classes/TileSet.xml | 2 +- 7 files changed, 14 insertions(+), 14 deletions(-) diff --git a/doc/classes/Color.xml b/doc/classes/Color.xml index faa658971db..6dbc475bdfd 100644 --- a/doc/classes/Color.xml +++ b/doc/classes/Color.xml @@ -181,7 +181,7 @@ - Encodes a [Color] from a RGBE9995 format integer. See [constant Image.FORMAT_RGBE9995]. + Decodes a [Color] from a RGBE9995 format integer. See [constant Image.FORMAT_RGBE9995]. diff --git a/doc/classes/LightmapGI.xml b/doc/classes/LightmapGI.xml index 723e6bbf21f..235e4127574 100644 --- a/doc/classes/LightmapGI.xml +++ b/doc/classes/LightmapGI.xml @@ -9,7 +9,7 @@ [b]Performance:[/b] [LightmapGI] provides the best possible run-time performance for global illumination. It is suitable for low-end hardware including integrated graphics and mobile devices. [b]Note:[/b] Due to how lightmaps work, most properties only have a visible effect once lightmaps are baked again. [b]Note:[/b] Lightmap baking on [CSGShape3D]s and [PrimitiveMesh]es is not supported, as these cannot store UV2 data required for baking. - [b]Note:[/b] If no custom lightmappers are installed, [LightmapGI] can only be baked when using the Vulkan backend (Clustered or Mobile), not OpenGL. + [b]Note:[/b] If no custom lightmappers are installed, [LightmapGI] can only be baked when using the Vulkan backend (Forward+ or Mobile), not OpenGL. @@ -73,7 +73,7 @@ High bake quality (slow bake times). The quality of this preset can be adjusted by changing [member ProjectSettings.rendering/lightmapping/bake_quality/high_quality_ray_count] and [member ProjectSettings.rendering/lightmapping/bake_quality/high_quality_probe_ray_count]. - Highest bake quality (slowest bake times). The quality of this preset can be adjusted by changing [member ProjectSettings.rendering/lightmapping/bake_quality/high_quality_ray_count] and [member ProjectSettings.rendering/lightmapping/bake_quality/ultra_quality_probe_ray_count]. + Highest bake quality (slowest bake times). The quality of this preset can be adjusted by changing [member ProjectSettings.rendering/lightmapping/bake_quality/ultra_quality_ray_count] and [member ProjectSettings.rendering/lightmapping/bake_quality/ultra_quality_probe_ray_count]. Don't generate lightmap probes for lighting dynamic objects. diff --git a/doc/classes/LightmapperRD.xml b/doc/classes/LightmapperRD.xml index e4b68a7ef8a..a3c815f58e5 100644 --- a/doc/classes/LightmapperRD.xml +++ b/doc/classes/LightmapperRD.xml @@ -5,7 +5,7 @@ LightmapperRD ("RD" stands for [RenderingDevice]) is the built-in GPU-based lightmapper for use with [LightmapGI]. On most dedicated GPUs, it can bake lightmaps much faster than most CPU-based lightmappers. LightmapperRD uses compute shaders to bake lightmaps, so it does not require CUDA or OpenCL libraries to be installed to be usable. - [b]Note:[/b] Only usable when using the Vulkan backend (Clustered or Mobile), not OpenGL. + [b]Note:[/b] Only usable when using the Vulkan backend (Forward+ or Mobile), not OpenGL. diff --git a/doc/classes/Mesh.xml b/doc/classes/Mesh.xml index ece3199aabc..3063e76c656 100644 --- a/doc/classes/Mesh.xml +++ b/doc/classes/Mesh.xml @@ -258,7 +258,7 @@ Indicates this custom channel contains half precision float colors, encoded as [PackedByteArray]. - Indicates this custom channel contains full float colors, in a [PackedFloat32Array]. Only the red green channel is used. + Indicates this custom channel contains full float colors, in a [PackedFloat32Array]. Only the red channel is used. Indicates this custom channel contains full float colors, in a [PackedFloat32Array]. Only red and green channels are used. diff --git a/doc/classes/NavigationServer2D.xml b/doc/classes/NavigationServer2D.xml index 103de8eddb9..60d473a1033 100644 --- a/doc/classes/NavigationServer2D.xml +++ b/doc/classes/NavigationServer2D.xml @@ -155,7 +155,7 @@ - Returns the [code]enter_cost[/code] of this [code]link[/code]. + Returns the enter cost of this [param link]. @@ -190,7 +190,7 @@ - Returns the [code]travel_cost[/code] of this [code]link[/code]. + Returns the travel cost of this [param link]. @@ -429,7 +429,7 @@ - Returns the [code]enter_cost[/code] of this [param region]. + Returns the enter cost of this [param region]. @@ -457,7 +457,7 @@ - Returns the [code]travel_cost[/code] of this [param region]. + Returns the travel cost of this [param region]. diff --git a/doc/classes/NavigationServer3D.xml b/doc/classes/NavigationServer3D.xml index 0d8cb78ff97..71906729d17 100644 --- a/doc/classes/NavigationServer3D.xml +++ b/doc/classes/NavigationServer3D.xml @@ -162,7 +162,7 @@ - Returns the [code]enter_cost[/code] of this [code]link[/code]. + Returns the enter cost of this [param link]. @@ -197,7 +197,7 @@ - Returns the [code]travel_cost[/code] of this [code]link[/code]. + Returns the travel cost of this [param link]. @@ -477,7 +477,7 @@ - Returns the [code]enter_cost[/code] of this [param region]. + Returns the enter cost of this [param region]. @@ -505,7 +505,7 @@ - Returns the [code]travel_cost[/code] of this [param region]. + Returns the travel cost of this [param region]. diff --git a/doc/classes/TileSet.xml b/doc/classes/TileSet.xml index a39a43be4c7..ec2c7860d8b 100644 --- a/doc/classes/TileSet.xml +++ b/doc/classes/TileSet.xml @@ -300,7 +300,7 @@ - Returns if there is and alternative-level proxy for the given identifiers. + Returns if there is an alternative-level proxy for the given identifiers.