Package net.neoforged.neoforge.client.stencil

Enum Class StencilFunction

java.lang.Object

java.lang.Enum<StencilFunction>

net.neoforged.neoforge.client.stencil.StencilFunction

All Implemented Interfaces:

Serializable, Comparable<StencilFunction>, Constable

public enum StencilFunction
extends Enum<StencilFunction>

The available comparison functions that are used for comparing the stencil reference value to the current stencil buffer value when determining if a fragment passes the stencil test.

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
ALWAYS
EQUAL
GEQUAL
GREATER
LEQUAL
LESS
NEVER
NOTEQUAL

Constructor Summary

Constructors

Modifier	Constructor	Description
private	StencilFunction()

Method Summary

Modifier and Type	Method	Description
static StencilFunction	valueOf(String name)	Returns the enum constant of this class with the specified name.
static StencilFunction[]	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

NEVER

public static final StencilFunction NEVER

ALWAYS

public static final StencilFunction ALWAYS

LESS

public static final StencilFunction LESS

LEQUAL

public static final StencilFunction LEQUAL

EQUAL

public static final StencilFunction EQUAL

GEQUAL

public static final StencilFunction GEQUAL

GREATER

public static final StencilFunction GREATER

NOTEQUAL

public static final StencilFunction NOTEQUAL

Constructor Details

StencilFunction

private StencilFunction()

Method Details

values

public static StencilFunction[] 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 StencilFunction 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