Record Class PipelineDescriptor

java.lang.Object

java.lang.Record

dev.engine.graphics.pipeline.PipelineDescriptor

public record PipelineDescriptor(List<ShaderSource> shaders, List<ShaderBinary> binaries, VertexFormat vertexFormat)
extends Record

Constructor Summary

Constructors

Constructor	Description
PipelineDescriptor(List<ShaderSource> shaders, List<ShaderBinary> binaries, VertexFormat vertexFormat)	Creates an instance of a PipelineDescriptor record class.

Method Summary

Modifier and Type	Method	Description
List<ShaderBinary>	binaries()	Returns the value of the binaries 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.
boolean	hasSpirv()	True if this descriptor contains SPIRV binaries.
static PipelineDescriptor	of(ShaderSource... shaders)	Creates a descriptor from GLSL text sources.
static PipelineDescriptor	ofSpirv(ShaderBinary... binaries)	Creates a descriptor from pre-compiled SPIRV binaries.
List<ShaderSource>	shaders()	Returns the value of the shaders record component.
final String	toString()	Returns a string representation of this record class.
VertexFormat	vertexFormat()	Returns the value of the vertexFormat record component.
PipelineDescriptor	withVertexFormat(VertexFormat format)	Returns a copy with the given vertex format.

Methods inherited from class Object

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

Constructor Details

PipelineDescriptor

public PipelineDescriptor(List<ShaderSource> shaders,
 List<ShaderBinary> binaries,
 VertexFormat vertexFormat)

Creates an instance of a PipelineDescriptor record class.

Parameters:

shaders - the value for the shaders record component

binaries - the value for the binaries record component

vertexFormat - the value for the vertexFormat record component

Method Details

of

public static PipelineDescriptor of(ShaderSource... shaders)

Creates a descriptor from GLSL text sources.

ofSpirv

public static PipelineDescriptor ofSpirv(ShaderBinary... binaries)

Creates a descriptor from pre-compiled SPIRV binaries.

withVertexFormat

public PipelineDescriptor withVertexFormat(VertexFormat format)

Returns a copy with the given vertex format.

hasSpirv

public boolean hasSpirv()

True if this descriptor contains SPIRV binaries.

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.

shaders

public List<ShaderSource> shaders()

Returns the value of the shaders record component.

Returns:

the value of the shaders record component

binaries

public List<ShaderBinary> binaries()

Returns the value of the binaries record component.

Returns:

the value of the binaries record component

vertexFormat

public VertexFormat vertexFormat()

Returns the value of the vertexFormat record component.

Returns:

the value of the vertexFormat record component