Class DisplayMode

java.lang.Object
java.awt.DisplayMode
public final class DisplayMode extends Object
The DisplayMode class encapsulates the bit depth, height, width, and refresh rate of a GraphicsDevice. The ability to change graphics device's display mode is platform- and configuration-dependent and may not always be available (see GraphicsDevice.isDisplayChangeSupported()).

For more information on full-screen exclusive mode API, see the Full-Screen Exclusive Mode API Tutorial.

Since:
1.4
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    BIT_DEPTH_MULTI
    Value of the bit depth if multiple bit depths are supported in this display mode.
    static final int
    REFRESH_RATE_UNKNOWN
    Value of the refresh rate if not known.

  • Constructor Summary

    Constructors
    Constructor
    Description
    DisplayMode(int width, int height, int bitDepth, int refreshRate)
    Create a new display mode object with the supplied parameters.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(DisplayMode dm)
    Returns whether the two display modes are equal.
    boolean
    equals(Object dm)
    Indicates whether some other object is "equal to" this one.
    int
    getBitDepth()
    Returns the bit depth of the display, in bits per pixel.
    int
    getHeight()
    Returns the height of the display, in pixels.
    int
    getRefreshRate()
    Returns the refresh rate of the display, in hertz.
    int
    getWidth()
    Returns the width of the display, in pixels.
    int
    hashCode()
    Returns a hash code value for this object.
    String
    toString()
    Returns a string representation of the object.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

  • Constructor Details

    • DisplayMode

      public DisplayMode(int width, int height, int bitDepth, int refreshRate)
      Create a new display mode object with the supplied parameters.
      Parameters:
      width - the width of the display, in pixels
      height - the height of the display, in pixels
      bitDepth - the bit depth of the display, in bits per pixel. This can be BIT_DEPTH_MULTI if multiple bit depths are available.
      refreshRate - the refresh rate of the display, in hertz. This can be REFRESH_RATE_UNKNOWN if the information is not available.
      See Also:

  • Method Details

    • getHeight

      public int getHeight()
      Returns the height of the display, in pixels.
      Returns:
      the height of the display, in pixels

    • getWidth

      public int getWidth()
      Returns the width of the display, in pixels.
      Returns:
      the width of the display, in pixels

    • getBitDepth

      public int getBitDepth()
      Returns the bit depth of the display, in bits per pixel. This may be BIT_DEPTH_MULTI if multiple bit depths are supported in this display mode.
      Returns:
      the bit depth of the display, in bits per pixel.
      See Also:

    • getRefreshRate

      public int getRefreshRate()
      Returns the refresh rate of the display, in hertz. This may be REFRESH_RATE_UNKNOWN if the information is not available.
      Returns:
      the refresh rate of the display, in hertz.
      See Also:

    • equals

      public boolean equals(DisplayMode dm)
      Returns whether the two display modes are equal.
      Parameters:
      dm - the display mode to compare to
      Returns:
      whether the two display modes are equal

    • equals

      public boolean equals(Object dm)
      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.

      Overrides:
      equals in class Object
      Parameters:
      dm - the reference object with which to compare.
      Returns:
      true if this object is the same as the obj argument; false otherwise.
      See Also:

    • hashCode

      public int hashCode()
      Returns a hash code value for this 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 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 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.
      Overrides:
      hashCode in class Object
      Returns:
      a hash code value for this object
      See Also:

    • toString

      public String toString()
      Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.
      Overrides:
      toString in class Object
      Returns:
      a string representation of the object