GpuHeadroomParams.Builder


public static final class GpuHeadroomParams.Builder
extends Object

java.lang.Object
   ↳ android.os.GpuHeadroomParams.Builder


Summary

Public constructors

Builder()
Builder(GpuHeadroomParams params)

Returns a new builder with the same values as this object.

Public methods

GpuHeadroomParams build()

Builds the GpuHeadroomParams object.

GpuHeadroomParams.Builder setCalculationType(int calculationType)

Sets the headroom calculation type.

GpuHeadroomParams.Builder setCalculationWindowMillis(int windowMillis)

Sets the headroom calculation window size in milliseconds.

Inherited methods

Public constructors

Builder

public Builder ()

Builder

public Builder (GpuHeadroomParams params)

Returns a new builder with the same values as this object.

Parameters
params GpuHeadroomParams: This value cannot be null.

Public methods

build

public GpuHeadroomParams build ()

Builds the GpuHeadroomParams object.

Returns
GpuHeadroomParams This value cannot be null.

setCalculationType

public GpuHeadroomParams.Builder setCalculationType (int calculationType)

Sets the headroom calculation type.

Parameters
calculationType int: Value is GpuHeadroomParams.GPU_HEADROOM_CALCULATION_TYPE_MIN, or GpuHeadroomParams.GPU_HEADROOM_CALCULATION_TYPE_AVERAGE

Returns
GpuHeadroomParams.Builder This value cannot be null.

Throws
IllegalArgumentException if the type is invalid.

setCalculationWindowMillis

public GpuHeadroomParams.Builder setCalculationWindowMillis (int windowMillis)

Sets the headroom calculation window size in milliseconds.

Parameters
windowMillis int: the window size in milliseconds ranges from SystemHealthManager.getGpuHeadroomCalculationWindowRange(). The smaller the window size, the larger fluctuation in the headroom value should be expected. The default value can be retrieved from the GpuHeadroomParams.getCalculationWindowMillis. The device will try to use the closest feasible window size to this param. Value is 1 or greater

Returns
GpuHeadroomParams.Builder This value cannot be null.

Throws
IllegalArgumentException if the window is invalid.