Added in API level 24

Summary: Constants | Inherited Constants | Fields | Methods | Inherited Methods

Display.HdrCapabilities

Kotlin |Java

public static final class Display.HdrCapabilities
extends Object implements Parcelable

java.lang.Object
↳	android.view.Display.HdrCapabilities

Encapsulates the HDR capabilities of a given display. For example, what HDR types it supports and details about the desired luminance data.

You can get an instance for a given Display object with getHdrCapabilities().

Summary

Constants
`int`	`HDR_TYPE_DOLBY_VISION` Dolby Vision high dynamic range (HDR) display.
`int`	`HDR_TYPE_HDR10` HDR10 display.
`int`	`HDR_TYPE_HDR10_PLUS` HDR10+ display.
`int`	`HDR_TYPE_HLG` Hybrid Log-Gamma HDR display.
`int`	`HDR_TYPE_INVALID` Invalid HDR type value.
`float`	`INVALID_LUMINANCE` Invalid luminance value.

Inherited constants

From interface android.os.Parcelable

`int`	`CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int`	`PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `writeToParcel(Parcel, int)`: the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout Parcelable)`".

Fields
`public static final Creator<Display.HdrCapabilities>`	`CREATOR`

Public methods
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`boolean`	`equals(Object other)` Indicates whether some other object is "equal to" this one.
`float`	`getDesiredMaxAverageLuminance()` Returns the desired content max frame-average luminance data in cd/m2 for this display.
`float`	`getDesiredMaxLuminance()` Returns the desired content max luminance data in cd/m2 for this display.
`float`	`getDesiredMinLuminance()` Returns the desired content min luminance data in cd/m2 for this display.
`int[]`	`getSupportedHdrTypes()` This method was deprecated in API level 34. use `Display.getMode()` and `Mode.getSupportedHdrTypes()` instead
`int`	`hashCode()` Returns a hash code value for the object.
`String`	`toString()` Returns a string representation of the object.
`void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Constants

HDR_TYPE_DOLBY_VISION

Added in API level 24

public static final int HDR_TYPE_DOLBY_VISION

Dolby Vision high dynamic range (HDR) display.

Constant Value: 1 (0x00000001)

HDR_TYPE_HDR10

Added in API level 24

public static final int HDR_TYPE_HDR10

HDR10 display.

Constant Value: 2 (0x00000002)

HDR_TYPE_HDR10_PLUS

Added in API level 29

public static final int HDR_TYPE_HDR10_PLUS

HDR10+ display.

Constant Value: 4 (0x00000004)

HDR_TYPE_HLG

Added in API level 24

public static final int HDR_TYPE_HLG

Hybrid Log-Gamma HDR display.

Constant Value: 3 (0x00000003)

HDR_TYPE_INVALID

Added in API level 34

public static final int HDR_TYPE_INVALID

Invalid HDR type value.

Constant Value: -1 (0xffffffff)

INVALID_LUMINANCE

Added in API level 24

public static final float INVALID_LUMINANCE

Invalid luminance value.

Constant Value: -1.0

Fields

CREATOR

Added in API level 24

public static final Creator<Display.HdrCapabilities> CREATOR

Public methods

describeContents

Added in API level 24

public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
`int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `CONTENTS_FILE_DESCRIPTOR`

equals

Added in API level 24

public boolean equals (Object other)

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
`other`	`Object`: This value may be `null`.

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

getDesiredMaxAverageLuminance

Added in API level 24

public float getDesiredMaxAverageLuminance ()

Returns the desired content max frame-average luminance data in cd/m2 for this display.

Returns
`float`

getDesiredMaxLuminance

Added in API level 24

public float getDesiredMaxLuminance ()

Returns the desired content max luminance data in cd/m2 for this display.

Returns
`float`

getDesiredMinLuminance

Added in API level 24

public float getDesiredMinLuminance ()

Returns the desired content min luminance data in cd/m2 for this display.

Returns
`float`

getSupportedHdrTypes

Added in API level 24
Deprecated in API level 34

public int[] getSupportedHdrTypes ()

This method was deprecated in API level 34.
use Display.getMode() and Mode.getSupportedHdrTypes() instead

Gets the supported HDR types of this display. Returns empty array if HDR is not supported by the display.

Returns
`int[]`	Value is `HDR_TYPE_INVALID`, `HDR_TYPE_DOLBY_VISION`, `HDR_TYPE_HDR10`, `HDR_TYPE_HLG`, or `HDR_TYPE_HDR10_PLUS`

hashCode

Added in API level 24

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

Added in API level 24

public String toString ()

Returns a string representation of the object.

Returns
`String`	a string representation of the object.

writeToParcel

Added in API level 24

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
`dest`	`Parcel`: The Parcel in which the object should be written. This value cannot be `null`.
`flags`	`int`: Additional flags about how the object should be written. May be 0 or `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES