summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRémi Verschelde <remi@verschelde.fr>2021-02-07 21:57:01 +0100
committerGitHub <noreply@github.com>2021-02-07 21:57:01 +0100
commit790c87fee426afc8534ff8b2463d3aefabbdad95 (patch)
tree39abcc70b34af7644145755265c444cb4839524c
parent59125d689bb732951113c1378196e8fcaebd4814 (diff)
parentb8df8b10435114ec068c8164f8711e0a1d14709b (diff)
Merge pull request #45794 from Calinou/doc-surfacetool-generate-normals
Improve the `SurfaceTool.generate_normals()` documentation
-rw-r--r--doc/classes/SurfaceTool.xml4
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/classes/SurfaceTool.xml b/doc/classes/SurfaceTool.xml
index e10b65e309..331de4284e 100644
--- a/doc/classes/SurfaceTool.xml
+++ b/doc/classes/SurfaceTool.xml
@@ -155,8 +155,8 @@
<argument index="0" name="flip" type="bool" default="false">
</argument>
<description>
- Generates normals from vertices so you do not have to do it manually. If [code]flip[/code] is [code]true[/code], the resulting normals will be inverted.
- Requires the primitive type to be set to [constant Mesh.PRIMITIVE_TRIANGLES].
+ Generates normals from vertices so you do not have to do it manually. If [code]flip[/code] is [code]true[/code], the resulting normals will be inverted. [method generate_normals] should be called [i]after[/i] generating geometry and [i]before[/i] committing the mesh using [method commit] or [method commit_to_arrays].
+ [b]Note:[/b] [method generate_normals] only works if the primitive type to be set to [constant Mesh.PRIMITIVE_TRIANGLES].
</description>
</method>
<method name="generate_tangents">