GpuHeadroomParams
class GpuHeadroomParams
| kotlin.Any | |
| ↳ | android.os.GpuHeadroomParams |
Headroom request params used by SystemHealthManager.getGpuHeadroom(GpuHeadroomParams).
This class is immutable and one should use the Builder to build a new instance.
Summary
| Nested classes | |
|---|---|
| Constants | |
|---|---|
| static Int |
The headroom calculation type bases on average value over a specified window. |
| static Int |
The headroom calculation type bases on minimum value over a specified window. |
| static Int |
The maximum size of the window to compute the headroom over. |
| static Int |
The minimum size of the window to compute the headroom over. |
| Public methods | |
|---|---|
| Boolean |
Indicates whether some other object is "equal to" this one. |
| Int |
Gets the headroom calculation type. |
| Int |
Gets the headroom calculation window size in milliseconds. |
| Int |
hashCode()Returns a hash code value for the object. |
| String |
toString()Returns a string representation of the object. |
Constants
GPU_HEADROOM_CALCULATION_TYPE_AVERAGE
static val GPU_HEADROOM_CALCULATION_TYPE_AVERAGE: Int
The headroom calculation type bases on average value over a specified window.
Value: 1GPU_HEADROOM_CALCULATION_TYPE_MIN
static val GPU_HEADROOM_CALCULATION_TYPE_MIN: Int
The headroom calculation type bases on minimum value over a specified window.
Value: 0GPU_HEADROOM_CALCULATION_WINDOW_MILLIS_MAX
static val GPU_HEADROOM_CALCULATION_WINDOW_MILLIS_MAX: Int
The maximum size of the window to compute the headroom over.
Value: 10000GPU_HEADROOM_CALCULATION_WINDOW_MILLIS_MIN
static val GPU_HEADROOM_CALCULATION_WINDOW_MILLIS_MIN: Int
The minimum size of the window to compute the headroom over.
Value: 50Public methods
equals
fun equals(other: Any?): Boolean
Indicates whether some other object is "equal to" this one.
The equals method implements an equivalence relation on non-null object references:
- It is reflexive: for any non-null reference value
x,x.equals(x)should returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.
| Parameters | |
|---|---|
obj |
the reference object with which to compare. |
| Return | |
|---|---|
Boolean |
true if this object is the same as the obj argument; false otherwise. |
getCalculationType
fun getCalculationType(): Int
Gets the headroom calculation type.
This will return the default value chosen by the device if not set.
| Return | |
|---|---|
Int |
Value is one of the following: |
getCalculationWindowMillis
fun getCalculationWindowMillis(): Int
Gets the headroom calculation window size in milliseconds.
This will return the default value chosen by the device if not set.
hashCode
fun hashCode(): Int
Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.
The general contract of hashCode is:
- Whenever it is invoked on the same object more than once during an execution of a Java application, the
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. - If two objects are equal according to the
equalsmethod, then calling thehashCodemethod on each of the two objects must produce the same integer result. - It is not required that if two objects are unequal according to the
equalsmethod, then calling thehashCodemethod on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
| Return | |
|---|---|
Int |
a hash code value for this object. |
toString
fun toString(): String
Returns a string representation of the object.
| Return | |
|---|---|
String |
a string representation of the object. |