Most visited

Recently visited

Added in API level 24

Display.HdrCapabilities

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_HLG

Hybrid Log-Gamma HDR display.

float INVALID_LUMINANCE

Invalid luminance value.

Inherited constants

From interface android.os.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.

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()

Gets the supported HDR types of this display.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

From class java.lang.Object
From interface android.os.Parcelable

Constants

HDR_TYPE_DOLBY_VISION

Added in API level 24
int HDR_TYPE_DOLBY_VISION

Dolby Vision high dynamic range (HDR) display.

Constant Value: 1 (0x00000001)

HDR_TYPE_HDR10

Added in API level 24
int HDR_TYPE_HDR10

HDR10 display.

Constant Value: 2 (0x00000002)

HDR_TYPE_HLG

Added in API level 24
int HDR_TYPE_HLG

Hybrid Log-Gamma HDR display.

Constant Value: 3 (0x00000003)

INVALID_LUMINANCE

Added in API level 24
float INVALID_LUMINANCE

Invalid luminance value.

Constant Value: -1.0

Fields

CREATOR

Added in API level 24
Creator<Display.HdrCapabilities> CREATOR

Public methods

describeContents

Added in API level 24
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(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.

getDesiredMaxAverageLuminance

Added in API level 24
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
float getDesiredMaxLuminance ()

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

Returns
float

getDesiredMinLuminance

Added in API level 24
float getDesiredMinLuminance ()

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

Returns
float

getSupportedHdrTypes

Added in API level 24
int[] getSupportedHdrTypes ()

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

Returns
int[]

writeToParcel

Added in API level 24
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.
flags int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.

Hooray!