Mode

Kotlin |Java

class Mode : Parcelable

kotlin.Any
↳	android.view.Display.Mode

A mode supported by a given display.

Summary

Inherited constants

From class 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: 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)". Some implementations may want to release resources at this point.

Public methods
Int	`describeContents()`
Boolean	`equals(other: Any?)`
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	`hashCode()`
String	`toString()`
Unit	`writeToParcel(out: Parcel!, parcelableFlags: Int)`

Properties
static Parcelable.Creator<Display.Mode!>	`CREATOR`

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

Parameters
`obj`	the reference object with which to compare.

Return
`Boolean`	`true` if this object is the same as the obj argument; `false` otherwise.

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

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.
`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!>