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

Record Class ProgramDefinition

java.lang.Object

java.lang.Record

foundry.veil.api.client.render.shader.program.ProgramDefinition

Record Components:

vertex - The vertex shader or null to not include one

tesselationControl - The tesselation control shader or null to not include one

tesselationEvaluation - The tesselation evluation shader or null to not include one

geometry - The geometry shader or null to not include one

fragment - The fragment shader or null to not include one

compute - The compute shader or null to not include one. Compute should be in a shader by itself

definitions - The definitions to inject when compiling

definitionDefaults - The default values for definitions

textures - The textures to bind when using this shader

shaders - A map of all sources and their OpenGL types for convenience

public record ProgramDefinition(@Nullable ProgramDefinition.ShaderSource vertex, @Nullable ProgramDefinition.ShaderSource tesselationControl, @Nullable ProgramDefinition.ShaderSource tesselationEvaluation, @Nullable ProgramDefinition.ShaderSource geometry, @Nullable ProgramDefinition.ShaderSource fragment, @Nullable ProgramDefinition.ShaderSource compute, String[] definitions, Map<String,String> definitionDefaults, Map<String,ShaderTextureSource> textures, it.unimi.dsi.fastutil.ints.Int2ObjectMap<ProgramDefinition.ShaderSource> shaders)
extends Record

Defines a shader program instance.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ProgramDefinition.Deserializer	Deserializer for ProgramDefinition.
static final record	ProgramDefinition.ShaderSource
static enum	ProgramDefinition.SourceType

Constructor Summary

Constructors

Constructor

Description

ProgramDefinition(@Nullable ProgramDefinition.ShaderSource vertex, @Nullable ProgramDefinition.ShaderSource tesselationControl, @Nullable ProgramDefinition.ShaderSource tesselationEvaluation, @Nullable ProgramDefinition.ShaderSource geometry, @Nullable ProgramDefinition.ShaderSource fragment, @Nullable ProgramDefinition.ShaderSource compute, String[] definitions, Map<String,String> definitionDefaults, Map<String,ShaderTextureSource> textures, it.unimi.dsi.fastutil.ints.Int2ObjectMap<ProgramDefinition.ShaderSource> shaders)

Creates an instance of a ProgramDefinition record class.

Method Summary

Modifier and Type	Method	Description
@Nullable ProgramDefinition.ShaderSource	compute()	Returns the value of the compute record component.
Map<String,String>	definitionDefaults()	Returns the value of the definitionDefaults record component.
String[]	definitions()	Returns the value of the definitions record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
@Nullable ProgramDefinition.ShaderSource	fragment()	Returns the value of the fragment record component.
@Nullable ProgramDefinition.ShaderSource	geometry()	Returns the value of the geometry record component.
final int	hashCode()	Returns a hash code value for this object.
it.unimi.dsi.fastutil.ints.Int2ObjectMap<ProgramDefinition.ShaderSource>	shaders()	Returns the value of the shaders record component.
@Nullable ProgramDefinition.ShaderSource	tesselationControl()	Returns the value of the tesselationControl record component.
@Nullable ProgramDefinition.ShaderSource	tesselationEvaluation()	Returns the value of the tesselationEvaluation record component.
Map<String,ShaderTextureSource>	textures()	Returns the value of the textures record component.
final String	toString()	Returns a string representation of this record class.
@Nullable ProgramDefinition.ShaderSource	vertex()	Returns the value of the vertex record component.

Methods inherited from class java.lang.Object

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

Constructor Details

ProgramDefinition

public ProgramDefinition(@Nullable
 @Nullable ProgramDefinition.ShaderSource vertex,
 @Nullable
 @Nullable ProgramDefinition.ShaderSource tesselationControl,
 @Nullable
 @Nullable ProgramDefinition.ShaderSource tesselationEvaluation,
 @Nullable
 @Nullable ProgramDefinition.ShaderSource geometry,
 @Nullable
 @Nullable ProgramDefinition.ShaderSource fragment,
 @Nullable
 @Nullable ProgramDefinition.ShaderSource compute,
 String[] definitions,
 Map<String,String> definitionDefaults,
 Map<String,ShaderTextureSource> textures,
 it.unimi.dsi.fastutil.ints.Int2ObjectMap<ProgramDefinition.ShaderSource> shaders)

Creates an instance of a ProgramDefinition record class.

Parameters:

vertex - the value for the vertex record component

tesselationControl - the value for the tesselationControl record component

tesselationEvaluation - the value for the tesselationEvaluation record component

geometry - the value for the geometry record component

fragment - the value for the fragment record component

compute - the value for the compute record component

definitions - the value for the definitions record component

definitionDefaults - the value for the definitionDefaults record component

textures - the value for the textures record component

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

vertex

@Nullable
public @Nullable ProgramDefinition.ShaderSource vertex()

Returns the value of the vertex record component.

Returns:

the value of the vertex record component

tesselationControl

@Nullable
public @Nullable ProgramDefinition.ShaderSource tesselationControl()

Returns the value of the tesselationControl record component.

Returns:

the value of the tesselationControl record component

tesselationEvaluation

@Nullable
public @Nullable ProgramDefinition.ShaderSource tesselationEvaluation()

Returns the value of the tesselationEvaluation record component.

Returns:

the value of the tesselationEvaluation record component

geometry

@Nullable
public @Nullable ProgramDefinition.ShaderSource geometry()

Returns the value of the geometry record component.

Returns:

the value of the geometry record component

fragment

@Nullable
public @Nullable ProgramDefinition.ShaderSource fragment()

Returns the value of the fragment record component.

Returns:

the value of the fragment record component

compute

@Nullable
public @Nullable ProgramDefinition.ShaderSource compute()

Returns the value of the compute record component.

Returns:

the value of the compute record component

definitions

public String[] definitions()

Returns the value of the definitions record component.

Returns:

the value of the definitions record component

definitionDefaults

public Map<String,String> definitionDefaults()

Returns the value of the definitionDefaults record component.

Returns:

the value of the definitionDefaults record component

textures

public Map<String,ShaderTextureSource> textures()

Returns the value of the textures record component.

Returns:

the value of the textures record component

shaders

public it.unimi.dsi.fastutil.ints.Int2ObjectMap<ProgramDefinition.ShaderSource> shaders()

Returns the value of the shaders record component.

Returns:

the value of the shaders record component