Package android.util

Class DisplayMetrics


  • public class DisplayMetrics
    extends Object
    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);
    • Field Detail

      • DENSITY_LOW

        public static final int DENSITY_LOW
        Standard quantized DPI for low-density screens.
        See Also:
        Constant Field Values
      • DENSITY_MEDIUM

        public static final int DENSITY_MEDIUM
        Standard quantized DPI for medium-density screens.
        See Also:
        Constant Field Values
      • DENSITY_TV

        public static final 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 android.graphics.drawable.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.

        See Also:
        Constant Field Values
      • DENSITY_HIGH

        public static final int DENSITY_HIGH
        Standard quantized DPI for high-density screens.
        See Also:
        Constant Field Values
      • DENSITY_280

        public static final 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.
        See Also:
        Constant Field Values
      • DENSITY_XHIGH

        public static final int DENSITY_XHIGH
        Standard quantized DPI for extra-high-density screens.
        See Also:
        Constant Field Values
      • DENSITY_360

        public static final 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.
        See Also:
        Constant Field Values
      • DENSITY_400

        public static final 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.
        See Also:
        Constant Field Values
      • DENSITY_420

        public static final 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.
        See Also:
        Constant Field Values
      • DENSITY_XXHIGH

        public static final int DENSITY_XXHIGH
        Standard quantized DPI for extra-extra-high-density screens.
        See Also:
        Constant Field Values
      • DENSITY_560

        public static final 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.
        See Also:
        Constant Field Values
      • DENSITY_XXXHIGH

        public static final 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.
        See Also:
        Constant Field Values
      • DENSITY_DEFAULT

        public static final int DENSITY_DEFAULT
        The reference density used throughout the system.
        See Also:
        Constant Field Values
      • DENSITY_DEFAULT_SCALE

        public static final float DENSITY_DEFAULT_SCALE
        Scaling factor to convert a density in DPI units to the density scale.
        See Also:
        Constant Field Values
      • DENSITY_DEVICE

        @Deprecated
        public static int DENSITY_DEVICE
        Deprecated.
        There is no longer a static density; you can find the density for a display in densityDpi.
        The device's density.
      • widthPixels

        public int widthPixels
        The absolute width of the display in pixels.
      • heightPixels

        public int heightPixels
        The absolute height of the display in pixels.
      • density

        public 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:
        DENSITY_DEFAULT
      • scaledDensity

        public 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.
      • xdpi

        public float xdpi
        The exact physical pixels per inch of the screen in the X dimension.
      • ydpi

        public float ydpi
        The exact physical pixels per inch of the screen in the Y dimension.
      • noncompatWidthPixels

        public int noncompatWidthPixels
        The reported display width prior to any compatibility mode scaling being applied.
      • noncompatHeightPixels

        public int noncompatHeightPixels
        The reported display height prior to any compatibility mode scaling being applied.
      • noncompatDensity

        public float noncompatDensity
        The reported display density prior to any compatibility mode scaling being applied.
      • noncompatDensityDpi

        public int noncompatDensityDpi
        The reported display density prior to any compatibility mode scaling being applied.
      • noncompatScaledDensity

        public float noncompatScaledDensity
        The reported scaled density prior to any compatibility mode scaling being applied.
      • noncompatXdpi

        public float noncompatXdpi
        The reported display xdpi prior to any compatibility mode scaling being applied.
      • noncompatYdpi

        public float noncompatYdpi
        The reported display ydpi prior to any compatibility mode scaling being applied.
    • Constructor Detail

      • DisplayMetrics

        public DisplayMetrics()
    • Method Detail

      • setToDefaults

        public void setToDefaults()
      • equals

        public boolean equals​(Object o)
        Description copied from class: Object
        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 Object.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.

        Overrides:
        equals in class Object
        Parameters:
        o - the object to compare this instance with.
        Returns:
        true if the specified object is equal to this Object; false otherwise.
        See Also:
        Object.hashCode()
      • equals

        public boolean equals​(DisplayMetrics other)
        Returns true if these display metrics equal the other display metrics.
        Parameters:
        other - The display metrics with which to compare.
        Returns:
        True if the display metrics are equal.
      • equalsPhysical

        public boolean equalsPhysical​(DisplayMetrics other)
        Returns true if the physical aspects of the two display metrics are equal. This ignores the scaled density, which is a logical attribute based on the current desired font size.
        Parameters:
        other - The display metrics with which to compare.
        Returns:
        True if the display metrics are equal.
      • hashCode

        public int hashCode()
        Description copied from class: Object
        Returns an integer hash code for this object. By contract, any two objects for which Object.equals(java.lang.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.

        Overrides:
        hashCode in class Object
        Returns:
        this object's hash code.
        See Also:
        Object.equals(java.lang.Object)
      • toString

        public String toString()
        Description copied from class: Object
        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.

        Overrides:
        toString in class Object
        Returns:
        a printable representation of this object.