HdrCapabilities
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 |
Dolby Vision high dynamic range (HDR) display. |
| static Int |
HDR10 display. |
| static Int |
HDR10+ display. |
| static Int |
Hybrid Log-Gamma HDR display. |
| static Int |
Invalid HDR type value. |
| static Float |
Invalid luminance value. |
| Inherited constants | |
|---|---|
| Public methods | |
|---|---|
| Int |
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| Boolean |
Indicates whether some other object is "equal to" this one. |
| Float |
Returns the desired content max frame-average luminance data in cd/m2 for this display. |
| Float |
Returns the desired content max luminance data in cd/m2 for this display. |
| Float |
Returns the desired content min luminance data in cd/m2 for this display. |
| IntArray! |
Gets the supported HDR types of this display. |
| Int |
hashCode()Returns a hash code value for the object. |
| String |
toString()Returns a string representation of the object. |
| Unit |
writeToParcel(dest: Parcel, flags: Int)Flatten this object in to a Parcel. |
| Properties | |
|---|---|
| static Parcelable.Creator<Display.HdrCapabilities!> | |
Constants
HDR_TYPE_DOLBY_VISION
static val HDR_TYPE_DOLBY_VISION: Int
Dolby Vision high dynamic range (HDR) display.
Value: 1HDR_TYPE_HDR10_PLUS
static val HDR_TYPE_HDR10_PLUS: Int
HDR10+ display.
Value: 4HDR_TYPE_HLG
static val HDR_TYPE_HLG: Int
Hybrid Log-Gamma HDR display.
Value: 3HDR_TYPE_INVALID
static val HDR_TYPE_INVALID: Int
Invalid HDR type value.
Value: -1INVALID_LUMINANCE
static val INVALID_LUMINANCE: Float
Invalid luminance value.
Value: -1.0fPublic methods
describeContents
fun describeContents(): Int
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.
| Return | |
|---|---|
Int |
a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or
|
equals
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 returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
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
fun getDesiredMaxAverageLuminance(): Float
Returns the desired content max frame-average luminance data in cd/m2 for this display.
getDesiredMaxLuminance
fun getDesiredMaxLuminance(): Float
Returns the desired content max luminance data in cd/m2 for this display.
getDesiredMinLuminance
fun getDesiredMinLuminance(): Float
Returns the desired content min luminance data in cd/m2 for this display.
getSupportedHdrTypes
fungetSupportedHdrTypes(): 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 one of the following: |
hashCode
fun hashCode(): Int
Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by 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
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons 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
equalsmethod, then calling thehashCodemethod 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
equalsmethod, then calling thehashCodemethod 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.
| Return | |
|---|---|
Int |
a hash code value for this object. |
toString
fun toString(): String
Returns a string representation of the object.
| Return | |
|---|---|
String |
a string representation of the object. |
writeToParcel
fun writeToParcel(
dest: Parcel,
flags: Int
): Unit
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_WRITE_RETURN_VALUE. Value is either 0 or a combination of the following:
|