Added in API level 36

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
equals(other: Any?)

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

Returns a hash code value for the object.

String

Returns a string representation of the object.

Constants

GPU_HEADROOM_CALCULATION_TYPE_AVERAGE

Added in API level 36
static val GPU_HEADROOM_CALCULATION_TYPE_AVERAGE: Int

The headroom calculation type bases on average value over a specified window.

Value: 1

GPU_HEADROOM_CALCULATION_TYPE_MIN

Added in API level 36
static val GPU_HEADROOM_CALCULATION_TYPE_MIN: Int

The headroom calculation type bases on minimum value over a specified window.

Value: 0

GPU_HEADROOM_CALCULATION_WINDOW_MILLIS_MAX

Added in API level 36
static val GPU_HEADROOM_CALCULATION_WINDOW_MILLIS_MAX: Int

The maximum size of the window to compute the headroom over.

Value: 10000

GPU_HEADROOM_CALCULATION_WINDOW_MILLIS_MIN

Added in API level 36
static val GPU_HEADROOM_CALCULATION_WINDOW_MILLIS_MIN: Int

The minimum size of the window to compute the headroom over.

Value: 50

Public methods

equals

Added in API level 36
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 return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

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

Added in API level 36
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

Added in API level 36
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

Added in API level 36
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 hashCode method must consistently return the same integer, provided no information used in equals comparisons 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 equals method, then calling the hashCode method 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 equals method, then calling the hashCode method 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

Added in API level 36
fun toString(): String

Returns a string representation of the object.

Return
String a string representation of the object.