Display.Mode  |  API reference  |  Android Developers (original) (raw)

public static final class Display.Mode
extends [Object](/reference/java/lang/Object) implements[Parcelable](/reference/android/os/Parcelable)

A mode supported by a given display.

Summary

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(Parcel,int)](/reference/android/os/Parcelable#writeToParcel%28android.os.Parcel,%20int%29), the return value of this method must include the[CONTENTS_FILE_DESCRIPTOR](/reference/android/os/Parcelable#CONTENTS%5FFILE%5FDESCRIPTOR) bit.

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 valuex, x.equals(x) should returntrue.
• It is symmetric: for any non-null reference valuesx and y, x.equals(y) should return true if and only ify.equals(x) returns true.
• It is transitive: for any non-null reference valuesx, y, and z, ifx.equals(y) returns true andy.equals(z) returns true, thenx.equals(z) should return true.
• It is consistent: for any non-null reference valuesx and y, multiple invocations ofx.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.

getAlternativeRefreshRates

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.

getModeId

public int getModeId ()

Returns this mode's id.

getPhysicalHeight

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()](/reference/android/view/Display#getHeight%28%29) 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](/reference/android/view/SurfaceView) using full size buffers.

getPhysicalWidth

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()](/reference/android/view/Display#getWidth%28%29) 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](/reference/android/view/SurfaceView) using full size buffers.

getRefreshRate

public float getRefreshRate ()

Returns the refresh rate in frames per second.

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](/reference/java/util/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](/reference/java/lang/Object#equals%28java.lang.Object%29) 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](/reference/java/lang/Object#equals%28java.lang.Object%29) 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.

toString

public String toString ()

Returns a string representation of the object.

writeToParcel

public void writeToParcel (Parcel out, int parcelableFlags)

Flatten this object in to a Parcel.