# Display.HdrCapabilities Added in[API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) # HdrCapabilities *** ** * ** *** Kotlin\|[Java](https://developer.android.com/reference/android/view/Display.HdrCapabilities "View this page in Java") ``` class HdrCapabilities : Parcelable ``` |---|------------------------------------------------------------------------------------------------------------------------------| | [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) || | ↳ | [android.view.Display.HdrCapabilities](https://developer.android.com/reference/kotlin/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](https://developer.android.com/reference/kotlin/android/view/Display)object with[getHdrCapabilities()](https://developer.android.com/reference/kotlin/android/view/Display#getHdrCapabilities()). ## Summary | Constants || |--------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | static[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [HDR_TYPE_DOLBY_VISION](https://developer.android.com/reference/kotlin/android/view/Display.HdrCapabilities#HDR_TYPE_DOLBY_VISION:kotlin.Int) Dolby Vision high dynamic range (HDR) display. | | static[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [HDR_TYPE_HDR10](https://developer.android.com/reference/kotlin/android/view/Display.HdrCapabilities#HDR_TYPE_HDR10:kotlin.Int) HDR10 display. | | static[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [HDR_TYPE_HDR10_PLUS](https://developer.android.com/reference/kotlin/android/view/Display.HdrCapabilities#HDR_TYPE_HDR10_PLUS:kotlin.Int) HDR10+ display. | | static[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [HDR_TYPE_HLG](https://developer.android.com/reference/kotlin/android/view/Display.HdrCapabilities#HDR_TYPE_HLG:kotlin.Int) Hybrid Log-Gamma HDR display. | | static[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [HDR_TYPE_INVALID](https://developer.android.com/reference/kotlin/android/view/Display.HdrCapabilities#HDR_TYPE_INVALID:kotlin.Int) Invalid HDR type value. | | static[Float](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html) | [INVALID_LUMINANCE](https://developer.android.com/reference/kotlin/android/view/Display.HdrCapabilities#INVALID_LUMINANCE:kotlin.Float) Invalid luminance value. | | Inherited constants || |---|---| | From class[Parcelable](https://developer.android.com/reference/kotlin/android/os/Parcelable.html#) |----------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [CONTENTS_FILE_DESCRIPTOR](https://developer.android.com/reference/kotlin/android/os/Parcelable.html#CONTENTS_FILE_DESCRIPTOR:kotlin.Int)
Descriptor bit used with[describeContents()](https://developer.android.com/reference/kotlin/android/os/Parcelable.html#describeContents()): indicates that the Parcelable object's flattened representation includes a file descriptor.
| | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/kotlin/android/os/Parcelable.html#PARCELABLE_WRITE_RETURN_VALUE:kotlin.Int)
Flag for use with[writeToParcel](https://developer.android.com/reference/kotlin/android/os/Parcelable.html#writeToParcel(android.os.Parcel,%20kotlin.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)`". Some implementations may want to release resources at this point.
| || | Public methods || |----------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [describeContents](https://developer.android.com/reference/kotlin/android/view/Display.HdrCapabilities#describeContents())`()`
| | [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | [equals](https://developer.android.com/reference/kotlin/android/view/Display.HdrCapabilities#equals(kotlin.Any))`(`other:` `[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)?`)` Indicates whether some other object is "equal to" this one. | | [Float](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html) | [getDesiredMaxAverageLuminance](https://developer.android.com/reference/kotlin/android/view/Display.HdrCapabilities#getDesiredMaxAverageLuminance())`()` Returns the desired content max frame-average luminance data in cd/m2 for this display. | | [Float](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html) | [getDesiredMaxLuminance](https://developer.android.com/reference/kotlin/android/view/Display.HdrCapabilities#getDesiredMaxLuminance())`()` Returns the desired content max luminance data in cd/m2 for this display. | | [Float](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html) | [getDesiredMinLuminance](https://developer.android.com/reference/kotlin/android/view/Display.HdrCapabilities#getDesiredMinLuminance())`()` Returns the desired content min luminance data in cd/m2 for this display. | | [IntArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int-array/index.html)! | [getSupportedHdrTypes](https://developer.android.com/reference/kotlin/android/view/Display.HdrCapabilities#getSupportedHdrTypes())`()` Gets the supported HDR types of this display. | | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [hashCode](https://developer.android.com/reference/kotlin/android/view/Display.HdrCapabilities#hashCode())`()`
| | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | [toString](https://developer.android.com/reference/kotlin/android/view/Display.HdrCapabilities#toString())`()`
| | [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [writeToParcel](https://developer.android.com/reference/kotlin/android/view/Display.HdrCapabilities#writeToParcel(android.os.Parcel,%20kotlin.Int))`(`dest:` `[Parcel](https://developer.android.com/reference/kotlin/android/os/Parcel.html#)`, `flags:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)`
| | Properties || |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------| | static[Parcelable.Creator](https://developer.android.com/reference/kotlin/android/os/Parcelable.Creator.html#)\<[Display.HdrCapabilities](https://developer.android.com/reference/kotlin/android/view/Display.HdrCapabilities#)!\> | [CREATOR](https://developer.android.com/reference/kotlin/android/view/Display.HdrCapabilities#CREATOR:android.os.Parcelable.Creator)
| ## Constants ### HDR_TYPE_DOLBY_VISION Added in[API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` static val HDR_TYPE_DOLBY_VISION: Int ``` Dolby Vision high dynamic range (HDR) display. Value: 1 ### HDR_TYPE_HDR10 Added in[API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` static val HDR_TYPE_HDR10: Int ``` HDR10 display. Value: 2 ### HDR_TYPE_HDR10_PLUS Added in[API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` static val HDR_TYPE_HDR10_PLUS: Int ``` HDR10+ display. Value: 4 ### HDR_TYPE_HLG Added in[API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` static val HDR_TYPE_HLG: Int ``` Hybrid Log-Gamma HDR display. Value: 3 ### HDR_TYPE_INVALID Added in[API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` static val HDR_TYPE_INVALID: Int ``` Invalid HDR type value. Value: -1 ### INVALID_LUMINANCE Added in[API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` static val INVALID_LUMINANCE: Float ``` Invalid luminance value. Value: -1.0f ## Public methods ### describeContents Added in[API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun describeContents(): Int ``` | Return || |----------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either`0`or[android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR](https://developer.android.com/reference/kotlin/android/os/Parcelable.html#CONTENTS_FILE_DESCRIPTOR:kotlin.Int) | ### equals Added in[API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` 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. | | `other` | [Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)?:This value may be`null`. | | Return || |------------------------------------------------------------------------------------|------------------------------------------------------------------------| | [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | `true`if this object is the same as the obj argument;`false`otherwise. | ### getDesiredMaxAverageLuminance Added in[API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun getDesiredMaxAverageLuminance(): Float ``` Returns the desired content max frame-average luminance data in cd/m2 for this display. ### getDesiredMaxLuminance Added in[API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun getDesiredMaxLuminance(): Float ``` Returns the desired content max luminance data in cd/m2 for this display. ### getDesiredMinLuminance Added in[API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun getDesiredMinLuminance(): Float ``` Returns the desired content min luminance data in cd/m2 for this display. ### getSupportedHdrTypes Added in[API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) Deprecated in[API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun getSupportedHdrTypes(): IntArray! ``` **Deprecated:** *use[Display.getMode()](https://developer.android.com/reference/kotlin/android/view/Display#getMode())and[Mode.getSupportedHdrTypes()](https://developer.android.com/reference/kotlin/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. | Return || |----------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [IntArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int-array/index.html)! | Value is[android.view.Display.HdrCapabilities#HDR_TYPE_INVALID](https://developer.android.com/reference/kotlin/android/view/Display.HdrCapabilities#HDR_TYPE_INVALID:kotlin.Int),[android.view.Display.HdrCapabilities#HDR_TYPE_DOLBY_VISION](https://developer.android.com/reference/kotlin/android/view/Display.HdrCapabilities#HDR_TYPE_DOLBY_VISION:kotlin.Int),[android.view.Display.HdrCapabilities#HDR_TYPE_HDR10](https://developer.android.com/reference/kotlin/android/view/Display.HdrCapabilities#HDR_TYPE_HDR10:kotlin.Int),[android.view.Display.HdrCapabilities#HDR_TYPE_HLG](https://developer.android.com/reference/kotlin/android/view/Display.HdrCapabilities#HDR_TYPE_HLG:kotlin.Int), or[android.view.Display.HdrCapabilities#HDR_TYPE_HDR10_PLUS](https://developer.android.com/reference/kotlin/android/view/Display.HdrCapabilities#HDR_TYPE_HDR10_PLUS:kotlin.Int) | ### hashCode Added in[API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun hashCode(): Int ``` | Return || |----------------------------------------------------------------------------|------------------------------------| | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | a hash code value for this object. | ### toString Added in[API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun toString(): String ``` | Return || |----------------------------------------------------------------------------------|----------------------------------------| | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | a string representation of the object. | ### writeToParcel Added in[API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` fun writeToParcel(     dest: Parcel,     flags: Int ): Unit ``` | Parameters || |---------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `dest` | [Parcel](https://developer.android.com/reference/kotlin/android/os/Parcel.html#):The Parcel in which the object should be written. This value cannot be`null`. | | `flags` | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html):Additional flags about how the object should be written. May be 0 or[PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/kotlin/android/os/Parcelable.html#PARCELABLE_WRITE_RETURN_VALUE:kotlin.Int). Value is either`0`or a combination of[android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/kotlin/android/os/Parcelable.html#PARCELABLE_WRITE_RETURN_VALUE:kotlin.Int), and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES | ## Properties ### CREATOR Added in[API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` static val CREATOR: Parcelable.Creator ```