polyui/org.polyfrost.polyui.color

Package-level declarations

Types

interface Colors

Colors is the color storage for PolyUI. All PolyUI drawables use these colors. or even changed on the fly using the field in the PolyUI instance, bringing theming to PolyUI.

DarkTheme

open class DarkTheme : Colors

The default color set used in PolyUI.

LightTheme

open class LightTheme : Colors

The default light color set used in PolyUI.

PolyColor

abstract class PolyColor

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

Properties

val Int.alpha: Int

val Int.blue: Int

val Int.green: Int

val Int.red: Int

Functions

animatable

fun PolyColor.animatable(): PolyColor.Animated

animatableGradient

fun PolyColor.Gradient.animatableGradient(): PolyColor.Gradient.Animated

argb

fun argb(argb: Int): PolyColor

hex

fun hex(hex: String): PolyColor

hsba

fun hsba(h: Float, s: Float, b: Float, a: Float = 1.0f): PolyColor.Static

HSBtoRGB

fun HSBtoRGB(hue: Float, saturation: Float, brightness: Float, alpha: Float = 1.0f): Int

Converts the components of a color, as specified by the HSB model, to an equivalent set of values for the default RGB model.

mutable

fun PolyColor.mutable(): PolyColor.Mutable

rgba

@JvmOverloads

fun rgba(r: Int, g: Int, b: Int, a: Float = 1.0f): PolyColor

create a color from the given red, green, and blue integer values, and an alpha value 0f..1f

RGBtoHSB

fun RGBtoHSB(r: Int, g: Int, b: Int, out: FloatArray? = null): FloatArray

Converts the components of a color, as specified by the default RGB model, to an equivalent set of values for hue, saturation, and brightness that are the three components of the HSB model.

toColor

fun Int.toColor(): PolyColor

Takes an ARGB integer color and returns a PolyColor object.

fun String.toColor(): PolyColor

Turn the given hex string into a color.

fun String.toColor(alpha: Float = 1.0f): PolyColor

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.

toPolyColor

fun Color.toPolyColor(): PolyColor

Return a PolyUI compatible color object representative of this Java color object.