material-color-utilities/com.materialkolor.dynamiccolor/TonePolarity

TonePolarity

Describes the relationship in lightness between two colors.

'nearer' and 'farther' describes closeness to the surface roles. For instance, ToneDeltaPair(A, B, 10, 'nearer', stayTogether) states that A should be 10 lighter than B in light mode, and 10 darker than B in dark mode.

See ToneDeltaPair for details.

Entries

Properties

entries

val entries: EnumEntries<TonePolarity>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

val name: String

ordinal

val ordinal: Int

Functions

valueOf

fun valueOf(value: String): TonePolarity

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<TonePolarity>

Returns an array containing the constants of this enum type, in the order they're declared.