# Display.Mode

Added in[API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)

# Mode

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/android/view/Display.Mode "View this page in Java")  

```
class Mode : Parcelable
```

|---|--------------------------------------------------------------------------------------------------------|
| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)                         ||
| ↳ | [android.view.Display.Mode](https://developer.android.com/reference/kotlin/android/view/Display.Mode#) |

A mode supported by a given display.

## Summary

| Inherited constants ||
|---|---|
| From class[Parcelable](https://developer.android.com/reference/kotlin/android/os/Parcelable.html#) |----------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [CONTENTS_FILE_DESCRIPTOR](https://developer.android.com/reference/kotlin/android/os/Parcelable.html#CONTENTS_FILE_DESCRIPTOR:kotlin.Int) <br /> Descriptor bit used with[describeContents()](https://developer.android.com/reference/kotlin/android/os/Parcelable.html#describeContents()): indicates that the Parcelable object's flattened representation includes a file descriptor. <br />                                                                                                                                                                                                        | | [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/kotlin/android/os/Parcelable.html#PARCELABLE_WRITE_RETURN_VALUE:kotlin.Int) <br /> Flag for use with[writeToParcel](https://developer.android.com/reference/kotlin/android/os/Parcelable.html#writeToParcel(android.os.Parcel,%20kotlin.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)`". Some implementations may want to release resources at this point. <br /> | ||

|                                                                                                                                                                                                              Public methods                                                                                                                                                                                                              ||
|-------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)                | [describeContents](https://developer.android.com/reference/kotlin/android/view/Display.Mode#describeContents())`()` <br />                                                                                                                                                                                                                    |
| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)        | [equals](https://developer.android.com/reference/kotlin/android/view/Display.Mode#equals(kotlin.Any))`(`other:` `[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)?`)` Indicates whether some other object is "equal to" this one.                                                                                   |
| [FloatArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float-array/index.html) | [getAlternativeRefreshRates](https://developer.android.com/reference/kotlin/android/view/Display.Mode#getAlternativeRefreshRates())`()` Returns an array of refresh rates which can be switched to seamlessly.                                                                                                                                |
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)                | [getModeId](https://developer.android.com/reference/kotlin/android/view/Display.Mode#getModeId())`()` Returns this mode's id.                                                                                                                                                                                                                 |
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)                | [getPhysicalHeight](https://developer.android.com/reference/kotlin/android/view/Display.Mode#getPhysicalHeight())`()` Returns the physical height of the display in pixels when configured in this mode's resolution.                                                                                                                         |
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)                | [getPhysicalWidth](https://developer.android.com/reference/kotlin/android/view/Display.Mode#getPhysicalWidth())`()` Returns the physical width of the display in pixels when configured in this mode's resolution.                                                                                                                            |
| [Float](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float/index.html)            | [getRefreshRate](https://developer.android.com/reference/kotlin/android/view/Display.Mode#getRefreshRate())`()` Returns the refresh rate in frames per second.                                                                                                                                                                                |
| [IntArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int-array/index.html)     | [getSupportedHdrTypes](https://developer.android.com/reference/kotlin/android/view/Display.Mode#getSupportedHdrTypes())`()` Returns the supported[HdrCapabilities](https://developer.android.com/reference/kotlin/android/view/Display.HdrCapabilities)HDR_TYPE_\* for this specific mode                                                     |
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)                | [hashCode](https://developer.android.com/reference/kotlin/android/view/Display.Mode#hashCode())`()` <br />                                                                                                                                                                                                                                    |
| [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)          | [toString](https://developer.android.com/reference/kotlin/android/view/Display.Mode#toString())`()` <br />                                                                                                                                                                                                                                    |
| [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)              | [writeToParcel](https://developer.android.com/reference/kotlin/android/view/Display.Mode#writeToParcel(android.os.Parcel,%20kotlin.Int))`(`out:` `[Parcel](https://developer.android.com/reference/kotlin/android/os/Parcel.html#)`, `parcelableFlags:` `[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`)` <br /> |

|                                                                                                                                                                   Properties                                                                                                                                                                   ||
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------|
| static[Parcelable.Creator](https://developer.android.com/reference/kotlin/android/os/Parcelable.Creator.html#)\<[Display.Mode](https://developer.android.com/reference/kotlin/android/view/Display.Mode#)!\> | [CREATOR](https://developer.android.com/reference/kotlin/android/view/Display.Mode#CREATOR:android.os.Parcelable.Creator) <br /> |

## Public methods

### describeContents

Added in[API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun describeContents(): Int
```

|                                                                                                                                                                               Return                                                                                                                                                                               ||
|----------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | 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](https://developer.android.com/reference/kotlin/android/os/Parcelable.html#CONTENTS_FILE_DESCRIPTOR:kotlin.Int) |

### equals

Added in[API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
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](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)?:This value may be`null`. |

|                                                                           Return                                                                           ||
|------------------------------------------------------------------------------------|------------------------------------------------------------------------|
| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | `true`if this object is the same as the obj argument;`false`otherwise. |

### getAlternativeRefreshRates

Added in[API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
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](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-float-array/index.html) | This value cannot be`null`. |

**See Also**

### getModeId

Added in[API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun getModeId(): Int
```

Returns this mode's id.  

### getPhysicalHeight

Added in[API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
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()](https://developer.android.com/reference/kotlin/android/view/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](https://developer.android.com/reference/kotlin/android/view/SurfaceView)using full size buffers.  

### getPhysicalWidth

Added in[API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
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()](https://developer.android.com/reference/kotlin/android/view/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](https://developer.android.com/reference/kotlin/android/view/SurfaceView)using full size buffers.  

### getRefreshRate

Added in[API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun getRefreshRate(): Float
```

Returns the refresh rate in frames per second.  

### getSupportedHdrTypes

Added in[API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun getSupportedHdrTypes(): IntArray
```

Returns the supported[HdrCapabilities](https://developer.android.com/reference/kotlin/android/view/Display.HdrCapabilities)HDR_TYPE_\* for this specific mode

|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     Return                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     ||
|---------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [IntArray](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int-array/index.html) | This value cannot be`null`. Value is[android.view.Display.HdrCapabilities#HDR_TYPE_INVALID](https://developer.android.com/reference/kotlin/android/view/Display.HdrCapabilities#HDR_TYPE_INVALID:kotlin.Int),[android.view.Display.HdrCapabilities#HDR_TYPE_DOLBY_VISION](https://developer.android.com/reference/kotlin/android/view/Display.HdrCapabilities#HDR_TYPE_DOLBY_VISION:kotlin.Int),[android.view.Display.HdrCapabilities#HDR_TYPE_HDR10](https://developer.android.com/reference/kotlin/android/view/Display.HdrCapabilities#HDR_TYPE_HDR10:kotlin.Int),[android.view.Display.HdrCapabilities#HDR_TYPE_HLG](https://developer.android.com/reference/kotlin/android/view/Display.HdrCapabilities#HDR_TYPE_HLG:kotlin.Int), or[android.view.Display.HdrCapabilities#HDR_TYPE_HDR10_PLUS](https://developer.android.com/reference/kotlin/android/view/Display.HdrCapabilities#HDR_TYPE_HDR10_PLUS:kotlin.Int) |

### hashCode

Added in[API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun hashCode(): Int
```

|                                                     Return                                                     ||
|----------------------------------------------------------------------------|------------------------------------|
| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | a hash code value for this object. |

### toString

Added in[API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
fun toString(): String
```

|                                                          Return                                                          ||
|----------------------------------------------------------------------------------|----------------------------------------|
| [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | a string representation of the object. |

### writeToParcel

Added in[API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
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](https://developer.android.com/reference/kotlin/android/os/Parcelable.html#PARCELABLE_WRITE_RETURN_VALUE:kotlin.Int). Value is either`0`or a combination of[android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/kotlin/android/os/Parcelable.html#PARCELABLE_WRITE_RETURN_VALUE:kotlin.Int), and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES |

## Properties

### CREATOR

Added in[API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)  

```
static val CREATOR: Parcelable.Creator<Display.Mode!>
```