material-color-utilities/com.materialkolor.scheme/DynamicScheme

DynamicScheme

open class DynamicScheme(val sourceColorHct: Hct, val variant: Variant, val isDark: Boolean, val contrastLevel: Double, val primaryPalette: TonalPalette, val secondaryPalette: TonalPalette, val tertiaryPalette: TonalPalette, val neutralPalette: TonalPalette, val neutralVariantPalette: TonalPalette, val platform: DynamicScheme.Platform = Platform.PHONE, val specVersion: ColorSpec.SpecVersion = ColorSpec.SpecVersion.SPEC_2021, val errorPalette: TonalPalette = TonalPalette.fromHueAndChroma( hue = 25.0, chroma = 84.0, ))

Provides important settings for creating colors dynamically, and 6 color palettes. Requires: 1. A color. (source color) 2. A theme. (Variant) 3. Whether or not its dark mode. 4. Contrast level. (-1 to 1, currently contrast ratio 3.0 and 7.0)

Inheritors

SchemeExpressive

SchemeFruitSalad

SchemeMonochrome

SchemeTonalSpot

Constructors

constructor(sourceColorHct: Hct, variant: Variant, isDark: Boolean, contrastLevel: Double, primaryPalette: TonalPalette, secondaryPalette: TonalPalette, tertiaryPalette: TonalPalette, neutralPalette: TonalPalette, neutralVariantPalette: TonalPalette, platform: DynamicScheme.Platform = Platform.PHONE, specVersion: ColorSpec.SpecVersion = ColorSpec.SpecVersion.SPEC_2021, errorPalette: TonalPalette = TonalPalette.fromHueAndChroma( hue = 25.0, chroma = 84.0, ))

Creates a DynamicScheme.

constructor(sourceColorHct: Hct, variant: Variant, isDark: Boolean, contrastLevel: Double, platform: DynamicScheme.Platform = Platform.PHONE, specVersion: ColorSpec.SpecVersion = ColorSpec.SpecVersion.SPEC_2021, primaryPalette: TonalPalette, secondaryPalette: TonalPalette, tertiaryPalette: TonalPalette, neutralPalette: TonalPalette, neutralVariantPalette: TonalPalette, errorPalette: TonalPalette?)

Types

object Companion

enum Platform : Enum<DynamicScheme.Platform>

The platform on which this scheme is intended to be used.

Properties

val background: Int

val contrastLevel: Double

Value from -1 to 1. -1 represents minimum contrast. 0 represents standard (i.e. the design as spec'd), and 1 represents maximum contrast.

controlActivated

val controlActivated: Int

controlHighlight

val controlHighlight: Int

val controlNormal: Int

val errorContainer: Int

val errorPalette: TonalPalette

The error color palette.

inverseOnSurface

val inverseOnSurface: Int

val inversePrimary: Int

val inverseSurface: Int

val isDark: Boolean

Whether or not the theme is in dark mode.

val neutralPalette: TonalPalette

Palette The neutral color palette.

neutralPaletteKeyColor

val neutralPaletteKeyColor: Int

neutralVariantPalette

val neutralVariantPalette: TonalPalette

The neutral variant color palette.

neutralVariantPaletteKeyColor

val neutralVariantPaletteKeyColor: Int

val onBackground: Int

val onError: Int

onErrorContainer

val onErrorContainer: Int

val onPrimary: Int

onPrimaryContainer

val onPrimaryContainer: Int

val onPrimaryFixed: Int

onPrimaryFixedVariant

val onPrimaryFixedVariant: Int

val onSecondary: Int

onSecondaryContainer

val onSecondaryContainer: Int

onSecondaryFixed

val onSecondaryFixed: Int

onSecondaryFixedVariant

val onSecondaryFixedVariant: Int

val onSurface: Int

onSurfaceVariant

val onSurfaceVariant: Int

val onTertiary: Int

onTertiaryContainer

val onTertiaryContainer: Int

onTertiaryFixed

val onTertiaryFixed: Int

onTertiaryFixedVariant

val onTertiaryFixedVariant: Int

val outline: Int

val outlineVariant: Int

val platform: DynamicScheme.Platform

The platform on which this scheme is intended to be used.

val primary: Int

primaryContainer

val primaryContainer: Int

val primaryFixed: Int

primaryFixedDim

val primaryFixedDim: Int

val primaryPalette: TonalPalette

The primary color palette.

primaryPaletteKeyColor

val primaryPaletteKeyColor: Int

val secondary: Int

secondaryContainer

val secondaryContainer: Int

val secondaryFixed: Int

secondaryFixedDim

val secondaryFixedDim: Int

secondaryPalette

val secondaryPalette: TonalPalette

The secondary color palette.

secondaryPaletteKeyColor

val secondaryPaletteKeyColor: Int

val shadow: Int

sourceColorArgb

val sourceColorArgb: Int

val sourceColorHct: Hct

The source color HCT.

val specVersion: ColorSpec.SpecVersion

The version of the color specification.

val surface: Int

val surfaceBright: Int

surfaceContainer

val surfaceContainer: Int

surfaceContainerHigh

val surfaceContainerHigh: Int

surfaceContainerHighest

val surfaceContainerHighest: Int

surfaceContainerLow

val surfaceContainerLow: Int

surfaceContainerLowest

val surfaceContainerLowest: Int

val surfaceDim: Int

val surfaceTint: Int

val surfaceVariant: Int

val tertiary: Int

tertiaryContainer

val tertiaryContainer: Int

val tertiaryFixed: Int

tertiaryFixedDim

val tertiaryFixedDim: Int

tertiaryPalette

val tertiaryPalette: TonalPalette

The tertiary color palette.

tertiaryPaletteKeyColor

val tertiaryPaletteKeyColor: Int

textHintInverse

val textHintInverse: Int

textPrimaryInverse

val textPrimaryInverse: Int

textPrimaryInverseDisableOnly

val textPrimaryInverseDisableOnly: Int

textSecondaryAndTertiaryInverse

val textSecondaryAndTertiaryInverse: Int

textSecondaryAndTertiaryInverseDisabled

val textSecondaryAndTertiaryInverseDisabled: Int

val variant: Variant

The theme.

Functions

fun getArgb(dynamicColor: DynamicColor): Int

fun getHct(dynamicColor: DynamicColor): Hct