Added in API level 23

Mode

class Mode : Parcelable
kotlin.Any
   ↳ android.view.Display.Mode

A mode supported by a given display.

Summary

Inherited constants
Public methods
Int

Boolean
equals(other: Any?)

Indicates whether some other object is "equal to" this one.

FloatArray

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

Int

Returns this mode's id.

Int

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

Int

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

Float

Returns the refresh rate in frames per second.

IntArray

Returns the supported HdrCapabilities HDR_TYPE_* for this specific mode

Int

String

Unit
writeToParcel(out: Parcel, parcelableFlags: Int)

Properties
static Parcelable.Creator<Display.Mode!>

Public methods

describeContents

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

getAlternativeRefreshRates

Added in API level 31
fun getAlternativeRefreshRates(): FloatArray

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.

Return
FloatArray This value cannot be null.

See Also

    getModeId

    Added in API level 23
    fun getModeId(): Int

    Returns this mode's id.

    getPhysicalHeight

    Added in API level 23
    fun getPhysicalHeight(): Int

    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 android.view.SurfaceView using full size buffers.

    getPhysicalWidth

    Added in API level 23
    fun getPhysicalWidth(): Int

    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 android.view.SurfaceView using full size buffers.

    getRefreshRate

    Added in API level 23
    fun getRefreshRate(): Float

    Returns the refresh rate in frames per second.

    hashCode

    Added in API level 23
    fun hashCode(): Int
    Return
    Int a hash code value for this object.

    toString

    Added in API level 23
    fun toString(): String
    Return
    String a string representation of the object.

    writeToParcel

    Added in API level 23
    fun writeToParcel(
        out: Parcel,
        parcelableFlags: Int
    ): Unit
    Parameters
    dest The Parcel in which the object should be written. This value cannot be null.
    flags 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 23
    static val CREATOR: Parcelable.Creator<Display.Mode!>