godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2025-12-31 17:49:03 +03:00
Code Issues Packages Projects Releases Wiki Activity

Sync classref with master branch (4.0 changes)

Browse Source
This commit is contained in:
Rémi Verschelde
2020-03-13 17:17:50 +01:00
parent 966fd002ed
commit 03d40ff29e
360 changed files with 17483 additions and 16479 deletions
Download Patch File Download Diff File Expand all files Collapse all files

138
classes/class_packedfloat32array.rst Normal file
View File

@@ -0,0 +1,138 @@
:github_url: hide
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the PackedFloat32Array.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_PackedFloat32Array:
PackedFloat32Array
==================
A packed :ref:`Array<class_Array>` of 32-bit floating-point values.
Description
-----------
An :ref:`Array<class_Array>` specifically designed to hold 32-bit floating-point values. Packs data tightly, so it saves memory for large array sizes.
**Note:** This type is passed by value and not by reference.
If you need to pack 64-bit floats tightly, see :ref:`PackedFloat64Array<class_PackedFloat64Array>`.
Methods
-------
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedFloat32Array<class_PackedFloat32Array>` | :ref:`PackedFloat32Array<class_PackedFloat32Array_method_PackedFloat32Array>` **(** :ref:`Array<class_Array>` from **)** |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`append<class_PackedFloat32Array_method_append>` **(** :ref:`float<class_float>` value **)** |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`append_array<class_PackedFloat32Array_method_append_array>` **(** :ref:`PackedFloat32Array<class_PackedFloat32Array>` array **)** |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`empty<class_PackedFloat32Array_method_empty>` **(** **)** |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`insert<class_PackedFloat32Array_method_insert>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` value **)** |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`invert<class_PackedFloat32Array_method_invert>` **(** **)** |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`push_back<class_PackedFloat32Array_method_push_back>` **(** :ref:`float<class_float>` value **)** |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove<class_PackedFloat32Array_method_remove>` **(** :ref:`int<class_int>` idx **)** |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`resize<class_PackedFloat32Array_method_resize>` **(** :ref:`int<class_int>` idx **)** |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set<class_PackedFloat32Array_method_set>` **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` value **)** |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`size<class_PackedFloat32Array_method_size>` **(** **)** |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
Method Descriptions
-------------------
.. _class_PackedFloat32Array_method_PackedFloat32Array:
- :ref:`PackedFloat32Array<class_PackedFloat32Array>` **PackedFloat32Array** **(** :ref:`Array<class_Array>` from **)**
Constructs a new ``PackedFloat32Array``. Optionally, you can pass in a generic :ref:`Array<class_Array>` that will be converted.
----
.. _class_PackedFloat32Array_method_append:
- void **append** **(** :ref:`float<class_float>` value **)**
Appends an element at the end of the array (alias of :ref:`push_back<class_PackedFloat32Array_method_push_back>`).
----
.. _class_PackedFloat32Array_method_append_array:
- void **append_array** **(** :ref:`PackedFloat32Array<class_PackedFloat32Array>` array **)**
Appends a ``PackedFloat32Array`` at the end of this array.
----
.. _class_PackedFloat32Array_method_empty:
- :ref:`bool<class_bool>` **empty** **(** **)**
Returns ``true`` if the array is empty.
----
.. _class_PackedFloat32Array_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_PackedFloat32Array_method_invert:
- void **invert** **(** **)**
Reverses the order of the elements in the array.
----
.. _class_PackedFloat32Array_method_push_back:
- void **push_back** **(** :ref:`float<class_float>` value **)**
Appends an element at the end of the array.
----
.. _class_PackedFloat32Array_method_remove:
- void **remove** **(** :ref:`int<class_int>` idx **)**
Removes an element from the array by index.
----
.. _class_PackedFloat32Array_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.
----
.. _class_PackedFloat32Array_method_set:
- void **set** **(** :ref:`int<class_int>` idx, :ref:`float<class_float>` value **)**
Changes the float at the given index.
----
.. _class_PackedFloat32Array_method_size:
- :ref:`int<class_int>` **size** **(** **)**
Returns the size of the array.