Attention
You are reading the latest
(unstable) version of this documentation, which may document features not available
or compatible with Godot 3.x.
Checking the stable version of the documentation...
Work in progress
Godot documentation is being updated to reflect the latest changes in version
4.0. Some documentation pages may
still state outdated information. This banner will tell you if you're reading one of such pages.
The contents of this page are up to date. If you can still find outdated information, please open an issue.
PackedColorArray¶
A packed array of Colors.
Description¶
An array specifically designed to hold Color. Packs data tightly, so it saves memory for large array sizes.
Constructors¶
PackedColorArray ( ) |
|
PackedColorArray ( PackedColorArray from ) |
|
PackedColorArray ( Array from ) |
Methods¶
void |
append_array ( PackedColorArray array ) |
void |
clear ( ) |
duplicate ( ) |
|
void |
|
is_empty ( ) const |
|
void |
|
void |
reverse ( ) |
void |
|
size ( ) const |
|
void |
sort ( ) |
to_byte_array ( ) const |
Operators¶
operator != ( PackedColorArray right ) |
|
operator + ( PackedColorArray right ) |
|
operator == ( PackedColorArray right ) |
|
operator [] ( int index ) |
Constructor Descriptions¶
PackedColorArray PackedColorArray ( )
Constructs an empty PackedColorArray.
PackedColorArray PackedColorArray ( PackedColorArray from )
Constructs a PackedColorArray as a copy of the given PackedColorArray.
PackedColorArray PackedColorArray ( Array from )
Constructs a new PackedColorArray. Optionally, you can pass in a generic Array that will be converted.
Method Descriptions¶
Appends an element at the end of the array (alias of push_back).
void append_array ( PackedColorArray array )
Appends a PackedColorArray at the end of this array.
int bsearch ( Color 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.
void clear ( )
Clears the array. This is equivalent to using resize with a size of 0.
int count ( Color value ) const
Returns the number of times an element is in the array.
PackedColorArray duplicate ( )
Creates a copy of the array, and returns it.
void fill ( Color 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 ( Color 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.
bool has ( Color value ) const
Returns true if the array contains value.
int insert ( int at_index, Color 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 ( Color value )
Appends a value to the array.
void remove_at ( int index )
Removes an element from the array by index.
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 ( Color 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.
void set ( int index, Color value )
Changes the Color at the given index.
int size ( ) const
Returns the number of elements in the array.
PackedColorArray slice ( int begin, int end=2147483647 ) const
Returns the slice of the PackedColorArray, from begin (inclusive) to end (exclusive), as a new PackedColorArray.
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.
PackedByteArray to_byte_array ( ) const
Returns a PackedByteArray with each color encoded as bytes.
Operator Descriptions¶
bool operator != ( PackedColorArray right )
Returns true if contents of the arrays differ.
PackedColorArray operator + ( PackedColorArray right )
Returns a new PackedColorArray with contents of right added at the end of this array. For better performance, consider using append_array instead.
bool operator == ( PackedColorArray right )
Returns true if contents of both arrays are the same, i.e. they have all equal Colors at the corresponding indices.
Color operator [] ( int index )
Returns the Color 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.