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

Gradient

open class Gradient(color1: PolyColor, val color2: PolyColor, val type: PolyColor.Gradient.Type) : PolyColor

Inheritors

Mutable

Constructors

Gradient

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

Types

Animatable

open class Animatable(color1: PolyColor.Animatable, color2: PolyColor.Animatable, val type: PolyColor.Gradient.Type) : PolyColor.Gradient.Mutable

Mutable

open class Mutable(color1: PolyColor.Mutable, color2: PolyColor.Mutable, val type: PolyColor.Gradient.Type) : PolyColor.Gradient

Type

sealed interface Type

Properties

@get:JvmName(name = "alpha")

open override val a: Int

alpha value of this color, from 0 to 255

@get:JvmName(name = "alpha2")

val a2: Int

alpha

open override val alpha: Float

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

argb

open override val argb: Int

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

argb2

val argb2: Int

@get:JvmName(name = "blue")

open override val b: Int

blue value of this color, from 0 to 255

@get:JvmName(name = "blue2")

val b2: Int

brightness

open override val brightness: Float

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

color2

open val color2: PolyColor

@get:JvmName(name = "green")

open override val g: Int

green value of this color, from 0 to 255

@get:JvmName(name = "green2")

val g2: Int

hue

open override val 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")

open override val r: Int

red value of this color, from 0 to 255

@get:JvmName(name = "red2")

val r2: Int

saturation

open override val saturation: Float

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

transparent

open override val transparent: Boolean

type

val type: PolyColor.Gradient.Type

Functions

equals

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

get

operator fun get(index: Int): PolyColor

hashCode

open override fun hashCode(): Int

toAnimatable

fun PolyColor.toAnimatable(): PolyColor.Animatable

toAnimatableGradient

fun PolyColor.Gradient.toAnimatableGradient(): PolyColor.Gradient.Animatable

toHex

fun PolyColor.toHex(alpha: Boolean = true, hash: Boolean = true): String

toJavaColor

fun PolyColor.toJavaColor(): Color

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

toMutable

fun PolyColor.toMutable(): PolyColor.Mutable

toString

open override fun toString(): String