godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

doc: Sync with current 3.5 branch (8ee69a88c)

Browse Source
This commit is contained in:
Rémi Verschelde
2022-04-29 14:16:57 +02:00
parent 94366cdd8f
commit 12786907c6
398 changed files with 9782 additions and 3681 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
classes/class_poolrealarray.rst
View File

@@ -9,16 +9,16 @@
PoolRealArray
=============
A pooled :ref:`Array<class_Array>` of reals (:ref:`float<class_float>`).
A pooled array of reals (:ref:`float<class_float>`).
Description
-----------
An :ref:`Array<class_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.
**Note:** This type is passed by value and not by reference.
\ **Note:** This type is passed by value and not by reference.
**Note:** Unlike primitive :ref:`float<class_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 :ref:`float<class_float>`\ s. If you need to store 64-bit floats in an array, use a generic :ref:`Array<class_Array>` with :ref:`float<class_float>` elements as these will still be 64-bit. However, using a generic :ref:`Array<class_Array>` to store :ref:`float<class_float>`\ s will use roughly 6 times more memory compared to a ``PoolRealArray``.
\ **Note:** Unlike primitive :ref:`float<class_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 :ref:`float<class_float>`\ s. If you need to store 64-bit floats in an array, use a generic :ref:`Array<class_Array>` with :ref:`float<class_float>` elements as these will still be 64-bit. However, using a generic :ref:`Array<class_Array>` to store :ref:`float<class_float>`\ s will use roughly 6 times more memory compared to a ``PoolRealArray``.
Methods
-------
@@ -32,6 +32,8 @@ Methods
+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`empty<class_PoolRealArray_method_empty>` **(** **)** |
+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`fill<class_PoolRealArray_method_fill>` **(** :ref:`float<class_float>` value **)** |
+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`insert<class_PoolRealArray_method_insert>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` value **)** |
+-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`invert<class_PoolRealArray_method_invert>` **(** **)** |
@@ -82,6 +84,14 @@ Returns ``true`` if the array is empty.
----
.. _class_PoolRealArray_method_fill:
- void **fill** **(** :ref:`float<class_float>` value **)**
Assigns the given value to all elements in the array. This can typically be used together with :ref:`resize<class_PoolRealArray_method_resize>` to create an array with a given size and initialized elements.
----
.. _class_PoolRealArray_method_insert:
- :ref:`int<class_int>` **insert** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` value **)**
@@ -120,7 +130,7 @@ Removes an element from the array by index.
Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size.
**Note:** Added elements are not automatically initialized to 0 and will contain garbage, i.e. indeterminate values.
\ **Note:** Added elements are not automatically initialized to 0 and will contain garbage, i.e. indeterminate values.
----
@@ -136,7 +146,7 @@ Changes the float at the given index.
- :ref:`int<class_int>` **size** **(** **)**
Returns the size of the array.
Returns the number of elements in the array.
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`