Most visited

Recently visited

Added in API level 1

DisplayMetrics

public class DisplayMetrics
extends Object

java.lang.Object
   ↳ android.util.DisplayMetrics


A structure describing general information about a display, such as its size, density, and font scaling.

To access the DisplayMetrics members, initialize an object like this:

 DisplayMetrics metrics = new DisplayMetrics();
 getWindowManager().getDefaultDisplay().getMetrics(metrics);

Summary

Constants

int DENSITY_280

Intermediate density for screens that sit between DENSITY_HIGH (240dpi) and DENSITY_XHIGH (320dpi).

int DENSITY_360

Intermediate density for screens that sit somewhere between DENSITY_XHIGH (320 dpi) and DENSITY_XXHIGH (480 dpi).

int DENSITY_400

Intermediate density for screens that sit somewhere between DENSITY_XHIGH (320 dpi) and DENSITY_XXHIGH (480 dpi).

int DENSITY_420

Intermediate density for screens that sit somewhere between DENSITY_XHIGH (320 dpi) and DENSITY_XXHIGH (480 dpi).

int DENSITY_560

Intermediate density for screens that sit somewhere between DENSITY_XXHIGH (480 dpi) and DENSITY_XXXHIGH (640 dpi).

int DENSITY_DEFAULT

The reference density used throughout the system.

int DENSITY_HIGH

Standard quantized DPI for high-density screens.

int DENSITY_LOW

Standard quantized DPI for low-density screens.

int DENSITY_MEDIUM

Standard quantized DPI for medium-density screens.

int DENSITY_TV

This is a secondary density, added for some common screen configurations.

int DENSITY_XHIGH

Standard quantized DPI for extra-high-density screens.

int DENSITY_XXHIGH

Standard quantized DPI for extra-extra-high-density screens.

int DENSITY_XXXHIGH

Standard quantized DPI for extra-extra-extra-high-density screens.

Fields

public static final int DENSITY_DEVICE_STABLE

The device's stable density.

public float density

The logical density of the display.

public int densityDpi

The screen density expressed as dots-per-inch.

public int heightPixels

The absolute height of the available display size in pixels.

public float scaledDensity

A scaling factor for fonts displayed on the display.

public int widthPixels

The absolute width of the available display size in pixels.

public float xdpi

The exact physical pixels per inch of the screen in the X dimension.

public float ydpi

The exact physical pixels per inch of the screen in the Y dimension.

Public constructors

DisplayMetrics()

Public methods

boolean equals(Object o)

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

boolean equals(DisplayMetrics other)

Returns true if these display metrics equal the other display metrics.

int hashCode()

Returns a hash code value for the object.

void setTo(DisplayMetrics o)
void setToDefaults()
String toString()

Returns a string representation of the object.

Inherited methods

From class java.lang.Object

Constants

DENSITY_280

Added in API level 22
int DENSITY_280

Intermediate density for screens that sit between DENSITY_HIGH (240dpi) and DENSITY_XHIGH (320dpi). This is not a density that applications should target, instead relying on the system to scale their DENSITY_XHIGH assets for them.

Constant Value: 280 (0x00000118)

DENSITY_360

Added in API level 23
int DENSITY_360

Intermediate density for screens that sit somewhere between DENSITY_XHIGH (320 dpi) and DENSITY_XXHIGH (480 dpi). This is not a density that applications should target, instead relying on the system to scale their DENSITY_XXHIGH assets for them.

Constant Value: 360 (0x00000168)

DENSITY_400

Added in API level 19
int DENSITY_400

Intermediate density for screens that sit somewhere between DENSITY_XHIGH (320 dpi) and DENSITY_XXHIGH (480 dpi). This is not a density that applications should target, instead relying on the system to scale their DENSITY_XXHIGH assets for them.

Constant Value: 400 (0x00000190)

DENSITY_420

Added in API level 23
int DENSITY_420

Intermediate density for screens that sit somewhere between DENSITY_XHIGH (320 dpi) and DENSITY_XXHIGH (480 dpi). This is not a density that applications should target, instead relying on the system to scale their DENSITY_XXHIGH assets for them.

Constant Value: 420 (0x000001a4)

DENSITY_560

Added in API level 21
int DENSITY_560

Intermediate density for screens that sit somewhere between DENSITY_XXHIGH (480 dpi) and DENSITY_XXXHIGH (640 dpi). This is not a density that applications should target, instead relying on the system to scale their DENSITY_XXXHIGH assets for them.

Constant Value: 560 (0x00000230)

DENSITY_DEFAULT

Added in API level 4
int DENSITY_DEFAULT

The reference density used throughout the system.

Constant Value: 160 (0x000000a0)

DENSITY_HIGH

Added in API level 4
int DENSITY_HIGH

Standard quantized DPI for high-density screens.

Constant Value: 240 (0x000000f0)

DENSITY_LOW

Added in API level 4
int DENSITY_LOW

Standard quantized DPI for low-density screens.

Constant Value: 120 (0x00000078)

DENSITY_MEDIUM

Added in API level 4
int DENSITY_MEDIUM

Standard quantized DPI for medium-density screens.

Constant Value: 160 (0x000000a0)

DENSITY_TV

Added in API level 13
int DENSITY_TV

This is a secondary density, added for some common screen configurations. It is recommended that applications not generally target this as a first class density -- that is, don't supply specific graphics for this density, instead allow the platform to scale from other densities (typically DENSITY_HIGH) as appropriate. In most cases (such as using bitmaps in Drawable) the platform can perform this scaling at load time, so the only cost is some slight startup runtime overhead.

This density was original introduced to correspond with a 720p TV screen: the density for 1080p televisions is DENSITY_XHIGH, and the value here provides the same UI size for a TV running at 720p. It has also found use in 7" tablets, when these devices have 1280x720 displays.

Constant Value: 213 (0x000000d5)

DENSITY_XHIGH

Added in API level 9
int DENSITY_XHIGH

Standard quantized DPI for extra-high-density screens.

Constant Value: 320 (0x00000140)

DENSITY_XXHIGH

Added in API level 16
int DENSITY_XXHIGH

Standard quantized DPI for extra-extra-high-density screens.

Constant Value: 480 (0x000001e0)

DENSITY_XXXHIGH

Added in API level 18
int DENSITY_XXXHIGH

Standard quantized DPI for extra-extra-extra-high-density screens. Applications should not generally worry about this density; relying on XHIGH graphics being scaled up to it should be sufficient for almost all cases. A typical use of this density would be 4K television screens -- 3840x2160, which is 2x a traditional HD 1920x1080 screen which runs at DENSITY_XHIGH.

Constant Value: 640 (0x00000280)

Fields

DENSITY_DEVICE_STABLE

Added in API level 24
int DENSITY_DEVICE_STABLE

The device's stable density.

This value is constant at run time and may not reflect the current display density. To obtain the current density for a specific display, use densityDpi.

density

Added in API level 1
float density

The logical density of the display. This is a scaling factor for the Density Independent Pixel unit, where one DIP is one pixel on an approximately 160 dpi screen (for example a 240x320, 1.5"x2" screen), providing the baseline of the system's display. Thus on a 160dpi screen this density value will be 1; on a 120 dpi screen it would be .75; etc.

This value does not exactly follow the real screen size (as given by xdpi and ydpi, but rather is used to scale the size of the overall UI in steps based on gross changes in the display dpi. For example, a 240x320 screen will have a density of 1 even if its width is 1.8", 1.3", etc. However, if the screen resolution is increased to 320x480 but the screen size remained 1.5"x2" then the density would be increased (probably to 1.5).

See also:

densityDpi

Added in API level 4
int densityDpi

The screen density expressed as dots-per-inch. May be either DENSITY_LOW, DENSITY_MEDIUM, or DENSITY_HIGH.

heightPixels

Added in API level 1
int heightPixels

The absolute height of the available display size in pixels.

scaledDensity

Added in API level 1
float scaledDensity

A scaling factor for fonts displayed on the display. This is the same as density, except that it may be adjusted in smaller increments at runtime based on a user preference for the font size.

widthPixels

Added in API level 1
int widthPixels

The absolute width of the available display size in pixels.

xdpi

Added in API level 1
float xdpi

The exact physical pixels per inch of the screen in the X dimension.

ydpi

Added in API level 1
float ydpi

The exact physical pixels per inch of the screen in the Y dimension.

Public constructors

DisplayMetrics

Added in API level 1
DisplayMetrics ()

Public methods

equals

Added in API level 1
boolean equals (Object o)

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.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Parameters
o Object: the reference object with which to compare.
Returns
boolean true if this object is the same as the obj argument; false otherwise.

equals

Added in API level 17
boolean equals (DisplayMetrics other)

Returns true if these display metrics equal the other display metrics.

Parameters
other DisplayMetrics: The display metrics with which to compare.
Returns
boolean True if the display metrics are equal.

hashCode

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

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(Object) 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(java.lang.Object) 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.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the JavaTM programming language.)

Returns
int a hash code value for this object.

setTo

Added in API level 1
void setTo (DisplayMetrics o)

Parameters
o DisplayMetrics

setToDefaults

Added in API level 1
void setToDefaults ()

toString

Added in API level 1
String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

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

Returns
String a string representation of the object.

Hooray!