1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
|
/*
* Copyright (C) 2021 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package android.hardware.display;
import android.annotation.IntDef;
import android.os.Parcel;
import android.os.Parcelable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
/**
* Data about the current brightness state.
* {@see android.view.Display.getBrightnessInfo()}
*
* @hide
*/
public final class BrightnessInfo implements Parcelable {
@IntDef(prefix = {"HIGH_BRIGHTNESS_MODE_"}, value = {
HIGH_BRIGHTNESS_MODE_OFF,
HIGH_BRIGHTNESS_MODE_SUNLIGHT,
HIGH_BRIGHTNESS_MODE_HDR
})
@Retention(RetentionPolicy.SOURCE)
public @interface HighBrightnessMode {}
/**
* High brightness mode is OFF. The high brightness range is not currently accessible to the
* user.
*/
public static final int HIGH_BRIGHTNESS_MODE_OFF = 0;
/**
* High brightness mode is ON due to high ambient light (sunlight). The high brightness range is
* currently accessible to the user.
*/
public static final int HIGH_BRIGHTNESS_MODE_SUNLIGHT = 1;
/**
* High brightness mode is ON due to high ambient light (sunlight). The high brightness range is
* currently accessible to the user.
*/
public static final int HIGH_BRIGHTNESS_MODE_HDR = 2;
@IntDef(prefix = {"BRIGHTNESS_MAX_REASON_"}, value = {
BRIGHTNESS_MAX_REASON_NONE,
BRIGHTNESS_MAX_REASON_THERMAL
})
@Retention(RetentionPolicy.SOURCE)
public @interface BrightnessMaxReason {}
/**
* Maximum brightness is unrestricted.
*/
public static final int BRIGHTNESS_MAX_REASON_NONE = 0;
/**
* Maximum brightness is restricted due to thermal throttling.
*/
public static final int BRIGHTNESS_MAX_REASON_THERMAL = 1;
/** Brightness */
public final float brightness;
/** Brightness after {@link DisplayPowerController} adjustments */
public final float adjustedBrightness;
/** Current minimum supported brightness. */
public final float brightnessMinimum;
/** Current maximum supported brightness. */
public final float brightnessMaximum;
/** Brightness values greater than this point are only used in High Brightness Mode. */
public final float highBrightnessTransitionPoint;
/**
* Current state of high brightness mode.
* Can be any of HIGH_BRIGHTNESS_MODE_* values.
*/
public final int highBrightnessMode;
/**
* The current reason for restricting maximum brightness.
* Can be any of BRIGHTNESS_MAX_REASON_* values.
*/
public final int brightnessMaxReason;
public BrightnessInfo(float brightness, float brightnessMinimum, float brightnessMaximum,
@HighBrightnessMode int highBrightnessMode, float highBrightnessTransitionPoint,
@BrightnessMaxReason int brightnessMaxReason) {
this(brightness, brightness, brightnessMinimum, brightnessMaximum, highBrightnessMode,
highBrightnessTransitionPoint, brightnessMaxReason);
}
public BrightnessInfo(float brightness, float adjustedBrightness, float brightnessMinimum,
float brightnessMaximum, @HighBrightnessMode int highBrightnessMode,
float highBrightnessTransitionPoint, @BrightnessMaxReason int brightnessMaxReason) {
this.brightness = brightness;
this.adjustedBrightness = adjustedBrightness;
this.brightnessMinimum = brightnessMinimum;
this.brightnessMaximum = brightnessMaximum;
this.highBrightnessMode = highBrightnessMode;
this.highBrightnessTransitionPoint = highBrightnessTransitionPoint;
this.brightnessMaxReason = brightnessMaxReason;
}
/**
* @return User-friendly string for specified {@link HighBrightnessMode} parameter.
*/
public static String hbmToString(@HighBrightnessMode int highBrightnessMode) {
switch (highBrightnessMode) {
case HIGH_BRIGHTNESS_MODE_OFF:
return "off";
case HIGH_BRIGHTNESS_MODE_HDR:
return "hdr";
case HIGH_BRIGHTNESS_MODE_SUNLIGHT:
return "sunlight";
}
return "invalid";
}
/**
* @return User-friendly string for specified {@link BrightnessMaxReason} parameter.
*/
public static String briMaxReasonToString(@BrightnessMaxReason int reason) {
switch (reason) {
case BRIGHTNESS_MAX_REASON_NONE:
return "none";
case BRIGHTNESS_MAX_REASON_THERMAL:
return "thermal";
}
return "invalid";
}
@Override
public int describeContents() {
return 0;
}
@Override
public void writeToParcel(Parcel dest, int flags) {
dest.writeFloat(brightness);
dest.writeFloat(adjustedBrightness);
dest.writeFloat(brightnessMinimum);
dest.writeFloat(brightnessMaximum);
dest.writeInt(highBrightnessMode);
dest.writeFloat(highBrightnessTransitionPoint);
dest.writeInt(brightnessMaxReason);
}
public static final @android.annotation.NonNull Creator<BrightnessInfo> CREATOR =
new Creator<BrightnessInfo>() {
@Override
public BrightnessInfo createFromParcel(Parcel source) {
return new BrightnessInfo(source);
}
@Override
public BrightnessInfo[] newArray(int size) {
return new BrightnessInfo[size];
}
};
private BrightnessInfo(Parcel source) {
brightness = source.readFloat();
adjustedBrightness = source.readFloat();
brightnessMinimum = source.readFloat();
brightnessMaximum = source.readFloat();
highBrightnessMode = source.readInt();
highBrightnessTransitionPoint = source.readFloat();
brightnessMaxReason = source.readInt();
}
}
|
