HdrCapabilities

Kotlin |Java

class HdrCapabilities : Parcelable

kotlin.Any
↳	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
static Int	`HDR_TYPE_DOLBY_VISION` Dolby Vision high dynamic range (HDR) display.
static Int	`HDR_TYPE_HDR10` HDR10 display.
static Int	`HDR_TYPE_HDR10_PLUS` HDR10+ display.
static Int	`HDR_TYPE_HLG` Hybrid Log-Gamma HDR display.
static Int	`HDR_TYPE_INVALID` Invalid HDR type value.
static Float	`INVALID_LUMINANCE` Invalid luminance value.

Inherited constants

From class 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: 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	`describeContents()`
Boolean	`equals(other: Any?)` 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.
IntArray!	`getSupportedHdrTypes()` Gets the supported HDR types of this display.
Int	`hashCode()`
String	`toString()`
Unit	`writeToParcel(dest: Parcel, flags: Int)`

Properties
static Parcelable.Creator<Display.HdrCapabilities!>	`CREATOR`

Constants

HDR_TYPE_DOLBY_VISION

Added in API level 24

static val HDR_TYPE_DOLBY_VISION: Int

Dolby Vision high dynamic range (HDR) display.

Value: 1

HDR_TYPE_HDR10

Added in API level 24

static val HDR_TYPE_HDR10: Int

HDR10 display.

Value: 2

HDR_TYPE_HDR10_PLUS

Added in API level 29

static val HDR_TYPE_HDR10_PLUS: Int

HDR10+ display.

Value: 4

HDR_TYPE_HLG

Added in API level 24

static val HDR_TYPE_HLG: Int

Hybrid Log-Gamma HDR display.

Value: 3

HDR_TYPE_INVALID

Added in API level 34

static val HDR_TYPE_INVALID: Int

Invalid HDR type value.

Value: -1

INVALID_LUMINANCE

Added in API level 24

static val INVALID_LUMINANCE: Float

Invalid luminance value.

Value: -1.0f

Public methods

describeContents

Added in API level 24

fun describeContents(): Int

Return
`Int`	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`

equals

Added in API level 24

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

Return
`Boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

getDesiredMaxAverageLuminance

Added in API level 24

fun getDesiredMaxAverageLuminance(): Float

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

getDesiredMaxLuminance

Added in API level 24

fun getDesiredMaxLuminance(): Float

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

getDesiredMinLuminance

Added in API level 24

fun getDesiredMinLuminance(): Float

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

getSupportedHdrTypes

Added in API level 24
Deprecated in API level 34

fun getSupportedHdrTypes(): IntArray!

Deprecated: 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.

Return
`IntArray!`	Value is `android.view.Display.HdrCapabilities#HDR_TYPE_INVALID`, `android.view.Display.HdrCapabilities#HDR_TYPE_DOLBY_VISION`, `android.view.Display.HdrCapabilities#HDR_TYPE_HDR10`, `android.view.Display.HdrCapabilities#HDR_TYPE_HLG`, or `android.view.Display.HdrCapabilities#HDR_TYPE_HDR10_PLUS`

hashCode

Added in API level 24

fun hashCode(): Int

Return
`Int`	a hash code value for this object.

toString

Added in API level 24

fun toString(): String

Return
`String`	a string representation of the object.

writeToParcel

Added in API level 24

fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

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_WRITE_RETURN_VALUE`. Value is either `0` or a combination of `android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 24

static val CREATOR: Parcelable.Creator<Display.HdrCapabilities!>