polyui/org.polyfrost.polyui.color/PolyColor/Gradient

Gradient

class Gradient @JvmOverloads constructor(color1: Color, color2: Color, val type: PolyColor.Gradient.Type = Type.TopLeftToBottomRight) : PolyColor.Animated

A gradient color.

Constructors

Gradient

@JvmOverloads

constructor(color1: Color, color2: Color, type: PolyColor.Gradient.Type = Type.TopLeftToBottomRight)

Types

Type

sealed interface Type

Properties

@get:JvmName(name = "alpha")

val a: Int

alpha value of this color, from 0 to 255

alpha

var alpha: Float

The alpha of this color. Clamped between 0f..1f.

argb

@Transient

@get:JvmName(name = "getARGB")

var argb: Int

return an integer representation of this color. Utilizes bit-shifts to store the color as one 32-bit integer, like so:

argb1

@get:JvmName(name = "getARGB1")

val argb1: Int

argb2

@get:JvmName(name = "getARGB2")

val argb2: Int

@get:JvmName(name = "blue")

val b: Int

blue value of this color, from 0 to 255

brightness

var brightness: Float

The brightness of this color. Clamped between 0f..1f.

color1

var color1: PolyColor.Animated

WARNING: the following code will NOT behave as expected:

color2

var color2: PolyColor.Animated

dirty

@Transient

var dirty: Boolean

Set this to true to update the argb value.

@get:JvmName(name = "green")

val g: Int

green value of this color, from 0 to 255

hue

var hue: Float

The hue of this color. Can be any value, but is mod 360, so values are always between 0 and 360.

@get:JvmName(name = "red")

val r: Int

red value of this color, from 0 to 255

saturation

var saturation: Float

The saturation of this color. Clamped between 0f..1f.

transparent

open override val transparent: Boolean

type

val type: PolyColor.Gradient.Type

updating

open override val updating: Boolean

return if the color is still updating (i.e. it has an animation to finish)

Functions

clone

open override fun clone(): PolyColor.Gradient

equals

open operator override fun equals(other: Any?): Boolean

get

operator fun get(index: Int): Color

hashCode

open override fun hashCode(): Int

makeChroma

@ApiStatus.Experimental

fun <S : Drawable> PolyColor.makeChroma(speedNanos: Ref.LongRef = 5.seconds.toChromaSpeed()): DrawableOp

Make the given color chroma, meaning it will change its hue over time.

recolor

open override fun ~~recolor~~(target: Color, animation: Animation?)

Deprecated, see Component.recolor for how to animate gradients.

fun recolor(whichColor: Int, target: Color, animation: Animation? = null)

Animated.recolor this gradient color.

set

operator fun set(index: Int, color: Color)

take

fun take(color: Color): Color

toAnimatable

open override fun ~~toAnimatable~~(): PolyColor.Animated

toJavaColor

fun PolyColor.toJavaColor(): Color

Return a static java Color object of this color at the instant this method is called.

toString

open override fun toString(): String

update

open override fun update(deltaTimeNanos: Long): Boolean

update the color animation, if present. After, the animation is cleared, and the color becomes static again.