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 ) |
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.
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.
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.
Searches the array for a value and returns its index or -1
if not found. Optionally, the initial search index can be passed.
Returns true
if the array contains 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.
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.
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.
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
Operator Descriptions¶
bool operator != ( PackedColorArray right )
PackedColorArray operator + ( PackedColorArray right )
bool operator == ( PackedColorArray right )