agi.foundation.graphics.advanced

(agi.foundation.graphics-2024r3.jar)

Enum RefreshRate

java.lang.Object

java.lang.Enum<RefreshRate>

agi.foundation.graphics.advanced.RefreshRate

All Implemented Interfaces:

Enumeration, Serializable, Comparable<RefreshRate>

public enum RefreshRate
extends Enum<RefreshRate>
implements Enumeration

The rate at which animation frames will occur.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FASTEST The animation will occur as fast as possible.
TARGETED_FRAMES_PER_SECOND The animation will target a specified frame rate.

Method Summary

Modifier and Type	Method and Description
static RefreshRate	getDefault() Get the enum constant that is considered to be the default.
static RefreshRate	getFromValue(int value) Get the enum constant that is associated with the given numeric value.
int	getValue() Get the numeric value associated with this enum constant.
static RefreshRate	valueOf(String name) Returns the enum constant of this type with the specified name.
static RefreshRate[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FASTEST

public static final RefreshRate FASTEST

The animation will occur as fast as possible. The maximum frame rate is the refresh rate of the display or is the maximum that video card is capable of if the video card's vertical sync is off.

TARGETED_FRAMES_PER_SECOND

public static final RefreshRate TARGETED_FRAMES_PER_SECOND

The animation will target a specified frame rate.

Method Detail

values

public static RefreshRate[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (RefreshRate c : RefreshRate.values())
    System.out.println(c);

Returns:

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

valueOf

public static RefreshRate valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

getValue

public int getValue()

Get the numeric value associated with this enum constant.

Specified by:

getValue in interface Enumeration

Returns:

A numeric value.

getFromValue

@Nonnull
public static RefreshRate getFromValue(int value)

Get the enum constant that is associated with the given numeric value.

Parameters:

value - a numeric value.

Returns:

The enum constant associated with value.

getDefault

@Nonnull
public static RefreshRate getDefault()

Get the enum constant that is considered to be the default.

Returns:

The default enum constant.