diff options
| author | smix8 <52464204+smix8@users.noreply.github.com> | 2023-07-09 21:19:09 +0200 |
|---|---|---|
| committer | smix8 <52464204+smix8@users.noreply.github.com> | 2023-07-09 21:19:22 +0200 |
| commit | 976f5338c598fe2995e0444ca861b8e4f92da2f5 (patch) | |
| tree | 6c50f886d6ad8a7b866356a7a0b7071f8fa7e53a | |
| parent | 85c9db592f22941ce7c2a540a526e702f4cc1848 (diff) | |
| download | redot-engine-976f5338c598fe2995e0444ca861b8e4f92da2f5.tar.gz | |
Add performance note for parsing source geometry
Adds performance note for parsing source geometry.
| -rw-r--r-- | doc/classes/NavigationMeshGenerator.xml | 1 | ||||
| -rw-r--r-- | doc/classes/NavigationServer3D.xml | 1 |
2 files changed, 2 insertions, 0 deletions
diff --git a/doc/classes/NavigationMeshGenerator.xml b/doc/classes/NavigationMeshGenerator.xml index 0b9e67b0fa..dc9b7dc3b2 100644 --- a/doc/classes/NavigationMeshGenerator.xml +++ b/doc/classes/NavigationMeshGenerator.xml @@ -47,6 +47,7 @@ <description> Parses the [SceneTree] for source geometry according to the properties of [param navigation_mesh]. Updates the provided [param source_geometry_data] resource with the resulting data. The resource can then be used to bake a navigation mesh with [method bake_from_source_geometry_data]. After the process is finished the optional [param callback] will be called. [b]Note:[/b] This function needs to run on the main thread or with a deferred call as the SceneTree is not thread-safe. + [b]Performance:[/b] While convenient, reading data arrays from [Mesh] resources can affect the frame rate negatively. The data needs to be received from the GPU, stalling the [RenderingServer] in the process. For performance prefer the use of e.g. collision shapes or creating the data arrays entirely in code. </description> </method> </methods> diff --git a/doc/classes/NavigationServer3D.xml b/doc/classes/NavigationServer3D.xml index f925e7a8fe..7dc3179e6b 100644 --- a/doc/classes/NavigationServer3D.xml +++ b/doc/classes/NavigationServer3D.xml @@ -685,6 +685,7 @@ <description> Parses the [SceneTree] for source geometry according to the properties of [param navigation_mesh]. Updates the provided [param source_geometry_data] resource with the resulting data. The resource can then be used to bake a navigation mesh with [method bake_from_source_geometry_data]. After the process is finished the optional [param callback] will be called. [b]Note:[/b] This function needs to run on the main thread or with a deferred call as the SceneTree is not thread-safe. + [b]Performance:[/b] While convenient, reading data arrays from [Mesh] resources can affect the frame rate negatively. The data needs to be received from the GPU, stalling the [RenderingServer] in the process. For performance prefer the use of e.g. collision shapes or creating the data arrays entirely in code. </description> </method> <method name="query_path" qualifiers="const"> |