All Implemented Interfaces:

kotlin.Cloneable
```
public class PolyColor
 implements Cloneable
                    
```
The color used by PolyUI. It stores the color in the HSBA format, and can be converted to ARGB.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`PolyColor.Animated`	An animatable version of Color, that supports recoloring with animations.
`public final class`	`PolyColor.Gradient`	A gradient color.
`public final class`	`PolyColor.Chroma`	A color that changes over time, in an endless cycle. You can use the saturation and brightness fields to set the tone of the chroma. Some examples: `brightness = 0.2f, saturation = 0.8f` -> dark chroma `brightness = 0.8f, saturation = 0.8f` -> less offensive chroma tone
`public class`	`PolyColor.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`public final static PolyColor`	`TRANSPARENT`
`public final static PolyColor`	`WHITE`
`public final static PolyColor`	`BLACK`
`public final static Colors.Palette`	`TRANSPARENT_PALETTE`
`private Float`	`hue`
`private Float`	`saturation`
`private Float`	`brightness`
`private Float`	`alpha`
`private transient Boolean`	`dirty`
`private transient Integer`	`argb`
`private final Integer`	`r`
`private final Integer`	`g`
`private final Integer`	`b`
`private final Integer`	`a`
`public final static PolyColor.Companion`	`Companion`

Constructor Summary

Constructors
Constructor	Description
`PolyColor(FloatArray hsb, Integer alpha)`
`PolyColor(FloatArray hsb)`
`PolyColor(FloatArray hsb, Float alpha)`
`PolyColor(Integer r, Integer g, Integer b, Integer alpha)`
`PolyColor(Integer r, Integer g, Integer b)`
`PolyColor(Integer r, Integer g, Integer b, Float alpha)`
`PolyColor(Float hue, Float saturation, Float brightness, Integer alpha)`
`PolyColor(Float hue, Float saturation, Float brightness, Float alpha)`
`PolyColor(Float hue, Float saturation, Float brightness)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Float`	`getHue()`
`final Unit`	`setHue(Float hue)`
`final Float`	`getSaturation()`
`final Unit`	`setSaturation(Float saturation)`
`final Float`	`getBrightness()`
`final Unit`	`setBrightness(Float brightness)`
`final Float`	`getAlpha()`
`final Unit`	`setAlpha(Float alpha)`
`final Boolean`	`getDirty()`	Set this to true to update the argb value.
`final Unit`	`setDirty(Boolean dirty)`	Set this to true to update the argb value.
`final Integer`	`getARGB()`
`final Unit`	`setArgb(Integer argb)`	return an integer representation of this color.
`final Integer`	`getR()`
`final Integer`	`getG()`
`final Integer`	`getB()`
`final Integer`	`getA()`
`PolyColor.Animated`	`toAnimatable()`
`PolyColor`	`clone()`
`Boolean`	`equals(Object other)`
`String`	`toString()`
`Integer`	`hashCode()`
`final PolyColor`	`take(PolyColor color)`
`final static PolyColor`	`from(String hex)`	Turn the given hex string into a color.
`final static PolyColor`	`from(String hex, Integer alpha)`
`final static PolyColor`	`from(String hex, Float alpha)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PolyColor

PolyColor(FloatArray hsb, Integer alpha)

PolyColor
```
PolyColor(FloatArray hsb)
```

PolyColor
```
PolyColor(FloatArray hsb, Float alpha)
```

PolyColor

PolyColor(Integer r, Integer g, Integer b, Integer alpha)

PolyColor

PolyColor(Integer r, Integer g, Integer b)

PolyColor

PolyColor(Integer r, Integer g, Integer b, Float alpha)

PolyColor

PolyColor(Float hue, Float saturation, Float brightness, Integer alpha)

PolyColor

PolyColor(Float hue, Float saturation, Float brightness, Float alpha)

PolyColor

PolyColor(Float hue, Float saturation, Float brightness)

Method Detail

getHue
```
 final Float getHue()
```

setHue
```
 final Unit setHue(Float hue)
```

getSaturation
```
 final Float getSaturation()
```

setSaturation

 final Unit setSaturation(Float saturation)

getBrightness
```
 final Float getBrightness()
```

setBrightness

 final Unit setBrightness(Float brightness)

getAlpha
```
 final Float getAlpha()
```

setAlpha
```
 final Unit setAlpha(Float alpha)
```

getDirty
```
 final Boolean getDirty()
```
Set this to true to update the argb value.

setDirty
```
 final Unit setDirty(Boolean dirty)
```
Set this to true to update the argb value.

getARGB
```
 final Integer getARGB()
```

setArgb
```
 final Unit setArgb(Integer argb)
```
return an integer representation of this color. Utilizes bit-shifts to store the color as one 32-bit integer, like so:
0bAAAAAAAARRRRRRRRGGGGGGGGBBBBBBBB aka 0xAARRGGBB

getR
```
 final Integer getR()
```

getG
```
 final Integer getG()
```

getB
```
 final Integer getB()
```

getA
```
 final Integer getA()
```

toAnimatable
```
 PolyColor.Animated toAnimatable()
```
Returns:

a new, animatable version of this color

clone
```
 PolyColor clone()
```

equals
```
 Boolean equals(Object other)
```

toString
```
 String toString()
```

hashCode
```
 Integer hashCode()
```

take
```
 final PolyColor take(PolyColor color)
```

from
```
 final static PolyColor from(String hex)
```
Turn the given hex string into a color.
- If it is 8 characters long, it is assumed to be in the format #RRGGBBAA (alpha optional)
- If there is a leading #, it will be removed.
- If it is 1 character long, the character is repeated e.g. #f ->#ffffff
- If it is 2 characters long, the character is repeated e.g. #0f ->#0f0f0f
- If it is 3 characters long, the character is repeated e.g. #0fe ->#00ffee

from

 final static PolyColor from(String hex, Integer alpha)

from

 final static PolyColor from(String hex, Float alpha)

Class PolyColor

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PolyColor

PolyColor

PolyColor

PolyColor

PolyColor

PolyColor

PolyColor

PolyColor

PolyColor

Method Detail

getHue

setHue

getSaturation

setSaturation

getBrightness

setBrightness

getAlpha

setAlpha

getDirty

setDirty

getARGB

setArgb

getR

getG

getB

getA

toAnimatable

clone

equals

toString

hashCode

take

from

from

from