Class Resolution

public class Resolution

Represents the resolution of the game window consisting of the width and height and information about the ratio.

This class also provides access to predefined known resolutions of the different aspect ratios which can be used to set the resolution of the GameWindow.

• Resolution.Ratio4x3
• Resolution.Ratio5x4
• Resolution.Ratio16x9
• Resolution.Ratio16x10

See Also:

• GameWindow.setResolution(Resolution)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Resolution.Ratio	Describes an aspect ratio used to categorize Resolution instances.
static class	Resolution.Ratio16x10	Contains predefined Resolutions with an aspect ratio of 16:10.
static class	Resolution.Ratio16x9	Contains predefined Resolutions with an aspect ratio of 16:9.
static class	Resolution.Ratio4x3	Contains predefined Resolutions with an aspect ratio of 4:3.
static class	Resolution.Ratio5x4	Contains predefined Resolutions with an aspect ratio of 5:4.

Method Summary

Modifier and Type	Method	Description
static Resolution	custom(int width, int height, String resolutionName)	Creates a custom Resolution with the given dimensions and ratio name.
Dimension	getDimension()	Gets the dimension of this resolution consisting of it's width and height.
int	getHeight()	Gets the height of this resolution.
Resolution.Ratio	getRatio()	Gets the aspect ratio of this resolution.
int	getWidth()	Gets the width of this resolution.
String	toDimensionString()	Returns the resolution dimensions as a string using "x" as the delimiter (e.g. "1920x1080").
String	toDimensionString(String delimiter)	Returns the resolution dimensions as a string using the provided delimiter.
String	toString()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

custom

public static Resolution custom(int width,
 int height,
 String resolutionName)

Creates a custom Resolution with the given dimensions and ratio name.

Parameters:

width - the resolution width in pixels

height - the resolution height in pixels

resolutionName - the display name of the ratio

Returns:

a new custom resolution

getHeight

public int getHeight()

Gets the height of this resolution.

Returns:

The height of the resolution.

getWidth

public int getWidth()

Gets the width of this resolution.

Returns:

The width of the resolution.

getDimension

public Dimension getDimension()

Gets the dimension of this resolution consisting of it's width and height.

Returns:

The dimension of the resolution.

toDimensionString

public String toDimensionString()

Returns the resolution dimensions as a string using "x" as the delimiter (e.g. "1920x1080").

Returns:

the dimension string

toDimensionString

public String toDimensionString(String delimiter)

Returns the resolution dimensions as a string using the provided delimiter.

Parameters:

delimiter - the delimiter to place between width and height

Returns:

the dimension string

toString

public String toString()

Overrides:

toString in class Object

getRatio

public Resolution.Ratio getRatio()

Gets the aspect ratio of this resolution.

Returns:

The aspect ratio of this resolution.

classguiapijava