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

Merge pull request #60451 from timothyqiu/pool-array-doc

Browse source 
Remove `Array` link in description of `Pool*Array`
This commit is contained in:
Rémi Verschelde 2022-04-25 23:05:45 +02:00 committed by GitHub
commit 82e375d0a2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 14 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
doc/classes/PoolByteArray.xml
View file

@ -1,10 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PoolByteArray" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
A pooled [Array] of bytes.
A pooled array of bytes.
</brief_description>
<description>
An [Array] specifically designed to hold bytes. Optimized for memory usage, does not fragment the memory.
An array specifically designed to hold bytes. Optimized for memory usage, does not fragment the memory.
[b]Note:[/b] This type is passed by value and not by reference.
</description>
<tutorials>

4
doc/classes/PoolColorArray.xml
View file

@ -1,10 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PoolColorArray" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
A pooled [Array] of [Color].
A pooled array of [Color].
</brief_description>
<description>
An [Array] specifically designed to hold [Color]. Optimized for memory usage, does not fragment the memory.
An array specifically designed to hold [Color]. Optimized for memory usage, does not fragment the memory.
[b]Note:[/b] This type is passed by value and not by reference.
</description>
<tutorials>

4
doc/classes/PoolIntArray.xml
View file

@ -1,10 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PoolIntArray" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
A pooled [Array] of integers ([int]).
A pooled array of integers ([int]).
</brief_description>
<description>
An [Array] specifically designed to hold integer values ([int]). Optimized for memory usage, does not fragment the memory.
An array specifically designed to hold integer values ([int]). Optimized for memory usage, does not fragment the memory.
[b]Note:[/b] This type is passed by value and not by reference.
[b]Note:[/b] This type is limited to signed 32-bit integers, which means it can only take values in the interval [code][-2^31, 2^31 - 1][/code], i.e. [code][-2147483648, 2147483647][/code]. Exceeding those bounds will wrap around. In comparison, [int] uses signed 64-bit integers which can hold much larger values.
</description>

4
doc/classes/PoolRealArray.xml
View file

@ -1,10 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PoolRealArray" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
A pooled [Array] of reals ([float]).
A pooled array of reals ([float]).
</brief_description>
<description>
An [Array] specifically designed to hold floating-point values. Optimized for memory usage, does not fragment the memory.
An array specifically designed to hold floating-point values. Optimized for memory usage, does not fragment the memory.
[b]Note:[/b] This type is passed by value and not by reference.
[b]Note:[/b] Unlike primitive [float]s which are 64-bit, numbers stored in [PoolRealArray] are 32-bit floats. This means values stored in [PoolRealArray] have lower precision compared to primitive [float]s. If you need to store 64-bit floats in an array, use a generic [Array] with [float] elements as these will still be 64-bit. However, using a generic [Array] to store [float]s will use roughly 6 times more memory compared to a [PoolRealArray].
</description>

4
doc/classes/PoolStringArray.xml
View file

@ -1,10 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PoolStringArray" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
A pooled [Array] of [String].
A pooled array of [String].
</brief_description>
<description>
An [Array] specifically designed to hold [String]s. Optimized for memory usage, does not fragment the memory.
An array specifically designed to hold [String]s. Optimized for memory usage, does not fragment the memory.
[b]Note:[/b] This type is passed by value and not by reference.
</description>
<tutorials>

4
doc/classes/PoolVector2Array.xml
View file

@ -1,10 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PoolVector2Array" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
A pooled [Array] of [Vector2].
A pooled array of [Vector2].
</brief_description>
<description>
An [Array] specifically designed to hold [Vector2]. Optimized for memory usage, does not fragment the memory.
An array specifically designed to hold [Vector2]. Optimized for memory usage, does not fragment the memory.
[b]Note:[/b] This type is passed by value and not by reference.
</description>
<tutorials>

4
doc/classes/PoolVector3Array.xml
View file

@ -1,10 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PoolVector3Array" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
A pooled [Array] of [Vector3].
A pooled array of [Vector3].
</brief_description>
<description>
An [Array] specifically designed to hold [Vector3]. Optimized for memory usage, does not fragment the memory.
An array specifically designed to hold [Vector3]. Optimized for memory usage, does not fragment the memory.
[b]Note:[/b] This type is passed by value and not by reference.
</description>
<tutorials>