polyui/org.polyfrost.polyui.color/PolyColor

PolyColor

abstract class PolyColor

Color

(revised 1.3) The color used by PolyUI. It stores the color in the HSBA format, and can be converted to ARGB.

Inheritors

Static

Mutable

Gradient

Constructors

PolyColor

constructor()

Types

Animatable

interface Animatable : PolyColor.Mut

Animated

open class Animated(hue: Float, saturation: Float, brightness: Float, alpha: Float) : PolyColor.Mutable, PolyColor.Dynamic, PolyColor.Animatable

Chroma

class Chroma(hue: Float, saturation: Float, brightness: Float, alpha: Float, var speedNanos: Long) : PolyColor.Mutable, PolyColor.Dynamic

Constants

object Constants

Dynamic

interface Dynamic

Represents a color which is has some kind of operation that updates it based on time, for example, an animation.

Gradient

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

Mut

interface Mut

Mutable

open class Mutable(hue: Float, saturation: Float, brightness: Float, alpha: Float) : PolyColor, PolyColor.Mut

Static

open class Static(hue: Float, saturation: Float, brightness: Float, alpha: Float) : PolyColor

Properties

@get:JvmName(name = "alpha")

val a: Int

alpha value of this color, from 0 to 255

alpha

abstract val alpha: Float

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

argb

abstract val argb: Int

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

@get:JvmName(name = "blue")

val b: Int

blue value of this color, from 0 to 255

brightness

abstract val brightness: Float

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

@get:JvmName(name = "green")

val g: Int

green value of this color, from 0 to 255

hue

abstract 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")

val r: Int

red value of this color, from 0 to 255

saturation

abstract val saturation: Float

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

transparent

open val transparent: Boolean

Functions

equals

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

hashCode

open override fun hashCode(): Int

toAnimatable

fun PolyColor.toAnimatable(): PolyColor.Animated

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

PolyColor

Color

See also

Inheritors

Constructors

Types

Properties

Functions