kmpalette-core/com.kmpalette/rememberGeneratePalette

rememberGeneratePalette

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

Generates and remembers a Palette from this ImageBitmap across compositions.

The palette generation is triggered in a LaunchedEffect and the result is remembered across recompositions. The result starts as PaletteResult.Loading and transitions to either PaletteResult.Success or PaletteResult.Error.

Return

A PaletteResult representing the current state of palette generation.

Parameters

coroutineContext

The CoroutineContext to use for palette generation. Defaults to Dispatchers.Default.

block

Optional lambda to configure the Palette.Builder before generation.

@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.

This composable first loads the bitmap using the provided loader, then generates a palette from it. The result is remembered across recompositions. The result starts as PaletteResult.Loading and transitions to either PaletteResult.Success or PaletteResult.Error.