diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2020-02-25 18:10:58 +0100 |
|---|---|---|
| committer | Rémi Verschelde <rverschelde@gmail.com> | 2020-02-25 22:02:36 +0100 |
| commit | a7e1df4b1d72ee4d81274450063e0b89103d72b2 (patch) | |
| tree | ecebffb161df0624224b7535f954695b76bdd06d /doc/classes/PackedFloat32Array.xml | |
| parent | 2ead439370ab220043df3fe1effc239ee597c1cd (diff) | |
doc: Sync classref for Packed{Int,Float}{32,64}Array additions
Diffstat (limited to 'doc/classes/PackedFloat32Array.xml')
| -rw-r--r-- | doc/classes/PackedFloat32Array.xml | 114 |
1 files changed, 114 insertions, 0 deletions
diff --git a/doc/classes/PackedFloat32Array.xml b/doc/classes/PackedFloat32Array.xml new file mode 100644 index 0000000000..ee82586cdb --- /dev/null +++ b/doc/classes/PackedFloat32Array.xml @@ -0,0 +1,114 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="PackedFloat32Array" version="4.0"> + <brief_description> + A packed [Array] of 32-bit floating-point values. + </brief_description> + <description> + An [Array] specifically designed to hold 32-bit floating-point values. Packs data tightly, so it saves memory for large array sizes. + [b]Note:[/b] This type is passed by value and not by reference. + If you need to pack 64-bit floats tightly, see [PackedFloat64Array]. + </description> + <tutorials> + </tutorials> + <methods> + <method name="PackedFloat32Array"> + <return type="PackedFloat32Array"> + </return> + <argument index="0" name="from" type="Array"> + </argument> + <description> + Constructs a new [PackedFloat32Array]. Optionally, you can pass in a generic [Array] that will be converted. + </description> + </method> + <method name="append"> + <return type="void"> + </return> + <argument index="0" name="value" type="float"> + </argument> + <description> + Appends an element at the end of the array (alias of [method push_back]). + </description> + </method> + <method name="append_array"> + <return type="void"> + </return> + <argument index="0" name="array" type="PackedFloat32Array"> + </argument> + <description> + Appends a [PackedFloat32Array] at the end of this array. + </description> + </method> + <method name="empty"> + <return type="bool"> + </return> + <description> + Returns [code]true[/code] if the array is empty. + </description> + </method> + <method name="insert"> + <return type="int"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="value" type="float"> + </argument> + <description> + Inserts a new element at a given position in the array. The position must be valid, or at the end of the array ([code]idx == size()[/code]). + </description> + </method> + <method name="invert"> + <return type="void"> + </return> + <description> + Reverses the order of the elements in the array. + </description> + </method> + <method name="push_back"> + <return type="void"> + </return> + <argument index="0" name="value" type="float"> + </argument> + <description> + Appends an element at the end of the array. + </description> + </method> + <method name="remove"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + Removes an element from the array by index. + </description> + </method> + <method name="resize"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <description> + 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. + </description> + </method> + <method name="set"> + <return type="void"> + </return> + <argument index="0" name="idx" type="int"> + </argument> + <argument index="1" name="value" type="float"> + </argument> + <description> + Changes the float at the given index. + </description> + </method> + <method name="size"> + <return type="int"> + </return> + <description> + Returns the size of the array. + </description> + </method> + </methods> + <constants> + </constants> +</class> |