Top Description Fields Constructors Methods
org.lwjgl.opengl

public final Class DisplayMode

extends Object
Class Inheritance
This class encapsulates the properties for a given display mode. This class is not instantiable, and is aquired from the Display. getAvailableDisplayModes() method.
Author
cix_foo
Version
$Revision$ $Id$

Field Summary

Modifier and TypeField and Description
private final int
bpp

properties of the display mode

private final int
freq

properties of the display mode

private final boolean
fullscreen

If true, this instance can be used for fullscreen modes

private final int
height

properties of the display mode

private final int
width

properties of the display mode

Constructor Summary

AccessConstructor and Description
public
DisplayMode(int
The Display width.
width, int
The Display height.
height)

Construct a display mode.

pack-priv
DisplayMode(int width, int height, int bpp, int freq)

private
DisplayMode(int width, int height, int bpp, int freq, boolean fullscreen)

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
obj)

Overrides java.lang.Object.equals.

Tests for DisplayMode equality
public int
getBitsPerPixel()

public int
getFrequency()

public int
getHeight()

public int
getWidth()

public int
hashCode()

Overrides java.lang.Object.hashCode.

Retrieves the hashcode for this object
public boolean
isFullscreenCapable()

True if this instance can be used for fullscreen modes

public String
toString()

Overrides java.lang.Object.toString.

Retrieves a String representation of this DisplayMode
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

bppback to summary
private final int bpp

properties of the display mode

freqback to summary
private final int freq

properties of the display mode

fullscreenback to summary
private final boolean fullscreen

If true, this instance can be used for fullscreen modes

heightback to summary
private final int height

properties of the display mode

widthback to summary
private final int width

properties of the display mode

Constructor Detail

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

Construct a display mode. DisplayModes constructed through the public constructor can only be used to specify the dimensions of the Display in windowed mode. To get the available DisplayModes for fullscreen modes, use Display.getAvailableDisplayModes().

Parameters
width:int

The Display width.

height:int

The Display height.

See Also
Display
DisplayModeback to summary
pack-priv DisplayMode(int width, int height, int bpp, int freq)
DisplayModeback to summary
private DisplayMode(int width, int height, int bpp, int freq, boolean fullscreen)

Method Detail

equalsback to summary
public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Tests for DisplayMode equality

Parameters
obj:Object

Doc from java.lang.Object.equals.

the reference object with which to compare.

Returns:boolean

Doc from java.lang.Object.equals.

true if this object is the same as the obj argument; false otherwise.

See Also
java.lang.Object#equals(Object)
getBitsPerPixelback to summary
public int getBitsPerPixel()
getFrequencyback to summary
public int getFrequency()
getHeightback to summary
public int getHeight()
getWidthback to summary
public int getWidth()
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Retrieves the hashcode for this object

Returns:int

Doc from java.lang.Object.hashCode.

a hash code value for this object

See Also
java.lang.Object#hashCode()
isFullscreenCapableback to summary
public boolean isFullscreenCapable()

True if this instance can be used for fullscreen modes

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Retrieves a String representation of this DisplayMode

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object

See Also
java.lang.Object#toString()