animatedledstrip-core/animatedledstrip.leds.colormanagement/PixelColor

PixelColor

data class PixelColor(val pixelNumber: Int)

Tracks a single pixel's colors. Each pixel has 4 colors, actualColor, fadeColor, prolongedColor and temporaryColor. A pixel's color will be set to temporaryColor if temporaryColor is not -1, otherwise to fadeColor if fadeColor is not -1, otherwise to prolongedColor.

Constructors

constructor(pixelNumber: Int)

Properties

var actualColor: Int

The color seen on the strip

var fadeColor: Int

A color that is being faded to the prolonged color

val pixelNumber: Int

The index of the pixel this

var prolongedColor: Int

The color that should be shown if the temporary and fade colors are not set, and the color that will be faded to

var temporaryColor: Int

A color to show regardless of what the other colors are, essentially overriding everything

Functions

fun getColor(colorType: PixelColorType): Int

Get the pixel's color

fun revertColor()

Resets temporaryColor to -1, effectively reverting the pixel to whatever state it would be in without the temporaryColor override

sendColorToStrip

fun sendColorToStrip(ledStrip: NativeLEDStrip, doFade: Boolean)

Sends the color for a pixel to the strip. A pixel's color will be set to temporaryColor if temporaryColor is not -1, otherwise to fadeColor if fadeColor is not -1, otherwise to prolongedColor.

fun setColor(color: Int, colorType: PixelColorType)

Set the pixel's color