Improve the SurfaceTool.generate_normals() documentation

(cherry picked from commit b8df8b1043)
This commit is contained in:
Hugo Locurcio 2021-02-07 16:09:01 +01:00 committed by Rémi Verschelde
parent db57f32194
commit 2261e738c2
No known key found for this signature in database
GPG key ID: C3336907360768E1

View file

@ -218,8 +218,8 @@
<argument index="0" name="flip" type="bool" default="false"> <argument index="0" name="flip" type="bool" default="false">
</argument> </argument>
<description> <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. 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].
Requires the primitive type to be set to [constant Mesh.PRIMITIVE_TRIANGLES]. [b]Note:[/b] [method generate_normals] only works if the primitive type to be set to [constant Mesh.PRIMITIVE_TRIANGLES].
</description> </description>
</method> </method>
<method name="generate_tangents"> <method name="generate_tangents">