Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Constants](https://developer.android.com/reference/android/view/Display.HdrCapabilities#constants) \| [Inherited Constants](https://developer.android.com/reference/android/view/Display.HdrCapabilities#inhconstants) \| [Fields](https://developer.android.com/reference/android/view/Display.HdrCapabilities#lfields) \| [Methods](https://developer.android.com/reference/android/view/Display.HdrCapabilities#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/view/Display.HdrCapabilities#inhmethods)

# Display.HdrCapabilities

*** ** * ** ***

` public static final class Display.HdrCapabilities `   
` extends https://developer.android.com/reference/java/lang/Object ` ` implements https://developer.android.com/reference/android/os/Parcelable `

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.view.Display.HdrCapabilities |

<br />

*** ** * ** ***

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 `https://developer.android.com/reference/android/view/Display` object with `https://developer.android.com/reference/android/view/Display#getHdrCapabilities()`.

## Summary

| ### Constants ||
|---|---|
| `int` | `https://developer.android.com/reference/android/view/Display.HdrCapabilities#HDR_TYPE_DOLBY_VISION` Dolby Vision high dynamic range (HDR) display. |
| `int` | `https://developer.android.com/reference/android/view/Display.HdrCapabilities#HDR_TYPE_HDR10` HDR10 display. |
| `int` | `https://developer.android.com/reference/android/view/Display.HdrCapabilities#HDR_TYPE_HDR10_PLUS` HDR10+ display. |
| `int` | `https://developer.android.com/reference/android/view/Display.HdrCapabilities#HDR_TYPE_HLG` Hybrid Log-Gamma HDR display. |
| `int` | `https://developer.android.com/reference/android/view/Display.HdrCapabilities#HDR_TYPE_HLG_PLUS` HLG+ display. |
| `int` | `https://developer.android.com/reference/android/view/Display.HdrCapabilities#HDR_TYPE_INVALID` Invalid HDR type value. |
| `float` | `https://developer.android.com/reference/android/view/Display.HdrCapabilities#INVALID_LUMINANCE` Invalid luminance value. |

### Inherited constants

From interface `https://developer.android.com/reference/android/os/Parcelable` `int` `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR`

Descriptor bit used with `https://developer.android.com/reference/android/os/Parcelable#describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int` `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`

Flag for use with `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`: 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 https://developer.android.com/reference/android/os/Parcelable.Creator<https://developer.android.com/reference/android/view/Display.HdrCapabilities>` | `https://developer.android.com/reference/android/view/Display.HdrCapabilities#CREATOR` <br /> |

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

### Inherited methods

From class ` https://developer.android.com/reference/java/lang/Object ` ` https://developer.android.com/reference/java/lang/Object` ` https://developer.android.com/reference/java/lang/Object#clone()() `

Creates and returns a copy of this object.
` boolean` ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) `

Indicates whether some other object is "equal to" this one.
` void` ` https://developer.android.com/reference/java/lang/Object#finalize()() `

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
` final https://developer.android.com/reference/java/lang/Class<?>` ` https://developer.android.com/reference/java/lang/Object#getClass()() `

Returns the runtime class of this `Object`.
` int` ` https://developer.android.com/reference/java/lang/Object#hashCode()() `

Returns a hash code value for the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#notify()() `

Wakes up a single thread that is waiting on this object's monitor.
` final void` ` https://developer.android.com/reference/java/lang/Object#notifyAll()() `

Wakes up all threads that are waiting on this object's monitor.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Object#toString()() `

Returns a string representation of the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(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` ` https://developer.android.com/reference/java/lang/Object#wait(long)(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` ` https://developer.android.com/reference/java/lang/Object#wait()() `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*.
From interface ` https://developer.android.com/reference/android/os/Parcelable ` ` abstract int` ` https://developer.android.com/reference/android/os/Parcelable#describeContents()() `

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
` abstract void` ` https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) `

Flatten this object in to a Parcel.

## Constants

### HDR_TYPE_DOLBY_VISION

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int HDR_TYPE_DOLBY_VISION
```

Dolby Vision high dynamic range (HDR) display.

<br />

Constant Value: 1 (0x00000001)

### HDR_TYPE_HDR10

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int HDR_TYPE_HDR10
```

HDR10 display.

<br />

Constant Value: 2 (0x00000002)

### HDR_TYPE_HDR10_PLUS

Added in [API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int HDR_TYPE_HDR10_PLUS
```

HDR10+ display.

<br />

Constant Value: 4 (0x00000004)

### HDR_TYPE_HLG

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int HDR_TYPE_HLG
```

Hybrid Log-Gamma HDR display.

<br />

Constant Value: 3 (0x00000003)

### HDR_TYPE_HLG_PLUS

Added in [API level 37](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int HDR_TYPE_HLG_PLUS
```

HLG+ display.

<br />

Constant Value: 6 (0x00000006)

### HDR_TYPE_INVALID

Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int HDR_TYPE_INVALID
```

Invalid HDR type value.

<br />

Constant Value: -1 (0xffffffff)

### INVALID_LUMINANCE

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final float INVALID_LUMINANCE
```

Invalid luminance value.

<br />

Constant Value: -1.0

## Fields

### CREATOR

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

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

<br />

<br />

## Public methods

### describeContents

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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 `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`, the return value of this method must include the `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` bit.

<br />

| Returns ||
|---|---|
| `int` | a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or - `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` |

### equals

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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.

<br />

| Parameters ||
|---|---|
| `other` | `Object`: This value may be `null`. <br /> |

| Returns ||
|---|---|
| `boolean` | `true` if this object is the same as the obj argument; `false` otherwise. <br /> |

### getDesiredMaxAverageLuminance

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public float getDesiredMaxAverageLuminance ()
```

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

<br />

| Returns ||
|---|---|
| `float` | <br /> |

### getDesiredMaxLuminance

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public float getDesiredMaxLuminance ()
```

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

<br />

| Returns ||
|---|---|
| `float` | <br /> |

### getDesiredMinLuminance

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public float getDesiredMinLuminance ()
```

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

<br />

| Returns ||
|---|---|
| `float` | <br /> |

### getSupportedHdrTypes

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)   
Deprecated in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int[] getSupportedHdrTypes ()
```

<br />

**This method was deprecated in API level 34.**   

use `https://developer.android.com/reference/android/view/Display#getMode()` and `https://developer.android.com/reference/android/view/Display.Mode#getSupportedHdrTypes()` instead

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

<br />

| Returns ||
|---|---|
| `int[]` | Value is one of the following: - `https://developer.android.com/reference/android/view/Display.HdrCapabilities#HDR_TYPE_INVALID` - `https://developer.android.com/reference/android/view/Display.HdrCapabilities#HDR_TYPE_DOLBY_VISION` - `https://developer.android.com/reference/android/view/Display.HdrCapabilities#HDR_TYPE_HDR10` - `https://developer.android.com/reference/android/view/Display.HdrCapabilities#HDR_TYPE_HLG` - `https://developer.android.com/reference/android/view/Display.HdrCapabilities#HDR_TYPE_HDR10_PLUS` - `https://developer.android.com/reference/android/view/Display.HdrCapabilities#HDR_TYPE_HLG_PLUS` |

### hashCode

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
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 `https://developer.android.com/reference/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 `https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)` 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 `https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)` 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.

<br />

<br />

| Returns ||
|---|---|
| `int` | a hash code value for this object. <br /> |

### toString

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String toString ()
```

Returns a string representation of the object.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | a string representation of the object. <br /> |

### writeToParcel

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void writeToParcel (Parcel dest, 
                int flags)
```

Flatten this object in to a Parcel.

<br />

| Parameters ||
|---|---|
| `dest` | `Parcel`: The Parcel in which the object should be written. This value cannot be `null`. <br /> |
| `flags` | `int`: Additional flags about how the object should be written. May be 0 or `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: - `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` |