fromImageProvider static method

Future<ColorScheme> fromImageProvider({
  1. required ImageProvider<Object> provider,
  2. Brightness brightness = Brightness.light,
  3. DynamicSchemeVariant dynamicSchemeVariant = DynamicSchemeVariant.tonalSpot,
  4. double contrastLevel = 0.0,
  5. Color? primary,
  6. Color? onPrimary,
  7. Color? primaryContainer,
  8. Color? onPrimaryContainer,
  9. Color? primaryFixed,
  10. Color? primaryFixedDim,
  11. Color? onPrimaryFixed,
  12. Color? onPrimaryFixedVariant,
  13. Color? secondary,
  14. Color? onSecondary,
  15. Color? secondaryContainer,
  16. Color? onSecondaryContainer,
  17. Color? secondaryFixed,
  18. Color? secondaryFixedDim,
  19. Color? onSecondaryFixed,
  20. Color? onSecondaryFixedVariant,
  21. Color? tertiary,
  22. Color? onTertiary,
  23. Color? tertiaryContainer,
  24. Color? onTertiaryContainer,
  25. Color? tertiaryFixed,
  26. Color? tertiaryFixedDim,
  27. Color? onTertiaryFixed,
  28. Color? onTertiaryFixedVariant,
  29. Color? error,
  30. Color? onError,
  31. Color? errorContainer,
  32. Color? onErrorContainer,
  33. Color? outline,
  34. Color? outlineVariant,
  35. Color? surface,
  36. Color? onSurface,
  37. Color? surfaceDim,
  38. Color? surfaceBright,
  39. Color? surfaceContainerLowest,
  40. Color? surfaceContainerLow,
  41. Color? surfaceContainer,
  42. Color? surfaceContainerHigh,
  43. Color? surfaceContainerHighest,
  44. Color? onSurfaceVariant,
  45. Color? inverseSurface,
  46. Color? onInverseSurface,
  47. Color? inversePrimary,
  48. Color? shadow,
  49. Color? scrim,
  50. Color? surfaceTint,
  51. @Deprecated('Use surface instead. ' 'This feature was deprecated after v3.18.0-0.1.pre.') Color? background,
  52. @Deprecated('Use onSurface instead. ' 'This feature was deprecated after v3.18.0-0.1.pre.') Color? onBackground,
  53. @Deprecated('Use surfaceContainerHighest instead. ' 'This feature was deprecated after v3.18.0-0.1.pre.') Color? surfaceVariant,
})

Generate a ColorScheme derived from the given imageProvider.

Material Color Utilities extracts the dominant color from the supplied ImageProvider. Using this color, a ColorScheme is generated with harmonious colors that meet contrast requirements for accessibility.

If any of the optional color parameters are non-null, they will be used in place of the generated colors for that field in the resulting ColorScheme. This allows apps to override specific colors for their needs.

Given the nature of the algorithm, the most dominant color of the imageProvider may not wind up as one of the ColorScheme colors.

The provided image will be scaled down to a maximum size of 112x112 pixels during color extraction.

This sample shows how to use ColorScheme.fromImageProvider to create content-based dynamic color schemes.
link

To create a local project with this code sample, run:
flutter create --sample=material.ColorScheme.fromImageProvider.1 mysample

See also:

Implementation

static Future<ColorScheme> fromImageProvider({
  required ImageProvider provider,
  Brightness brightness = Brightness.light,
  DynamicSchemeVariant dynamicSchemeVariant = DynamicSchemeVariant.tonalSpot,
  double contrastLevel = 0.0,
  Color? primary,
  Color? onPrimary,
  Color? primaryContainer,
  Color? onPrimaryContainer,
  Color? primaryFixed,
  Color? primaryFixedDim,
  Color? onPrimaryFixed,
  Color? onPrimaryFixedVariant,
  Color? secondary,
  Color? onSecondary,
  Color? secondaryContainer,
  Color? onSecondaryContainer,
  Color? secondaryFixed,
  Color? secondaryFixedDim,
  Color? onSecondaryFixed,
  Color? onSecondaryFixedVariant,
  Color? tertiary,
  Color? onTertiary,
  Color? tertiaryContainer,
  Color? onTertiaryContainer,
  Color? tertiaryFixed,
  Color? tertiaryFixedDim,
  Color? onTertiaryFixed,
  Color? onTertiaryFixedVariant,
  Color? error,
  Color? onError,
  Color? errorContainer,
  Color? onErrorContainer,
  Color? outline,
  Color? outlineVariant,
  Color? surface,
  Color? onSurface,
  Color? surfaceDim,
  Color? surfaceBright,
  Color? surfaceContainerLowest,
  Color? surfaceContainerLow,
  Color? surfaceContainer,
  Color? surfaceContainerHigh,
  Color? surfaceContainerHighest,
  Color? onSurfaceVariant,
  Color? inverseSurface,
  Color? onInverseSurface,
  Color? inversePrimary,
  Color? shadow,
  Color? scrim,
  Color? surfaceTint,
  @Deprecated(
    'Use surface instead. '
    'This feature was deprecated after v3.18.0-0.1.pre.',
  )
  Color? background,
  @Deprecated(
    'Use onSurface instead. '
    'This feature was deprecated after v3.18.0-0.1.pre.',
  )
  Color? onBackground,
  @Deprecated(
    'Use surfaceContainerHighest instead. '
    'This feature was deprecated after v3.18.0-0.1.pre.',
  )
  Color? surfaceVariant,
}) async {
  // Extract dominant colors from image.
  final QuantizerResult quantizerResult = await _extractColorsFromImageProvider(provider);
  final Map<int, int> colorToCount = quantizerResult.colorToCount.map(
    (int key, int value) => MapEntry<int, int>(_getArgbFromAbgr(key), value),
  );

  // Score colors for color scheme suitability.
  final List<int> scoredResults = Score.score(colorToCount, desired: 1);
  final ui.Color baseColor = Color(scoredResults.first);

  final DynamicScheme scheme = _buildDynamicScheme(
    brightness,
    baseColor,
    dynamicSchemeVariant,
    contrastLevel,
  );

  return ColorScheme(
    primary: primary ?? Color(MaterialDynamicColors.primary.getArgb(scheme)),
    onPrimary: onPrimary ?? Color(MaterialDynamicColors.onPrimary.getArgb(scheme)),
    primaryContainer:
        primaryContainer ?? Color(MaterialDynamicColors.primaryContainer.getArgb(scheme)),
    onPrimaryContainer:
        onPrimaryContainer ?? Color(MaterialDynamicColors.onPrimaryContainer.getArgb(scheme)),
    primaryFixed: primaryFixed ?? Color(MaterialDynamicColors.primaryFixed.getArgb(scheme)),
    primaryFixedDim:
        primaryFixedDim ?? Color(MaterialDynamicColors.primaryFixedDim.getArgb(scheme)),
    onPrimaryFixed: onPrimaryFixed ?? Color(MaterialDynamicColors.onPrimaryFixed.getArgb(scheme)),
    onPrimaryFixedVariant:
        onPrimaryFixedVariant ??
        Color(MaterialDynamicColors.onPrimaryFixedVariant.getArgb(scheme)),
    secondary: secondary ?? Color(MaterialDynamicColors.secondary.getArgb(scheme)),
    onSecondary: onSecondary ?? Color(MaterialDynamicColors.onSecondary.getArgb(scheme)),
    secondaryContainer:
        secondaryContainer ?? Color(MaterialDynamicColors.secondaryContainer.getArgb(scheme)),
    onSecondaryContainer:
        onSecondaryContainer ?? Color(MaterialDynamicColors.onSecondaryContainer.getArgb(scheme)),
    secondaryFixed: secondaryFixed ?? Color(MaterialDynamicColors.secondaryFixed.getArgb(scheme)),
    secondaryFixedDim:
        secondaryFixedDim ?? Color(MaterialDynamicColors.secondaryFixedDim.getArgb(scheme)),
    onSecondaryFixed:
        onSecondaryFixed ?? Color(MaterialDynamicColors.onSecondaryFixed.getArgb(scheme)),
    onSecondaryFixedVariant:
        onSecondaryFixedVariant ??
        Color(MaterialDynamicColors.onSecondaryFixedVariant.getArgb(scheme)),
    tertiary: tertiary ?? Color(MaterialDynamicColors.tertiary.getArgb(scheme)),
    onTertiary: onTertiary ?? Color(MaterialDynamicColors.onTertiary.getArgb(scheme)),
    tertiaryContainer:
        tertiaryContainer ?? Color(MaterialDynamicColors.tertiaryContainer.getArgb(scheme)),
    onTertiaryContainer:
        onTertiaryContainer ?? Color(MaterialDynamicColors.onTertiaryContainer.getArgb(scheme)),
    tertiaryFixed: tertiaryFixed ?? Color(MaterialDynamicColors.tertiaryFixed.getArgb(scheme)),
    tertiaryFixedDim:
        tertiaryFixedDim ?? Color(MaterialDynamicColors.tertiaryFixedDim.getArgb(scheme)),
    onTertiaryFixed:
        onTertiaryFixed ?? Color(MaterialDynamicColors.onTertiaryFixed.getArgb(scheme)),
    onTertiaryFixedVariant:
        onTertiaryFixedVariant ??
        Color(MaterialDynamicColors.onTertiaryFixedVariant.getArgb(scheme)),
    error: error ?? Color(MaterialDynamicColors.error.getArgb(scheme)),
    onError: onError ?? Color(MaterialDynamicColors.onError.getArgb(scheme)),
    errorContainer: errorContainer ?? Color(MaterialDynamicColors.errorContainer.getArgb(scheme)),
    onErrorContainer:
        onErrorContainer ?? Color(MaterialDynamicColors.onErrorContainer.getArgb(scheme)),
    outline: outline ?? Color(MaterialDynamicColors.outline.getArgb(scheme)),
    outlineVariant: outlineVariant ?? Color(MaterialDynamicColors.outlineVariant.getArgb(scheme)),
    surface: surface ?? Color(MaterialDynamicColors.surface.getArgb(scheme)),
    surfaceDim: surfaceDim ?? Color(MaterialDynamicColors.surfaceDim.getArgb(scheme)),
    surfaceBright: surfaceBright ?? Color(MaterialDynamicColors.surfaceBright.getArgb(scheme)),
    surfaceContainerLowest:
        surfaceContainerLowest ??
        Color(MaterialDynamicColors.surfaceContainerLowest.getArgb(scheme)),
    surfaceContainerLow:
        surfaceContainerLow ?? Color(MaterialDynamicColors.surfaceContainerLow.getArgb(scheme)),
    surfaceContainer:
        surfaceContainer ?? Color(MaterialDynamicColors.surfaceContainer.getArgb(scheme)),
    surfaceContainerHigh:
        surfaceContainerHigh ?? Color(MaterialDynamicColors.surfaceContainerHigh.getArgb(scheme)),
    surfaceContainerHighest:
        surfaceContainerHighest ??
        Color(MaterialDynamicColors.surfaceContainerHighest.getArgb(scheme)),
    onSurface: onSurface ?? Color(MaterialDynamicColors.onSurface.getArgb(scheme)),
    onSurfaceVariant:
        onSurfaceVariant ?? Color(MaterialDynamicColors.onSurfaceVariant.getArgb(scheme)),
    inverseSurface: inverseSurface ?? Color(MaterialDynamicColors.inverseSurface.getArgb(scheme)),
    onInverseSurface:
        onInverseSurface ?? Color(MaterialDynamicColors.inverseOnSurface.getArgb(scheme)),
    inversePrimary: inversePrimary ?? Color(MaterialDynamicColors.inversePrimary.getArgb(scheme)),
    shadow: shadow ?? Color(MaterialDynamicColors.shadow.getArgb(scheme)),
    scrim: scrim ?? Color(MaterialDynamicColors.scrim.getArgb(scheme)),
    surfaceTint: surfaceTint ?? Color(MaterialDynamicColors.primary.getArgb(scheme)),
    brightness: brightness,
    // DEPRECATED (newest deprecations at the bottom)
    background: background ?? Color(MaterialDynamicColors.background.getArgb(scheme)),
    onBackground: onBackground ?? Color(MaterialDynamicColors.onBackground.getArgb(scheme)),
    surfaceVariant: surfaceVariant ?? Color(MaterialDynamicColors.surfaceVariant.getArgb(scheme)),
  );
}