Module technology.sola.engine

Package technology.sola.engine.graphics.screen

Enum Class AspectMode

java.lang.Object

java.lang.Enum<AspectMode>

technology.sola.engine.graphics.screen.AspectMode

All Implemented Interfaces:

Serializable, Comparable<AspectMode>, Constable

public enum AspectMode
extends Enum<AspectMode>

AspectMode specifies how rendered output will be scaled when the window resizes.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
IGNORE_RESIZING	Resizing the window will not cause a change in the rendered output.
MAINTAIN	Resizing the window will cause the rendered output to change while maintaining the original aspect ratio.
STRETCH	Resizing the window will cause the rendered output to stretch to fill the screen.

Method Summary

Modifier and Type	Method	Description
static AspectMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AspectMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

IGNORE_RESIZING

public static final AspectMode IGNORE_RESIZING

Resizing the window will not cause a change in the rendered output.

MAINTAIN

public static final AspectMode MAINTAIN

Resizing the window will cause the rendered output to change while maintaining the original aspect ratio.

STRETCH

public static final AspectMode STRETCH

Resizing the window will cause the rendered output to stretch to fill the screen.

Method Details

values

public static AspectMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static AspectMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null