All Implemented Interfaces:

kotlin.Cloneable
```
public final class PolyColor.Chroma
extends PolyColor.Animated
                    
```
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

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private final Boolean`	`updating`
`private final Boolean`	`alwaysUpdates`
`private Long`	`speedNanos`
`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`

Constructor Summary

Constructors
Constructor	Description
`PolyColor.Chroma(Long speedNanos, Float brightness, Float saturation, Float alpha, Float initialHue)`
`PolyColor.Chroma(Long speedNanos, Float brightness, Float saturation, Float alpha)`
`PolyColor.Chroma(Long speedNanos, Float brightness, Float saturation)`
`PolyColor.Chroma(Long speedNanos, Float brightness)`
`PolyColor.Chroma(Long speedNanos)`
`PolyColor.Chroma()`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`Boolean`	`getUpdating()`
`Boolean`	`getAlwaysUpdates()`
`final Long`	`getSpeedNanos()`	the speed of this color, in nanoseconds.
`final Unit`	`setSpeedNanos(Long speedNanos)`	the speed of this color, in nanoseconds.
`Unit`	`recolor(PolyColor target, Animation.Type type, Long durationNanos)`	recolor this color to the target color, with the given animation type and duration.
`PolyColor.Chroma`	`clone()`
`final PolyColor.Animated`	`freeze()`	Convert this chroma color to a mutable color, which is a snapshot of this color at the time of calling this method.
`Boolean`	`update(Long deltaTimeNanos)`	update the color animation, if present.

Methods inherited from class org.polyfrost.polyui.color.PolyColor
equals, getA, getARGB, getAlpha, getB, getBrightness, getDirty, getG, getHue, getR, getSaturation, hashCode, setAlpha, setArgb, setBrightness, setDirty, setHue, setSaturation, take, toString
Methods inherited from class org.polyfrost.polyui.color.PolyColor.Animated
toAnimatable
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PolyColor.Chroma
```
PolyColor.Chroma(Long speedNanos, Float brightness, Float saturation, Float alpha, Float initialHue)
```
    Parameters:
    
    initialHue - the initial hue of the color, being any float value.
  - PolyColor.Chroma
```
PolyColor.Chroma(Long speedNanos, Float brightness, Float saturation, Float alpha)
```
  - PolyColor.Chroma
```
PolyColor.Chroma(Long speedNanos, Float brightness, Float saturation)
```
  - PolyColor.Chroma
```
PolyColor.Chroma(Long speedNanos, Float brightness)
```
  - PolyColor.Chroma
```
PolyColor.Chroma(Long speedNanos)
```
  - PolyColor.Chroma
```
PolyColor.Chroma()
```
- Method Detail
  - getUpdating
```
 Boolean getUpdating()
```
  - getAlwaysUpdates
```
 Boolean getAlwaysUpdates()
```
  - getSpeedNanos
```
 final Long getSpeedNanos()
```
    the speed of this color, in nanoseconds.
    The speed refers to the amount of time it takes for this color to complete one cycle, e.g. from red, through to blue, through to green, then back to red.
  - setSpeedNanos
```
 final Unit setSpeedNanos(Long speedNanos)
```
    the speed of this color, in nanoseconds.
    The speed refers to the amount of time it takes for this color to complete one cycle, e.g. from red, through to blue, through to green, then back to red.
  - recolor
```
@Deprecated(message = "Chroma colors cannot be animated.", level = DeprecationLevel.ERROR) Unit recolor(PolyColor target, Animation.Type type, Long durationNanos)
```
    recolor this color to the target color, with the given animation type and duration.
    make sure to check if the color is a gradient, as this method may not have the expected result!
    
    Parameters:
    
    type - animation type.
  - clone
```
 PolyColor.Chroma clone()
```
  - freeze
```
 final PolyColor.Animated freeze()
```
    Convert this chroma color to a mutable color, which is a snapshot of this color at the time of calling this method.
    
    Since:
    
    0.19.1
  - update
```
 Boolean update(Long deltaTimeNanos)
```
    update the color animation, if present. After, the animation is cleared, and the color becomes static again.
    
    Returns:
    
    true if the animation finished on this tick, false if otherwise

Class PolyColor.Chroma

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class org.polyfrost.polyui.color.PolyColor

Methods inherited from class org.polyfrost.polyui.color.PolyColor.Animated

Methods inherited from class java.lang.Object

Constructor Detail

PolyColor.Chroma

PolyColor.Chroma

PolyColor.Chroma

PolyColor.Chroma

PolyColor.Chroma

PolyColor.Chroma

Method Detail

getUpdating

getAlwaysUpdates

getSpeedNanos

setSpeedNanos

recolor

clone

freeze

update