Package foundry.veil.api.client.render.shader

Record Class ShaderCompiler.Context

java.lang.Object

java.lang.Record

foundry.veil.api.client.render.shader.ShaderCompiler.Context

Record Components:

preDefinitions - The set of all shader pre-definitions

sourceSet - The location to load relative shader files from

definition - The definition the shader is being compiled for or null if there is no program

Enclosing interface:

ShaderCompiler

public static record ShaderCompiler.Context(ShaderPreDefinitions preDefinitions, ShaderSourceSet sourceSet, @Nullable ProgramDefinition definition)
extends Record

Context for compiling shaders and programs.

Constructor Summary

Constructors

Constructor	Description
Context(ShaderPreDefinitions preDefinitions, ShaderSourceSet sourceSet, @Nullable ProgramDefinition definition)	Creates an instance of a Context record class.

Method Summary

Modifier and Type	Method	Description
@Nullable ProgramDefinition	definition()	Returns the value of the definition record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
ShaderPreDefinitions	preDefinitions()	Returns the value of the preDefinitions record component.
ShaderSourceSet	sourceSet()	Returns the value of the sourceSet record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

Context

public Context(ShaderPreDefinitions preDefinitions,
 ShaderSourceSet sourceSet,
 @Nullable
 @Nullable ProgramDefinition definition)

Creates an instance of a Context record class.

Parameters:

preDefinitions - the value for the preDefinitions record component

sourceSet - the value for the sourceSet record component

definition - the value for the definition 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.

preDefinitions

public ShaderPreDefinitions preDefinitions()

Returns the value of the preDefinitions record component.

Returns:

the value of the preDefinitions record component

sourceSet

public ShaderSourceSet sourceSet()

Returns the value of the sourceSet record component.

Returns:

the value of the sourceSet record component

definition

@Nullable
public @Nullable ProgramDefinition definition()

Returns the value of the definition record component.

Returns:

the value of the definition record component