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
Display#getHdrCapabilities.
Summary
Constants | |
|---|---|
int |
HDR_TYPE_DOLBY_VISION
Dolby Vision high dynamic range (HDR) display. |
int |
HDR_TYPE_HDR10
HDR10 display. |
int |
HDR_TYPE_HDR10_PLUS
HDR10+ display. |
int |
HDR_TYPE_HLG
Hybrid Log-Gamma HDR display. |
float |
INVALID_LUMINANCE
Invalid luminance value. |
Inherited constants |
|---|
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. |
boolean
|
equals(Object other)
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. |
int[]
|
getSupportedHdrTypes()
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. |
void
|
writeToParcel(Parcel dest, int flags)
Flatten this object in to a Parcel. |
Inherited methods | |
|---|---|
Constants
HDR_TYPE_DOLBY_VISION
public static final int HDR_TYPE_DOLBY_VISION
Dolby Vision high dynamic range (HDR) display.
Constant Value: 1 (0x00000001)
HDR_TYPE_HDR10
public static final int HDR_TYPE_HDR10
HDR10 display.
Constant Value: 2 (0x00000002)
HDR_TYPE_HDR10_PLUS
public static final int HDR_TYPE_HDR10_PLUS
HDR10+ display.
Constant Value: 4 (0x00000004)
HDR_TYPE_HLG
public static final int HDR_TYPE_HLG
Hybrid Log-Gamma HDR display.
Constant Value: 3 (0x00000003)
INVALID_LUMINANCE
public static final float INVALID_LUMINANCE
Invalid luminance value.
Constant Value: -1.0
Fields
Public methods
describeContents
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 writeToParcel(android.os.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.
Value is either 0 or CONTENTS_FILE_DESCRIPTOR |
equals
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 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.
The equals method for class Object implements
the most discriminating possible equivalence relation on objects;
that is, for any non-null reference values x and
y, this method returns true if and only
if x and y refer to the same object
(x == y has the value true).
Note that it is generally necessary to override the hashCode
method whenever this method is overridden, so as to maintain the
general contract for the hashCode method, which states
that equal objects must have equal hash codes.
| Parameters | |
|---|---|
other |
Object: the reference object with which to compare. |
| Returns | |
|---|---|
boolean |
true if this object is the same as the obj
argument; false otherwise. |
getDesiredMaxAverageLuminance
public float getDesiredMaxAverageLuminance ()
Returns the desired content max frame-average luminance data in cd/m2 for this display.
| Returns | |
|---|---|
float |
|
getDesiredMaxLuminance
public float getDesiredMaxLuminance ()
Returns the desired content max luminance data in cd/m2 for this display.
| Returns | |
|---|---|
float |
|
getDesiredMinLuminance
public float getDesiredMinLuminance ()
Returns the desired content min luminance data in cd/m2 for this display.
| Returns | |
|---|---|
float |
|
getSupportedHdrTypes
public int[] getSupportedHdrTypes ()
Gets the supported HDR types of this display. Returns empty array if HDR is not supported by the display.
| Returns | |
|---|---|
int[] |
Value is HDR_TYPE_DOLBY_VISION, HDR_TYPE_HDR10, HDR_TYPE_HLG, or HDR_TYPE_HDR10_PLUS |
hashCode
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
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
equals(Object)method, 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
equals(java.lang.Object)method, 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.
As much as is reasonably practical, the hashCode method defined by
class Object does return distinct integers for distinct
objects. (This is typically implemented by converting the internal
address of the object into an integer, but this implementation
technique is not required by the
Java™ programming language.)
| Returns | |
|---|---|
int |
a hash code value for this object. |
toString
public String toString ()
Returns a string representation of the object. In general, the
toString method returns a string that
"textually represents" this object. The result should
be a concise but informative representation that is easy for a
person to read.
It is recommended that all subclasses override this method.
The toString method for class Object
returns a string consisting of the name of the class of which the
object is an instance, the at-sign character `@', and
the unsigned hexadecimal representation of the hash code of the
object. In other words, this method returns a string equal to the
value of:
getClass().getName() + '@' + Integer.toHexString(hashCode())
| Returns | |
|---|---|
String |
a string representation of the object. |
writeToParcel
public 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.PARCELABLE_WRITE_RETURN_VALUE.
Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES |