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 |
|---|---|---|
| <Color> | Color | Constructs a <Color> object with the specified red, green, blue, and alpha values. |
| int32 | Assign | Assigns the right-hand object to the left-hand object. |
| int32 | BindIterators | Binds iterators to this object. |
| int32 | BindPointer | Binds a <MemoryPointer> or subclass to this object. The <MemoryPointer> becomes a pointer to this object that can be passed to compatible functions. |
| int32 | Compare | Returns true if the left-hand color is equal to the right-hand color. Otherwise returns false. |
| int32 | Fill | Fills the array with the specified value. |
| <Uint8Iterator> | First | Returns an iterator positioned at the start of the collection. |
| <uint8> | GetComponent | Returns the vector component value at the specified index. |
| float32 | GetComponentAsFloat32 | Returns the component at the specified index as a normalized <float32> value. This value is between 0.0 and 1.0. |
| float64 | GetComponentAsFloat64 | Returns the color value (0-255) as a <float64> ranging from 0.0 to 1.0. |
| int32 | GetCount | Returns the count of the components in the underlying <Color> object, which is 4. |
| uint32 | GetData | Returns the color byte values packed into a uint32. |
| int32 | GetElementSize | Returns the size of the <Color> object's component element size, which is 1 byte. |
| <Uint8Pointer> | GetPointer | Returns a pointer to this object. The pointer object is allocated with new so you must use auto in the declaration or you must manually delete the pointer object. For example: auto Uint8Pointer ptr = object.GetPointer(). |
| int32 | GetSizeInBytes | Returns the size of the <Color> object, which is 4 bytes. |
| <Uint8ArrayView> | GetView | Returns a <Uint8ArrayView> that contains first and last iterators for the collection. |
| <Uint8Iterator> | Last | Returns an iterator positioned at the end of the collection. |
| int32 | SetComponent | Sets the <Color> component at the specified index to the specified value. |
| int32 | SetData | Sets the color data from by values in a packed uint32. |
| int32 | SetRGB | Sets the red, green and blue values of a <Color> object. |
| int32 | SetRGBA | Sets the specified red, green, blue, and alpha values. |
Object members are as follows:
| Type Name | Accessor Name | Documentation |
|---|---|---|
| <Color> | Value | Gets or sets the value of the <Color> object. Useful for when you want to copy color values with assignment expressions such as myColorA.Value = myColorB.Value. |
| <uint8> | A | Gets or sets the alpha value of the color. |
| <uint8> | B | Gets or sets the blue value of the color. |
| <uint8> | G | Gets or sets the green value of the color. |
| <uint8> | R | Gets or sets the red value of the color. |
| <uint8> | W | Gets or sets the alpha value of the color. |
| <uint8> | X | Gets or sets the red value of the color. |
| <uint8> | Y | Gets or sets the green value of the color. |
| <uint8> | Z | Gets or sets the blue value of the color. |