1 /*
2  * Copyright (C) 2017 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License
15  */
16 
17 package com.android.internal.colorextraction.types;
18 
19 import android.app.WallpaperColors;
20 
21 import com.android.internal.colorextraction.ColorExtractor;
22 
23 /**
24  * Interface to allow various color extraction implementations.
25  */
26 public interface ExtractionType {
27 
28     /**
29      * Executes color extraction by reading WallpaperColors and setting
30      * main and secondary colors on GradientColors.
31      *
32      * Extraction is expected to happen with 3 different gradient types:
33      *     Normal, with the main extracted colors
34      *     Dark, with extra contrast
35      *     ExtraDark, for places where GAR is mandatory, like the emergency dialer
36      *
37      * @param inWallpaperColors where to read from
38      * @param outGradientColorsNormal object that should receive normal colors
39      * @param outGradientColorsDark object that should receive dark colors
40      * @param outGradientColorsExtraDark object that should receive extra dark colors
41      */
extractInto(WallpaperColors inWallpaperColors, ColorExtractor.GradientColors outGradientColorsNormal, ColorExtractor.GradientColors outGradientColorsDark, ColorExtractor.GradientColors outGradientColorsExtraDark)42     void extractInto(WallpaperColors inWallpaperColors,
43             ColorExtractor.GradientColors outGradientColorsNormal,
44             ColorExtractor.GradientColors outGradientColorsDark,
45             ColorExtractor.GradientColors outGradientColorsExtraDark);
46 }
47