Android APIs
public static final class

Display.Mode

extends Object
implements Parcelable
java.lang.Object
   ↳ android.view.Display.Mode

Class Overview

A mode supported by a given display.

Summary

[Expand]
Inherited Constants
From interface android.os.Parcelable
Fields
public static final Creator<Display.Mode> CREATOR
Public Methods
int describeContents()
Describe the kinds of special objects contained in this Parcelable's marshalled representation.
boolean equals(Object other)
Compares this instance with the specified object and indicates if they are equal.
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()
Returns an integer hash code for this object.
String toString()
Returns a string containing a concise, human-readable description of this object.
void writeToParcel(Parcel out, int parcelableFlags)
Flatten this object in to a Parcel.
[Expand]
Inherited Methods
From class java.lang.Object
From interface android.os.Parcelable

Fields

public static final Creator<Display.Mode> CREATOR

Added in API level 23

Public Methods

public int describeContents ()

Added in API level 23

Describe the kinds of special objects contained in this Parcelable's marshalled representation.

Returns
  • a bitmask indicating the set of special object types marshalled by the Parcelable.

public boolean equals (Object other)

Added in API level 23

Compares this instance with the specified object and indicates if they are equal. In order to be equal, o must represent the same object as this instance using a class-specific comparison. The general contract is that this comparison should be reflexive, symmetric, and transitive. Also, no object reference other than null is equal to null.

The default implementation returns true only if this == o. See Writing a correct equals method if you intend implementing your own equals method.

The general contract for the equals and hashCode() methods is that if equals returns true for any two objects, then hashCode() must return the same value for these objects. This means that subclasses of Object usually override either both methods or neither of them.

Parameters
other the object to compare this instance with.
Returns
  • true if the specified object is equal to this Object; false otherwise.

public int getModeId ()

Added in API level 23

Returns this mode's id.

public int getPhysicalHeight ()

Added in API level 23

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

public int getPhysicalWidth ()

Added in API level 23

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

public float getRefreshRate ()

Added in API level 23

Returns the refresh rate in frames per second.

public int hashCode ()

Added in API level 23

Returns an integer hash code for this object. By contract, any two objects for which equals(Object) returns true must return the same hash code value. This means that subclasses of Object usually override both methods or neither method.

Note that hash values must not change over time unless information used in equals comparisons also changes.

See Writing a correct hashCode method if you intend implementing your own hashCode method.

Returns
  • this object's hash code.

public String toString ()

Added in API level 23

Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression:

   getClass().getName() + '@' + Integer.toHexString(hashCode())

See Writing a useful toString method if you intend implementing your own toString method.

Returns
  • a printable representation of this object.

public void writeToParcel (Parcel out, int parcelableFlags)

Added in API level 23

Flatten this object in to a Parcel.

Parameters
out The Parcel in which the object should be written.
parcelableFlags Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.