| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144 |
- :github_url: hide
- .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the PoolRealArray.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_PoolRealArray:
- PoolRealArray
- =============
- A pooled :ref:`Array<class_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.
- **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``.
- Methods
- -------
- +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
- | :ref:`PoolRealArray<class_PoolRealArray>` | :ref:`PoolRealArray<class_PoolRealArray_method_PoolRealArray>` **(** :ref:`Array<class_Array>` from **)** |
- +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`append<class_PoolRealArray_method_append>` **(** :ref:`float<class_float>` value **)** |
- +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`append_array<class_PoolRealArray_method_append_array>` **(** :ref:`PoolRealArray<class_PoolRealArray>` array **)** |
- +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`empty<class_PoolRealArray_method_empty>` **(** **)** |
- +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
- | :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>` **(** **)** |
- +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`push_back<class_PoolRealArray_method_push_back>` **(** :ref:`float<class_float>` value **)** |
- +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`remove<class_PoolRealArray_method_remove>` **(** :ref:`int<class_int>` idx **)** |
- +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`resize<class_PoolRealArray_method_resize>` **(** :ref:`int<class_int>` idx **)** |
- +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set<class_PoolRealArray_method_set>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` value **)** |
- +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`size<class_PoolRealArray_method_size>` **(** **)** |
- +-------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
- Method Descriptions
- -------------------
- .. _class_PoolRealArray_method_PoolRealArray:
- - :ref:`PoolRealArray<class_PoolRealArray>` **PoolRealArray** **(** :ref:`Array<class_Array>` from **)**
- Constructs a new ``PoolRealArray``. Optionally, you can pass in a generic :ref:`Array<class_Array>` that will be converted.
- ----
- .. _class_PoolRealArray_method_append:
- - void **append** **(** :ref:`float<class_float>` value **)**
- Appends an element at the end of the array (alias of :ref:`push_back<class_PoolRealArray_method_push_back>`).
- ----
- .. _class_PoolRealArray_method_append_array:
- - void **append_array** **(** :ref:`PoolRealArray<class_PoolRealArray>` array **)**
- Appends a ``PoolRealArray`` at the end of this array.
- ----
- .. _class_PoolRealArray_method_empty:
- - :ref:`bool<class_bool>` **empty** **(** **)**
- Returns ``true`` if the array is empty.
- ----
- .. _class_PoolRealArray_method_insert:
- - :ref:`int<class_int>` **insert** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` value **)**
- Inserts a new element at a given position in the array. The position must be valid, or at the end of the array (``idx == size()``).
- ----
- .. _class_PoolRealArray_method_invert:
- - void **invert** **(** **)**
- Reverses the order of the elements in the array.
- ----
- .. _class_PoolRealArray_method_push_back:
- - void **push_back** **(** :ref:`float<class_float>` value **)**
- Appends an element at the end of the array.
- ----
- .. _class_PoolRealArray_method_remove:
- - void **remove** **(** :ref:`int<class_int>` idx **)**
- Removes an element from the array by index.
- ----
- .. _class_PoolRealArray_method_resize:
- - void **resize** **(** :ref:`int<class_int>` idx **)**
- 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.
- ----
- .. _class_PoolRealArray_method_set:
- - void **set** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` value **)**
- Changes the float at the given index.
- ----
- .. _class_PoolRealArray_method_size:
- - :ref:`int<class_int>` **size** **(** **)**
- Returns the size of 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.)`
- .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|
