Added in API level 23

Summary: Inherited Constants | Fields | Methods | Inherited Methods

Display.Mode

---

Kotlin |Java

public static final class Display.Mode
extends Object implements Parcelable

java.lang.Object
↳	android.view.Display.Mode

---

A mode supported by a given display.

See also:

• Display.getSupportedModes()

Summary

Inherited constants

From interface android.os.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(Parcel, 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)".

Fields
public static final Creator<Display.Mode>	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[]	getAlternativeRefreshRates() Returns an array of refresh rates which can be switched to seamlessly.
int	getModeId() Returns this mode's id.
int	getPhysicalHeight() Returns the physical height of the display in pixels when configured in this mode's resolution.
int	getPhysicalWidth() Returns the physical width of the display in pixels when configured in this mode's resolution.
float	getRefreshRate() Returns the refresh rate in frames per second.
int[]	getSupportedHdrTypes() Returns the supported HdrCapabilities HDR_TYPE_* for this specific mode
int	hashCode() Returns a hash code value for the object.
String	toString() Returns a string representation of the object.
void	writeToParcel(Parcel out, int parcelableFlags) Flatten this object in to a Parcel.

Inherited methods
From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
From interface android.os.Parcelable abstract int describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. abstract void writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Fields

CREATOR

Added in API level 23

public static final Creator<Display.Mode> CREATOR

Public methods

describeContents

Added in API level 23

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

Added in API level 23

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 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
other	Object: This value may be null.

Returns
boolean	true if this object is the same as the obj argument; false otherwise.

getAlternativeRefreshRates

Added in API level 31

public float[] getAlternativeRefreshRates ()

Returns an array of refresh rates which can be switched to seamlessly.

A seamless switch is one without visual interruptions, such as a black screen for a second or two.

Presence in this list does not guarantee a switch will occur to the desired refresh rate, but rather, if a switch does occur to a refresh rate in this list, it is guaranteed to be seamless.

The binary relation "refresh rate X is alternative to Y" is non-reflexive, symmetric and transitive. For example the mode 1920x1080 60Hz, will never have an alternative refresh rate of 60Hz. If 1920x1080 60Hz has an alternative of 50Hz then 1920x1080 50Hz will have alternative refresh rate of 60Hz. If 1920x1080 60Hz has an alternative of 50Hz and 1920x1080 50Hz has an alternative of 24Hz, then 1920x1080 60Hz will also have an alternative of 24Hz.

Returns
float[]	This value cannot be null.

See also:

• Surface.setFrameRate(float, int)
• SurfaceControl.Transaction.setFrameRate(SurfaceControl, float, int)

getModeId

Added in API level 23

public int getModeId ()

Returns this mode's id.

Returns
int

getPhysicalHeight

Added in API level 23

public int getPhysicalHeight ()

Returns the physical height of the display in pixels when configured in this mode's resolution.

Note that due to application UI scaling, the number of pixels made available to applications when the mode is active (as reported by Display#getHeight() may differ from the mode's actual resolution (as reported by this function).

For example, applications running on a 4K display may have their UI laid out and rendered in 1080p and then scaled up. Applications can take advantage of the extra resolution by rendering content through a SurfaceView using full size buffers.

Returns
int

getPhysicalWidth

Added in API level 23

public int getPhysicalWidth ()

Returns the physical width of the display in pixels when configured in this mode's resolution.

Note that due to application UI scaling, the number of pixels made available to applications when the mode is active (as reported by Display#getWidth() may differ from the mode's actual resolution (as reported by this function).

For example, applications running on a 4K display may have their UI laid out and rendered in 1080p and then scaled up. Applications can take advantage of the extra resolution by rendering content through a SurfaceView using full size buffers.

Returns
int

getRefreshRate

Added in API level 23

public float getRefreshRate ()

Returns the refresh rate in frames per second.

Returns
float

getSupportedHdrTypes

Added in API level 34

public int[] getSupportedHdrTypes ()

Returns the supported HdrCapabilities HDR_TYPE_* for this specific mode

Returns
int[]	This value cannot be null. Value is Display.HdrCapabilities.HDR_TYPE_INVALID, Display.HdrCapabilities.HDR_TYPE_DOLBY_VISION, Display.HdrCapabilities.HDR_TYPE_HDR10, Display.HdrCapabilities.HDR_TYPE_HLG, or Display.HdrCapabilities.HDR_TYPE_HDR10_PLUS

hashCode

Added in API level 23

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 hashCode method must consistently return the same integer, provided no information used in equals comparisons 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 method, then calling the hashCode method 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 method, then calling the hashCode method 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.

Returns
int	a hash code value for this object.

toString

Added in API level 23

public String toString ()

Returns a string representation of the object.

Returns
String	a string representation of the object.

writeToParcel

Added in API level 23

public void writeToParcel (Parcel out, 
                int parcelableFlags)

Flatten this object in to a Parcel.

Parameters
out	Parcel: The Parcel in which the object should be written. This value cannot be null.
parcelableFlags	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