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	PackedColorArray ( PackedColorArray from )
PackedColorArray	PackedColorArray ( Array from )

Methods

bool	append ( Color value )
void	append_array ( PackedColorArray array )
int	bsearch ( Color value, bool before=true )
PackedColorArray	duplicate ( )
void	fill ( Color value )
bool	has ( Color value ) const
int	insert ( int at_index, Color value )
bool	is_empty ( ) const
bool	push_back ( Color value )
void	remove ( int index )
int	resize ( int new_size )
void	reverse ( )
void	set ( int index, Color value )
int	size ( ) const
void	sort ( )
PackedColorArray	subarray ( int from, int to ) const
PackedByteArray	to_byte_array ( ) const

Operators

bool	operator != ( )
bool	operator != ( PackedColorArray right )
PackedColorArray	operator + ( PackedColorArray right )
bool	operator == ( )
bool	operator == ( PackedColorArray right )
Color	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

• bool append ( Color value )

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.

---

• 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.

---

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

---

• void set ( int index, Color value )

Changes the Color at the given index.

---

• int size ( ) const

Returns the size of the array.

---

• void sort ( )

Sorts the elements of the array in ascending order.

---

• PackedColorArray subarray ( int from, int to ) const

---

• PackedByteArray to_byte_array ( ) const

Operator Descriptions

• bool operator != ( )

---

• bool operator != ( PackedColorArray right )

---

• PackedColorArray operator + ( PackedColorArray right )

---

• bool operator == ( )

---

• bool operator == ( PackedColorArray right )

---

• Color operator [] ( int index )