Provides script language access to C++ objects of this type.
| Class Hierarchy | No registered superclass. |
Function members are as follows:
| Return Type | Function Name | Documentation |
|---|---|---|
| <Color4444Array> | Color4444Array | The <Color4444Array> constructor. |
| int32 | Add | Adds a <Color4444> object to the end of the array. |
| int32 | Clear | Clears the array and frees the underlying memory, but does not destroy the <Color4444Array> object. |
| int32 | Combine | Given ArrayA ( this array ) and ArrayB ( not this array ), combines ArrayB with ArrayA at the specified index in ArrayA. |
| int32 | ConvertBytesToCount | Sets the array count to a value guaranteed to be large enough to store an array of N bytes. Will round up to the nearest positive <int32> if the byte count provided does not align with the number of bytes per element. For example, <float64> values are 8 bytes each, so providing a value of 16 bytes ensures the array count is set to 2. Similarly, providing a value of 17 bytes, which is not a multiple of 8, ensures the array count is set to 3. |
| int32 | Copy | Copies the value of the source array into this array. |
| int32 | Del | Deletes an item from the array. |
| int32 | ElementSize | Returns the size in bytes of each element of the array. Returns 2 because a <Color4444> object requires 2 bytes of storage for each element in the array. |
| int32 | Fill | Sets all the items in the array to this value. |
| int32 | Find | Finds a value in the array and returns the index or -1 if the value is not found. |
| <Color4444> | Get | Returns a pointer to the <Color4444> object at the specified index. |
| int32 | GetCount | Returns the count of the underlying array object. |
| <Color4444> | GetFirst | Returns a pointer to the first object in the array or returns nullptr if the array is empty. |
| <Color4444> | GetLast | Returns a pointer to the last object in the array or returns nullptr if the array is empty. |
| <Uint8ArrayView> | GetView | Returns a <Uint8ArrayView> that contains first and last iterators for the collection. |
| int32 | Insert | Inserts a <Color4444> value into the array. Does not deallocate or destroy the <Color4444> object. May incur re-allocation costs depending on the size of any allocated reserve. |
| int32 | Merge | Adds a <Color4444> object to the end if the value is not already in the array. |
| int32 | Move | Moves the memory from the source array to the destination array. Leaves the source array empty with a count of zero. |
| int32 | Pop | Pops the first item off the top of the stack. |
| int32 | Push | Pushes an item onto the stack ( at the end ). |
| int32 | Relocate | Relocates a chunk of the array to a new index. |
| int32 | Set | Sets the value at the specified index to the value of the specified object. |
| int32 | Shrink | Shrinks the array to a sub-range. |
| int32 | SizeInBytes | Returns the size in bytes of the array, which is the total number of bytes currently being used by the array, and does not include any allocated reserve. |
Object members are as follows:
| Type Name | Accessor Name | Documentation |
|---|---|---|
| <Color4444Array> | Value | This member is an array containing the <Color4444> objects in the array. Accessor syntax is as follows: array.Value |
| int32 | Count | Gets or sets the number of objects in the array. Setting the count to zero frees all the memory owned by the array, but does not destroy the array object. |
| int32 | Reserve | Gets or sets the reserve allocation. Note: this does not change the array count, it merely changes the size of the underlying buffer. |