GpuHeadroomParams


public final class GpuHeadroomParams
extends Object

java.lang.Object
   ↳ 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

class GpuHeadroomParams.Builder

 

Constants

int GPU_HEADROOM_CALCULATION_TYPE_AVERAGE

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

int GPU_HEADROOM_CALCULATION_TYPE_MIN

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

int GPU_HEADROOM_CALCULATION_WINDOW_MILLIS_MAX

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

int GPU_HEADROOM_CALCULATION_WINDOW_MILLIS_MIN

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

Public methods

boolean equals(Object o)

Indicates whether some other object is "equal to" this one.

int getCalculationType()

Gets the headroom calculation type.

int getCalculationWindowMillis()

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.

Inherited methods

Constants

GPU_HEADROOM_CALCULATION_TYPE_AVERAGE

public static final int GPU_HEADROOM_CALCULATION_TYPE_AVERAGE

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

Constant Value: 1 (0x00000001)

GPU_HEADROOM_CALCULATION_TYPE_MIN

public static final int GPU_HEADROOM_CALCULATION_TYPE_MIN

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

Constant Value: 0 (0x00000000)

GPU_HEADROOM_CALCULATION_WINDOW_MILLIS_MAX

public static final int GPU_HEADROOM_CALCULATION_WINDOW_MILLIS_MAX

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

Constant Value: 10000 (0x00002710)

GPU_HEADROOM_CALCULATION_WINDOW_MILLIS_MIN

public static final int GPU_HEADROOM_CALCULATION_WINDOW_MILLIS_MIN

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

Constant Value: 50 (0x00000032)

Public methods

equals

public boolean equals (Object o)

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
o Object: the reference object with which to compare.

Returns
boolean true if this object is the same as the obj argument; false otherwise.

getCalculationType

public int getCalculationType ()

Gets the headroom calculation type.

This will return the default value chosen by the device if not set.

Returns
int Value is GPU_HEADROOM_CALCULATION_TYPE_MIN, or GPU_HEADROOM_CALCULATION_TYPE_AVERAGE

getCalculationWindowMillis

public int getCalculationWindowMillis ()

Gets the headroom calculation window size in milliseconds.

This will return the default value chosen by the device if not set.

Returns
int

hashCode

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by 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.

Returns
int a hash code value for this object.

toString

public String toString ()

Returns a string representation of the object.

Returns
String a string representation of the object.