org.jsfml.window

Class VideoMode

java.lang.Object

org.jsfml.window.VideoMode

All Implemented Interfaces:

Serializable

public final class VideoMode
extends Object
implements Serializable

Represents a video mode (width, height and bits per pixel).

It defines the width, height and pixel depth of a window and must be supported by the monitor hardware in order to be used in fullscreen.

See Also:

Window.create(VideoMode, String, int), Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
int	bitsPerPixel The pixel depth, in bits per pixel, of the video mode.
int	height The height of the video mode, in pixels.
int	width The width of the video mode, in pixels.

Constructor Summary

Constructors

Constructor and Description
VideoMode(int width, int height) Constructs a new video mode with a pixel depth of 32 bits per pixel.
VideoMode(int width, int height, int bitsPerPixel) Constructs a new video mode.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
static VideoMode	getDesktopMode() Retrieves the desktop's current video mode / screen resolution.
static VideoMode[]	getFullscreenModes() Retrieves the list of supported fullscreen video modes.
int	hashCode()
boolean	isValid() Checks whether this display mode is a valid fullscreen mode, ie whether the current monitor supports it for fullscreen.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

width

public final int width

The width of the video mode, in pixels.

height

public final int height

The height of the video mode, in pixels.

bitsPerPixel

public final int bitsPerPixel

The pixel depth, in bits per pixel, of the video mode.

Constructor Detail

VideoMode

public VideoMode(int width,
         int height,
         int bitsPerPixel)

Constructs a new video mode.

Parameters:

width - the width, in pixels.

height - the height, in pixels.

bitsPerPixel - the pixel depth, in bits per pixel.

VideoMode

public VideoMode(int width,
         int height)

Constructs a new video mode with a pixel depth of 32 bits per pixel.

Parameters:

width - the width, in pixels.

height - the height, in pixels.

Method Detail

getDesktopMode

public static VideoMode getDesktopMode()

Retrieves the desktop's current video mode / screen resolution.

Returns:

the desktop's current video mode.

getFullscreenModes

public static VideoMode[] getFullscreenModes()

Retrieves the list of supported fullscreen video modes.

Returns:

the list of supported fullscreen video modes.

isValid

public boolean isValid()

Checks whether this display mode is a valid fullscreen mode, ie whether the current monitor supports it for fullscreen.

Returns:

true if this video mode is a valid fullscreen mode, false otherwise.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object