Record Class StencilPerFaceTest

java.lang.Object

java.lang.Record

net.neoforged.neoforge.client.stencil.StencilPerFaceTest

Record Components:

fail - The operation to apply to the stencil buffer when the fragment fails the stencil test.

depthFail - The operation to apply to the stencil buffer when the fragment fails the depth test.

pass - The operation to apply to the stencil buffer when the fragment passes both the stencil and depth test.

compare - The comparison operator to use for determining whether the fragment passes the stencil test.

public record StencilPerFaceTest(StencilOperation fail, StencilOperation depthFail, StencilOperation pass, StencilFunction compare)
extends Record

Describes the stencil test and writing state for the front or back face.

Field Summary

Fields

Modifier and Type	Field	Description
private final StencilFunction	compare	The field for the compare record component.
private final StencilOperation	depthFail	The field for the depthFail record component.
private final StencilOperation	fail	The field for the fail record component.
private final StencilOperation	pass	The field for the pass record component.

Constructor Summary

Constructors

Constructor	Description
StencilPerFaceTest(StencilOperation fail, StencilOperation depthFail, StencilOperation pass, StencilFunction compare)	Creates an instance of a StencilPerFaceTest record class.

Method Summary

Modifier and Type	Method	Description
StencilFunction	compare()	Returns the value of the compare record component.
StencilOperation	depthFail()	Returns the value of the depthFail record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
StencilOperation	fail()	Returns the value of the fail record component.
final int	hashCode()	Returns a hash code value for this object.
StencilOperation	pass()	Returns the value of the pass record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Field Details

fail

private final StencilOperation fail

The field for the fail record component.

depthFail

private final StencilOperation depthFail

The field for the depthFail record component.

pass

private final StencilOperation pass

The field for the pass record component.

compare

private final StencilFunction compare

The field for the compare record component.

Constructor Details

StencilPerFaceTest

public StencilPerFaceTest(StencilOperation fail,
 StencilOperation depthFail,
 StencilOperation pass,
 StencilFunction compare)

Creates an instance of a StencilPerFaceTest record class.

Parameters:

fail - the value for the fail record component

depthFail - the value for the depthFail record component

pass - the value for the pass record component

compare - the value for the compare record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

fail

public StencilOperation fail()

Returns the value of the fail record component.

Returns:

the value of the fail record component

depthFail

public StencilOperation depthFail()

Returns the value of the depthFail record component.

Returns:

the value of the depthFail record component

pass

public StencilOperation pass()

Returns the value of the pass record component.

Returns:

the value of the pass record component

compare

public StencilFunction compare()

Returns the value of the compare record component.

Returns:

the value of the compare record component