PackedFloat32Array

A packed array of 32-bit floating-point values.

Description

An array specifically designed to hold 32-bit floating-point values (float). Packs data tightly, so it saves memory for large array sizes.

If you need to pack 64-bit floats tightly, see PackedFloat64Array.

Note

There are notable differences when using this API with C#. See C# API differences to GDScript for more information.

Constructors

Methods

Operators

Constructor Descriptions

PackedFloat32Array PackedFloat32Array ( )

Constructs an empty PackedFloat32Array.

PackedFloat32Array PackedFloat32Array ( PackedFloat32Array from )

Constructs a PackedFloat32Array as a copy of the given PackedFloat32Array.

PackedFloat32Array PackedFloat32Array ( Array from )

Constructs a new PackedFloat32Array. Optionally, you can pass in a generic Array that will be converted.

Method Descriptions

bool append ( float value )

Appends an element at the end of the array (alias of push_back).

void append_array ( PackedFloat32Array array )

Appends a PackedFloat32Array at the end of this array.

int bsearch ( float value, bool before=true )

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 before specifier can be passed. If false, the returned index comes after all existing entries of the value in the array.

Note: Calling bsearch on an unsorted array results in unexpected behavior.

Note: @GDScript.NAN doesn’t behave the same as other numbers. Therefore, the results from this method may not be accurate if NaNs are included.

void clear ( )

Clears the array. This is equivalent to using resize with a size of 0.

int count ( float value ) const

Returns the number of times an element is in the array.

Note: @GDScript.NAN doesn’t behave the same as other numbers. Therefore, the results from this method may not be accurate if NaNs are included.

PackedFloat32Array duplicate ( )

Creates a copy of the array, and returns it.

void fill ( float value )

Assigns the given value to all elements in the array. This can typically be used together with resize to create an array with a given size and initialized elements.

int find ( float value, int from=0 ) const

Searches the array for a value and returns its index or -1 if not found. Optionally, the initial search index can be passed.

Note: @GDScript.NAN doesn’t behave the same as other numbers. Therefore, the results from this method may not be accurate if NaNs are included.

bool has ( float value ) const

Returns true if the array contains value.

Note: @GDScript.NAN doesn’t behave the same as other numbers. Therefore, the results from this method may not be accurate if NaNs are included.

int insert ( int at_index, 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()).

bool is_empty ( ) const

Returns true if the array is empty.

bool push_back ( float value )

Appends an element at the end of the array.

void remove_at ( int index )

Removes an element from the array by index.

int resize ( int new_size )

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.

void reverse ( )

Reverses the order of the elements in the array.

int rfind ( float value, int from=-1 ) const

Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array.

Note: @GDScript.NAN doesn’t behave the same as other numbers. Therefore, the results from this method may not be accurate if NaNs are included.

void set ( int index, float value )

Changes the float at the given index.

int size ( ) const

Returns the number of elements in the array.

PackedFloat32Array slice ( int begin, int end=2147483647 ) const

Returns the slice of the PackedFloat32Array, from begin (inclusive) to end (exclusive), as a new PackedFloat32Array.

The absolute value of begin and end will be clamped to the array size, so the default value for end makes it slice to the size of the array by default (i.e. arr.slice(1) is a shorthand for arr.slice(1, arr.size())).

If either begin or end are negative, they will be relative to the end of the array (i.e. arr.slice(0, -2) is a shorthand for arr.slice(0, arr.size() - 2)).

void sort ( )

Sorts the elements of the array in ascending order.

Note: @GDScript.NAN doesn’t behave the same as other numbers. Therefore, the results from this method may not be accurate if NaNs are included.

PackedByteArray to_byte_array ( ) const

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 float32_array.size() * 4.

Operator Descriptions

bool operator != ( PackedFloat32Array right )

Returns true if contents of the arrays differ.

PackedFloat32Array operator + ( PackedFloat32Array right )

Returns a new PackedFloat32Array with contents of right added at the end of this array. For better performance, consider using append_array instead.

bool operator == ( PackedFloat32Array right )

Returns true if contents of both arrays are the same, i.e. they have all equal floats at the corresponding indices.

float operator [] ( int index )

Returns the float at index index. Negative indices can be used to access the elements starting from the end. Using index out of array’s bounds will result in an error.

Note that float type is 64-bit, unlike the values stored in the array.

Previous Next

© Copyright 2014-present Juan Linietsky, Ariel Manzur and the Godot community (CC BY 3.0). Revision 53e837c6.

Built with Sphinx using a theme provided by Read the Docs.