diff options
Diffstat (limited to 'doc/classes/PackedFloat32Array.xml')
| -rw-r--r-- | doc/classes/PackedFloat32Array.xml | 186 |
1 files changed, 131 insertions, 55 deletions
diff --git a/doc/classes/PackedFloat32Array.xml b/doc/classes/PackedFloat32Array.xml index ee82586cdb..6c77c4bee2 100644 --- a/doc/classes/PackedFloat32Array.xml +++ b/doc/classes/PackedFloat32Array.xml @@ -5,110 +5,186 @@ </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> + <constructors> + <constructor name="PackedFloat32Array"> + <return type="PackedFloat32Array" /> + <description> + Constructs an empty [PackedFloat32Array]. + </description> + </constructor> + <constructor name="PackedFloat32Array"> + <return type="PackedFloat32Array" /> + <argument index="0" name="from" type="PackedFloat32Array" /> + <description> + Constructs a [PackedFloat32Array] as a copy of the given [PackedFloat32Array]. + </description> + </constructor> + <constructor name="PackedFloat32Array"> + <return type="PackedFloat32Array" /> + <argument index="0" name="from" type="Array" /> <description> Constructs a new [PackedFloat32Array]. Optionally, you can pass in a generic [Array] that will be converted. </description> - </method> + </constructor> + </constructors> + <methods> <method name="append"> - <return type="void"> - </return> - <argument index="0" name="value" type="float"> - </argument> + <return type="bool" /> + <argument index="0" name="value" type="float" /> <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> + <return type="void" /> + <argument index="0" name="array" type="PackedFloat32Array" /> <description> Appends a [PackedFloat32Array] at the end of this array. </description> </method> - <method name="empty"> - <return type="bool"> - </return> + <method name="bsearch"> + <return type="int" /> + <argument index="0" name="value" type="float" /> + <argument index="1" name="before" type="bool" default="true" /> <description> - Returns [code]true[/code] if the array is empty. + Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, a [code]before[/code] specifier can be passed. If [code]false[/code], the returned index comes after all existing entries of the value in the array. + [b]Note:[/b] Calling [method bsearch] on an unsorted array results in unexpected behavior. + </description> + </method> + <method name="duplicate"> + <return type="PackedFloat32Array" /> + <description> + Creates a copy of the array, and returns it. + </description> + </method> + <method name="fill"> + <return type="void" /> + <argument index="0" name="value" type="float" /> + <description> + Assigns the given value to all elements in the array. This can typically be used together with [method resize] to create an array with a given size and initialized elements. + </description> + </method> + <method name="has" qualifiers="const"> + <return type="bool" /> + <argument index="0" name="value" type="float" /> + <description> + Returns [code]true[/code] if the array contains [code]value[/code]. </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> + <return type="int" /> + <argument index="0" name="at_index" type="int" /> + <argument index="1" name="value" type="float" /> <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> + <method name="is_empty" qualifiers="const"> + <return type="bool" /> <description> - Reverses the order of the elements in the array. + Returns [code]true[/code] if the array is empty. </description> </method> <method name="push_back"> - <return type="void"> - </return> - <argument index="0" name="value" type="float"> - </argument> + <return type="bool" /> + <argument index="0" name="value" type="float" /> <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> + <method name="remove_at"> + <return type="void" /> + <argument index="0" name="index" type="int" /> <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> + <return type="int" /> + <argument index="0" name="new_size" type="int" /> <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="reverse"> + <return type="void" /> + <description> + Reverses the order of the elements in the array. + </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> + <return type="void" /> + <argument index="0" name="index" type="int" /> + <argument index="1" name="value" type="float" /> <description> Changes the float at the given index. </description> </method> - <method name="size"> - <return type="int"> - </return> + <method name="size" qualifiers="const"> + <return type="int" /> + <description> + Returns the number of elements in the array. + </description> + </method> + <method name="slice" qualifiers="const"> + <return type="PackedFloat32Array" /> + <argument index="0" name="begin" type="int" /> + <argument index="1" name="end" type="int" /> <description> - Returns the size of the array. + </description> + </method> + <method name="sort"> + <return type="void" /> + <description> + Sorts the elements of the array in ascending order. + </description> + </method> + <method name="to_byte_array" qualifiers="const"> + <return type="PackedByteArray" /> + <description> + Returns a copy of the data converted to a [PackedByteArray], where each element have been encoded as 4 bytes. + The size of the new array will be [code]float32_array.size() * 4[/code]. </description> </method> </methods> - <constants> - </constants> + <operators> + <operator name="operator !="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator !="> + <return type="bool" /> + <argument index="0" name="right" type="PackedFloat32Array" /> + <description> + </description> + </operator> + <operator name="operator +"> + <return type="PackedFloat32Array" /> + <argument index="0" name="right" type="PackedFloat32Array" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <description> + </description> + </operator> + <operator name="operator =="> + <return type="bool" /> + <argument index="0" name="right" type="PackedFloat32Array" /> + <description> + </description> + </operator> + <operator name="operator []"> + <return type="float" /> + <argument index="0" name="index" type="int" /> + <description> + </description> + </operator> + </operators> </class> |