Package-level declarations

Types

abstract class DominantColorState<T : Any>(defaultColor: Color, defaultOnColor: Color, cacheSize: Int = DEFAULT_CACHE_SIZE, coroutineContext: CoroutineContext = Dispatchers.Default, isSwatchValid: (Palette.Swatch) -> Boolean = { true }, builder: Palette.Builder.() -> Unit = {})

A class which stores and caches the result of any calculated dominant colors.

PaletteResult

sealed interface PaletteResult

Represents the result of a palette generation operation.

PaletteState

@Stable

abstract class PaletteState<T : Any>(cacheSize: Int = DEFAULT_CACHE_SIZE, coroutineContext: CoroutineContext = Dispatchers.Default, builder: Palette.Builder.() -> Unit = {})

A state object that generates a Palette from an ImageBitmap using loader.

SwatchTarget

sealed interface SwatchTarget

A class which allows custom selection of colors in a Palette's generation. Instances can be created via the Builder class.

Properties

color

val Palette.Swatch.color: Color

Returns a color value in the RGB color space which represents the color of this Swatch

DEFAULT_CACHE_SIZE

const val DEFAULT_CACHE_SIZE: Int = 6

The default number of results retained by the PaletteState and DominantColorState caches.

onColor

val Palette.Swatch.onColor: Color

Returns an appropriate color to use for any 'title' text which is displayed over this Swatch's color. This color is guaranteed to have sufficient contrast.

Functions

bodyTextColor

fun Palette.Swatch.bodyTextColor(): Color

Returns an appropriate color to use for any 'body' text which is displayed over this Swatch's color. This color is guaranteed to have sufficient contrast.

from

fun Palette.Companion.from(bitmap: ImageBitmap, scale: Boolean = true, block: Palette.Builder.() -> Unit = {}): Palette.Builder

Creates a Palette.Builder from an ImageBitmap.

generatePalette

suspend fun ImageBitmap.generatePalette(coroutineContext: CoroutineContext = Dispatchers.Default, block: Palette.Builder.() -> Unit = {}): Palette

Generates a Palette from this ImageBitmap.

get

operator fun Palette.get(target: SwatchTarget): Palette.Swatch?

operator fun Palette.get(target: Target): Palette.Swatch?

Returns the selected swatch for the given target from the palette, or null if one could not be found.

getSwatch

fun Palette.getSwatch(target: SwatchTarget): Palette.Swatch?

Returns the selected swatch for the given target from the palette, or null if one could not be found.

rememberDominantColorState

@Composable

fun rememberDominantColorState(defaultColor: Color, defaultOnColor: Color, cacheSize: Int = DEFAULT_CACHE_SIZE, coroutineContext: CoroutineContext = Dispatchers.Default, isSwatchValid: (Palette.Swatch) -> Boolean = { true }, builder: Palette.Builder.() -> Unit = {}): DominantColorState<ImageBitmap>

@Composable

fun <T : Any> rememberDominantColorState(loader: ImageBitmapLoader<T>, defaultColor: Color, defaultOnColor: Color, cacheSize: Int = DEFAULT_CACHE_SIZE, coroutineContext: CoroutineContext = Dispatchers.Default, isSwatchValid: (Palette.Swatch) -> Boolean = { true }, builder: Palette.Builder.() -> Unit = {}): DominantColorState<T>

Create a DominantColorState which will be remembered across compositions. Then can be used to generate a dominant color from an ImageBitmap.

rememberGeneratePalette

@Composable

fun rememberGeneratePalette(loader: suspend () -> ImageBitmap, coroutineContext: CoroutineContext = Dispatchers.Default, block: Palette.Builder.() -> Unit = {}): PaletteResult

Generates and remembers a Palette from an ImageBitmap loaded by the provided loader.

rememberGeneratePalette

@Composable

fun ImageBitmap.rememberGeneratePalette(coroutineContext: CoroutineContext = Dispatchers.Default, block: Palette.Builder.() -> Unit = {}): PaletteResult

Generates and remembers a Palette from this ImageBitmap across compositions.

rememberPaletteState

@Composable

fun rememberPaletteState(cacheSize: Int = DEFAULT_CACHE_SIZE, coroutineContext: CoroutineContext = Dispatchers.Default, builder: Palette.Builder.() -> Unit = {}): PaletteState<ImageBitmap>

Creates a PaletteState that will be remembered across compilation and can be used to generate a Palette from an ImageBitmap.

@Composable

fun <T : Any> rememberPaletteState(loader: ImageBitmapLoader<T>, cacheSize: Int = DEFAULT_CACHE_SIZE, coroutineContext: CoroutineContext = Dispatchers.Default, builder: Palette.Builder.() -> Unit = {}): PaletteState<T>

Creates a PaletteState that will be remembered across compilation and can be used to generate a Palette from an ImageBitmap using loader.

titleTextColor

fun Palette.Swatch.titleTextColor(): Color

Returns an appropriate color to use for any 'title' text which is displayed over this Swatch's color. This color is guaranteed to have sufficient contrast.