asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #43366 from Calinou/doc-surfacetool-method-order

Browse source 
Make the expected method calling order in SurfaceTool more explicit
This commit is contained in:
Rémi Verschelde 2021-03-23 00:57:26 +01:00 committed by GitHub
commit 0339200972
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
doc/classes/SurfaceTool.xml
View file

@ -199,7 +199,7 @@
<return type="void">
</return>
<description>
Shrinks the vertex array by creating an index array (avoids reusing vertices).
Shrinks the vertex array by creating an index array. This can improve performance by avoiding vertex reuse.
</description>
</method>
<method name="optimize_indices_for_cache">
@ -214,7 +214,7 @@
<argument index="0" name="bones" type="PackedInt32Array">
</argument>
<description>
Specifies an array of bones for the next vertex to use. [code]bones[/code] must contain 4 integers.
Specifies an array of bones to use for the [i]next[/i] vertex. [code]bones[/code] must contain 4 integers.
</description>
</method>
<method name="set_color">
@ -223,7 +223,7 @@
<argument index="0" name="color" type="Color">
</argument>
<description>
Specifies a [Color] for the next vertex to use.
Specifies a [Color] to use for the [i]next[/i] vertex. If every vertex needs to have this information set and you fail to submit it for the first vertex, this information may not be used at all.
[b]Note:[/b] The material must have [member BaseMaterial3D.vertex_color_use_as_albedo] enabled for the vertex color to be visible.
</description>
</method>
@ -262,7 +262,7 @@
<argument index="0" name="normal" type="Vector3">
</argument>
<description>
Specifies a normal for the next vertex to use.
Specifies a normal to use for the [i]next[/i] vertex. If every vertex needs to have this information set and you fail to submit it for the first vertex, this information may not be used at all.
</description>
</method>
<method name="set_skin_weight_count">
@ -288,7 +288,7 @@
<argument index="0" name="tangent" type="Plane">
</argument>
<description>
Specifies a tangent for the next vertex to use.
Specifies a tangent to use for the [i]next[/i] vertex. If every vertex needs to have this information set and you fail to submit it for the first vertex, this information may not be used at all.
</description>
</method>
<method name="set_uv">
@ -297,7 +297,7 @@
<argument index="0" name="uv" type="Vector2">
</argument>
<description>
Specifies a set of UV coordinates to use for the next vertex.
Specifies a set of UV coordinates to use for the [i]next[/i] vertex. If every vertex needs to have this information set and you fail to submit it for the first vertex, this information may not be used at all.
</description>
</method>
<method name="set_uv2">
@ -306,7 +306,7 @@
<argument index="0" name="uv2" type="Vector2">
</argument>
<description>
Specifies an optional second set of UV coordinates to use for the next vertex.
Specifies an optional second set of UV coordinates to use for the [i]next[/i] vertex. If every vertex needs to have this information set and you fail to submit it for the first vertex, this information may not be used at all.
</description>
</method>
<method name="set_weights">
@ -315,7 +315,7 @@
<argument index="0" name="weights" type="PackedFloat32Array">
</argument>
<description>
Specifies weight values for next vertex to use. [code]weights[/code] must contain 4 values.
Specifies weight values to use for the [i]next[/i] vertex. [code]weights[/code] must contain 4 values. If every vertex needs to have this information set and you fail to submit it for the first vertex, this information may not be used at all.
</description>
</method>
</methods>