Merge pull request #45794 from Calinou/doc-surfacetool-generate-normals

Improve the `SurfaceTool.generate_normals()` documentation
This commit is contained in:
Rémi Verschelde 2021-02-07 21:57:01 +01:00 committed by GitHub
commit 790c87fee4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -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">