PoolColorArray

A pooled array of Colors.

Description

An array specifically designed to hold Color. Optimized for memory usage, does not fragment the memory.

Note: This type is passed by value and not by reference. This means that when mutating a class property of type PoolColorArray or mutating a PoolColorArray within an Array or Dictionary, changes will be lost:

var array = [PoolColorArray()]
array[0].push_back(Color(0.1, 0.2, 0.3, 0.4))
print(array)  # [[]] (empty PoolColorArray within an Array)

Instead, the entire PoolColorArray property must be reassigned with = for it to be changed:

var array = [PoolColorArray()]
var pool_array = array[0]
pool_array.push_back(Color(0.1, 0.2, 0.3, 0.4))
array[0] = pool_array
print(array)  # [[(0.1, 0.2, 0.3, 0.4)]] (PoolColorArray with 1 element inside an Array)

Methods

PoolColorArray

PoolColorArray ( Array from )

void

append ( Color color )

void

append_array ( PoolColorArray array )

int

count ( Color value )

bool

empty ( )

void

fill ( Color color )

int

find ( Color value, int from=0 )

bool

has ( Color value )

int

insert ( int idx, Color color )

void

invert ( )

void

push_back ( Color color )

void

remove ( int idx )

void

resize ( int idx )

int

rfind ( Color value, int from=-1 )

void

set ( int idx, Color color )

int

size ( )

Method Descriptions

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


  • void append ( Color color )

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


Appends a PoolColorArray at the end of this array.


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


Returns true if the array is empty.


  • void fill ( Color color )

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 -1 if from is out of bounds.


Returns true if the array contains the given value.

Note: This is equivalent to using the in operator.


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()).


  • void invert ( )

Reverses the order of the elements in the array.


  • void push_back ( Color color )

Appends a value to the array.


  • void remove ( int idx )

Removes an element from the array by index.


  • void resize ( int idx )

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.


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. If the adjusted start index is out of bounds, this method searches from the end of the array.


Changes the Color at the given index.


Returns the number of elements in the array.