APIdia Launch Partner
Top Description Fields Constructors Methods
java.awt

public final Class DisplayMode

extends Object
Class Inheritance
Imports
java.lang.annotation.Native
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.

Author
Michael Martak
Since
1.4
See Also
GraphicsDevice, GraphicsDevice#isDisplayChangeSupported, GraphicsDevice#getDisplayModes, GraphicsDevice#setDisplayMode

Field Summary

Modifier and TypeField and Description
public static final int
BIT_DEPTH_MULTI

Value of the bit depth if multiple bit depths are supported in this display mode.

private int
bitDepth

public static final int
REFRESH_RATE_UNKNOWN

Value of the refresh rate if not known.

private int
refreshRate

private Dimension
size

Constructor Summary

AccessConstructor and Description
public
DisplayMode(int
the width of the display, in pixels
width, int
the height of the display, in pixels
height, int
the bit depth of the display, in bits per pixel. This can be BIT_DEPTH_MULTI if multiple bit depths are available.
bitDepth, int
the refresh rate of the display, in hertz. This can be REFRESH_RATE_UNKNOWN if the information is not available.
refreshRate)

Create a new display mode object with the supplied parameters.

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

whether the two display modes are equal
equals(DisplayMode
the display mode to compare to
dm)

Returns whether the two display modes are equal.

public boolean
equals(Object dm)

Overrides java.lang.Object.equals.

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

public int

Returns:

the bit depth of the display, in bits per pixel.
getBitDepth()

Returns the bit depth of the display, in bits per pixel.

public int

Returns:

the height of the display, in pixels
getHeight()

Returns the height of the display, in pixels.

public int

Returns:

the refresh rate of the display, in hertz.
getRefreshRate()

Returns the refresh rate of the display, in hertz.

public int

Returns:

the width of the display, in pixels
getWidth()

Returns the width of the display, in pixels.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

BIT_DEPTH_MULTIback to summary
public static final int BIT_DEPTH_MULTI

Value of the bit depth if multiple bit depths are supported in this display mode.

Annotations
@Native
See Also
getBitDepth
bitDepthback to summary
private int bitDepth
REFRESH_RATE_UNKNOWNback to summary
public static final int REFRESH_RATE_UNKNOWN

Value of the refresh rate if not known.

Annotations
@Native
See Also
getRefreshRate
refreshRateback to summary
private int refreshRate
sizeback to summary
private Dimension size

Constructor Detail

DisplayModeback to summary
public DisplayMode(int width, int height, int bitDepth, int refreshRate)

Create a new display mode object with the supplied parameters.

Parameters
width:int

the width of the display, in pixels

height:int

the height of the display, in pixels

bitDepth:int

the bit depth of the display, in bits per pixel. This can be BIT_DEPTH_MULTI if multiple bit depths are available.

refreshRate:int

the refresh rate of the display, in hertz. This can be REFRESH_RATE_UNKNOWN if the information is not available.

See Also
BIT_DEPTH_MULTI, REFRESH_RATE_UNKNOWN

Method Detail

equalsback to summary
public boolean equals(DisplayMode dm)

Returns whether the two display modes are equal.

Parameters
dm:DisplayMode

the display mode to compare to

Returns:boolean

whether the two display modes are equal

equalsback to summary
public boolean equals(Object dm)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

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.

Annotations
@Override
getBitDepthback to summary
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:int

the bit depth of the display, in bits per pixel.

See Also
BIT_DEPTH_MULTI
getHeightback to summary
public int getHeight()

Returns the height of the display, in pixels.

Returns:int

the height of the display, in pixels

getRefreshRateback to summary
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:int

the refresh rate of the display, in hertz.

See Also
REFRESH_RATE_UNKNOWN
getWidthback to summary
public int getWidth()

Returns the width of the display, in pixels.

Returns:int

the width of the display, in pixels

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by 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 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.
Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations
@Override