diff options
| author | Clay John <claynjohn@gmail.com> | 2022-10-27 12:48:34 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-10-27 12:48:34 -0700 |
| commit | 24e788e9bea4a617dfa5c5879b8f3cd7b2491c9a (patch) | |
| tree | 9c0b2ba8ab28bbc0e9366f75526f2ef1004d4e03 /doc/classes/Vector3.xml | |
| parent | aa989cb26f8b281e3d6a7ed79dca811963e3c712 (diff) | |
| parent | 7d7b4210f6b1be4f1f1142ff529e2eec7530671e (diff) | |
Merge pull request #67874 from Calinou/doc-vector3-vector4i
Document the Vector3 and Vector4i classes
Diffstat (limited to 'doc/classes/Vector3.xml')
| -rw-r--r-- | doc/classes/Vector3.xml | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/doc/classes/Vector3.xml b/doc/classes/Vector3.xml index 81e8dd2260..1a2cdfe10e 100644 --- a/doc/classes/Vector3.xml +++ b/doc/classes/Vector3.xml @@ -183,7 +183,7 @@ <method name="is_normalized" qualifiers="const"> <return type="bool" /> <description> - Returns [code]true[/code] if the vector is normalized, [code]false[/code] otherwise. + Returns [code]true[/code] if the vector is [method normalized], [code]false[/code] otherwise. </description> </method> <method name="is_zero_approx" qualifiers="const"> @@ -244,18 +244,22 @@ <method name="normalized" qualifiers="const"> <return type="Vector3" /> <description> - Returns the vector scaled to unit length. Equivalent to [code]v / v.length()[/code]. + Returns the vector scaled to unit length. Equivalent to [code]v / v.length()[/code]. See also [method is_normalized]. </description> </method> <method name="octahedron_decode" qualifiers="static"> <return type="Vector3" /> <param index="0" name="uv" type="Vector2" /> <description> + Returns the [Vector3] from an octahedral-compressed form created using [method octahedron_encode] (stored as a [Vector2]). </description> </method> <method name="octahedron_encode" qualifiers="const"> <return type="Vector2" /> <description> + Returns the octahedral-encoded (oct32) form of this [Vector3] as a [Vector2]. Since a [Vector2] occupies 1/3 less memory compared to [Vector3], this form of compression can be used to pass greater amounts of [method normalized] [Vector3]s without increasing storage or memory requirements. See also [method octahedron_decode]. + [b]Note:[/b] [method octahedron_encode] can only be used for [method normalized] vectors. [method octahedron_encode] does [i]not[/i] check whether this [Vector3] is normalized, and will return a value that does not decompress to the original value if the [Vector3] is not normalized. + [b]Note:[/b] Octahedral compression is [i]lossy[/i], although visual differences are rarely perceptible in real world scenarios. </description> </method> <method name="outer" qualifiers="const"> |