animatedledstrip-core/animatedledstrip.leds.colormanagement

Package-level declarations

Types

CurrentStripColor

data class CurrentStripColor(val color: List<Int>) : SendableData

Packages the current strip state into a format that can be sent to a client

LEDStripColorLogger

expect class LEDStripColorLogger(stripColorManager: LEDStripColorManager)

Logs the strip state from each render to a file

actual class LEDStripColorLogger(val stripColorManager: LEDStripColorManager)

Logs the strip state from each render to a file

LEDStripColorManager

class LEDStripColorManager(val stripManager: LEDStrip)

Tracks the color of pixels in the strip so they can be used, rendered and/or logged

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.

PixelColorType

enum PixelColorType : Enum<PixelColorType>

Specifies which type of color to get/set

Properties

pixelActualColorList

val LEDStripColorManager.pixelActualColorList: List<Int>

val LEDStrip.pixelActualColorList: List<Int>

A list of the actual colors for the strip

val SectionManager.pixelActualColorList: List<Int>

A list of the actual colors for the section

pixelFadeColorList

val LEDStripColorManager.pixelFadeColorList: List<Int>

val LEDStrip.pixelFadeColorList: List<Int>

A list of the fade colors for the strip

val SectionManager.pixelFadeColorList: List<Int>

A list of the fade colors for the section

pixelProlongedColorList

val LEDStripColorManager.pixelProlongedColorList: List<Int>

val LEDStrip.pixelProlongedColorList: List<Int>

A list of the prolonged colors for the strip

val SectionManager.pixelProlongedColorList: List<Int>

A list of the prolonged colors for the section

pixelTemporaryColorList

val LEDStripColorManager.pixelTemporaryColorList: List<Int>

val LEDStrip.pixelTemporaryColorList: List<Int>

A list of the temporary colors for the strip

val SectionManager.pixelTemporaryColorList: List<Int>

A list of the temporary colors for the section

Functions

clear

fun AnimationManager.clear()

Clear the strip/section (set all pixels to 0)

fun SectionManager.clear()

Clear the section (set all pixels to 0)

fun LEDStrip.clear()

Clear the strip (set all pixels to 0)

currentStripColor

fun LEDStrip.currentStripColor(): CurrentStripColor

getPixelActualColor

fun AnimationManager.getPixelActualColor(pixel: Int): Int

fun SectionManager.getPixelActualColor(pixel: Int): Int

fun LEDStrip.getPixelActualColor(pixel: Int): Int

getPixelActualColorOrNull

fun AnimationManager.getPixelActualColorOrNull(pixel: Int): Int?

fun SectionManager.getPixelActualColorOrNull(pixel: Int): Int?

fun LEDStrip.getPixelActualColorOrNull(pixel: Int): Int?

getPixelFadeColor

fun AnimationManager.getPixelFadeColor(pixel: Int): Int

fun SectionManager.getPixelFadeColor(pixel: Int): Int

fun LEDStrip.getPixelFadeColor(pixel: Int): Int

getPixelFadeColorOrNull

fun AnimationManager.getPixelFadeColorOrNull(pixel: Int): Int?

fun SectionManager.getPixelFadeColorOrNull(pixel: Int): Int?

fun LEDStrip.getPixelFadeColorOrNull(pixel: Int): Int?

getPixelProlongedColor

fun AnimationManager.getPixelProlongedColor(pixel: Int): Int

fun SectionManager.getPixelProlongedColor(pixel: Int): Int

fun LEDStrip.getPixelProlongedColor(pixel: Int): Int

getPixelProlongedColorOrNull

fun AnimationManager.getPixelProlongedColorOrNull(pixel: Int): Int?

fun SectionManager.getPixelProlongedColorOrNull(pixel: Int): Int?

fun LEDStrip.getPixelProlongedColorOrNull(pixel: Int): Int?

getPixelTemporaryColor

fun AnimationManager.getPixelTemporaryColor(pixel: Int): Int

fun SectionManager.getPixelTemporaryColor(pixel: Int): Int

fun LEDStrip.getPixelTemporaryColor(pixel: Int): Int

getPixelTemporaryColorOrNull

fun AnimationManager.getPixelTemporaryColorOrNull(pixel: Int): Int?

fun SectionManager.getPixelTemporaryColorOrNull(pixel: Int): Int?

fun LEDStrip.getPixelTemporaryColorOrNull(pixel: Int): Int?

randomColor

fun RunningAnimationParams.randomColor(): PreparedColorContainer

revertPixel

fun AnimationManager.revertPixel(pixel: Int)

fun SectionManager.revertPixel(pixel: Int)

fun LEDStrip.revertPixel(pixel: Int)

Revert a pixel's color (reset its temporary color)

revertPixels

fun AnimationManager.revertPixels(pixels: List<Int>)

fun AnimationManager.revertPixels(pixels: IntRange)

fun SectionManager.revertPixels(pixels: List<Int>)

fun SectionManager.revertPixels(pixels: IntRange)

fun LEDStrip.revertPixels(pixels: List<Int>)

fun LEDStrip.revertPixels(pixels: IntRange)

Revert multiple pixels' color (reset their temporary colors)

setPixelAndRevertAfterDelay

suspend fun AnimationManager.setPixelAndRevertAfterDelay(pixel: Int, color: PreparedColorContainer, delay: Long)

Set a pixel's temporary color and revert (reset its temporary color) after a delay

setPixelFadeColor

fun AnimationManager.setPixelFadeColor(pixel: Int, color: PreparedColorContainer)

fun AnimationManager.setPixelFadeColor(pixel: Int, color: Int)

fun SectionManager.setPixelFadeColor(pixel: Int, color: PreparedColorContainer)

fun SectionManager.setPixelFadeColor(pixel: Int, color: Int)

fun LEDStrip.setPixelFadeColor(pixel: Int, color: PreparedColorContainer)

fun LEDStrip.setPixelFadeColor(pixel: Int, color: Int)

Set a pixel's fade color

setPixelFadeColors

fun AnimationManager.setPixelFadeColors(pixels: List<Int>, color: PreparedColorContainer)

fun AnimationManager.setPixelFadeColors(pixels: List<Int>, color: Int)

fun AnimationManager.setPixelFadeColors(pixels: IntRange, color: PreparedColorContainer)

fun AnimationManager.setPixelFadeColors(pixels: IntRange, color: Int)

fun SectionManager.setPixelFadeColors(pixels: List<Int>, color: PreparedColorContainer)

fun SectionManager.setPixelFadeColors(pixels: List<Int>, color: Int)

fun SectionManager.setPixelFadeColors(pixels: IntRange, color: PreparedColorContainer)

fun SectionManager.setPixelFadeColors(pixels: IntRange, color: Int)

fun LEDStrip.setPixelFadeColors(pixels: List<Int>, color: Int)

fun LEDStrip.setPixelFadeColors(pixels: IntRange, color: PreparedColorContainer)

fun LEDStrip.setPixelFadeColors(pixels: IntRange, color: Int)

Set multiple pixels' fade color

fun LEDStrip.setPixelFadeColors(pixels: List<Int>, color: PreparedColorContainer)

Set multiple pixel's fade color

setPixelProlongedColor

fun AnimationManager.setPixelProlongedColor(pixel: Int, color: PreparedColorContainer)

fun AnimationManager.setPixelProlongedColor(pixel: Int, color: Int)

fun SectionManager.setPixelProlongedColor(pixel: Int, color: PreparedColorContainer)

fun SectionManager.setPixelProlongedColor(pixel: Int, color: Int)

fun LEDStrip.setPixelProlongedColor(pixel: Int, color: PreparedColorContainer)

fun LEDStrip.setPixelProlongedColor(pixel: Int, color: Int)

Set a pixel's prolonged color

setPixelProlongedColors

fun AnimationManager.setPixelProlongedColors(pixels: List<Int>, color: PreparedColorContainer)

fun AnimationManager.setPixelProlongedColors(pixels: List<Int>, color: Int)

fun AnimationManager.setPixelProlongedColors(pixels: IntRange, color: PreparedColorContainer)

fun AnimationManager.setPixelProlongedColors(pixels: IntRange, color: Int)

fun SectionManager.setPixelProlongedColors(pixels: List<Int>, color: PreparedColorContainer)

fun SectionManager.setPixelProlongedColors(pixels: List<Int>, color: Int)

fun SectionManager.setPixelProlongedColors(pixels: IntRange, color: PreparedColorContainer)

fun SectionManager.setPixelProlongedColors(pixels: IntRange, color: Int)

fun LEDStrip.setPixelProlongedColors(pixels: List<Int>, color: PreparedColorContainer)

fun LEDStrip.setPixelProlongedColors(pixels: List<Int>, color: Int)

fun LEDStrip.setPixelProlongedColors(pixels: IntRange, color: PreparedColorContainer)

fun LEDStrip.setPixelProlongedColors(pixels: IntRange, color: Int)

Set multiple pixels' prolonged color

setPixelTemporaryColor

fun AnimationManager.setPixelTemporaryColor(pixel: Int, color: PreparedColorContainer)

fun AnimationManager.setPixelTemporaryColor(pixel: Int, color: Int)

fun SectionManager.setPixelTemporaryColor(pixel: Int, color: PreparedColorContainer)

fun SectionManager.setPixelTemporaryColor(pixel: Int, color: Int)

fun LEDStrip.setPixelTemporaryColor(pixel: Int, color: PreparedColorContainer)

fun LEDStrip.setPixelTemporaryColor(pixel: Int, color: Int)

Set a pixel's temporary color

setPixelTemporaryColors

fun AnimationManager.setPixelTemporaryColors(pixels: List<Int>, color: PreparedColorContainer)

fun AnimationManager.setPixelTemporaryColors(pixels: List<Int>, color: Int)

fun AnimationManager.setPixelTemporaryColors(pixels: IntRange, color: PreparedColorContainer)

fun AnimationManager.setPixelTemporaryColors(pixels: IntRange, color: Int)

fun SectionManager.setPixelTemporaryColors(pixels: List<Int>, color: PreparedColorContainer)

fun SectionManager.setPixelTemporaryColors(pixels: List<Int>, color: Int)

fun SectionManager.setPixelTemporaryColors(pixels: IntRange, color: PreparedColorContainer)

fun SectionManager.setPixelTemporaryColors(pixels: IntRange, color: Int)

fun LEDStrip.setPixelTemporaryColors(pixels: List<Int>, color: PreparedColorContainer)

fun LEDStrip.setPixelTemporaryColors(pixels: List<Int>, color: Int)

fun LEDStrip.setPixelTemporaryColors(pixels: IntRange, color: PreparedColorContainer)

fun LEDStrip.setPixelTemporaryColors(pixels: IntRange, color: Int)

Set multiple pixels' temporary color

setStripFadeColor

fun AnimationManager.setStripFadeColor(color: PreparedColorContainer)

fun AnimationManager.setStripFadeColor(color: Int)

Set the strip's/section's fade color

fun SectionManager.setStripFadeColor(color: PreparedColorContainer)

fun SectionManager.setStripFadeColor(color: Int)

Set the section's fade color

fun LEDStrip.setStripFadeColor(color: PreparedColorContainer)

fun LEDStrip.setStripFadeColor(color: Int)

Set the strip's fade color

setStripProlongedColor

fun AnimationManager.setStripProlongedColor(color: PreparedColorContainer)

fun AnimationManager.setStripProlongedColor(color: Int)

Set the strip's/section's prolonged color

fun SectionManager.setStripProlongedColor(color: PreparedColorContainer)

fun SectionManager.setStripProlongedColor(color: Int)

Set the section's prolonged color

fun LEDStrip.setStripProlongedColor(color: PreparedColorContainer)

fun LEDStrip.setStripProlongedColor(color: Int)

Set the strip's prolonged color

setStripTemporaryColor

fun AnimationManager.setStripTemporaryColor(color: PreparedColorContainer)

fun AnimationManager.setStripTemporaryColor(color: Int)

Set the strip's/section's temporary color

fun SectionManager.setStripTemporaryColor(color: PreparedColorContainer)

fun SectionManager.setStripTemporaryColor(color: Int)

Set the section's temporary color

fun LEDStrip.setStripTemporaryColor(color: PreparedColorContainer)

fun LEDStrip.setStripTemporaryColor(color: Int)

Set the strip's temporary color