Package foundry.veil.impl.client.render.vertex

Record Class DSAVertexAttribBindingBuilder

java.lang.Object

java.lang.Record

foundry.veil.impl.client.render.vertex.DSAVertexAttribBindingBuilder

All Implemented Interfaces:

VertexArrayBuilder

@Internal
public record DSAVertexAttribBindingBuilder(VertexArray vertexArray, int vao)
extends Record
implements VertexArrayBuilder

Nested Class Summary

Nested classes/interfaces inherited from interface foundry.veil.api.client.render.vertex.VertexArrayBuilder

VertexArrayBuilder.DataType

Constructor Summary

Constructors

Constructor	Description
DSAVertexAttribBindingBuilder(VertexArray vertexArray, int vao)	Creates an instance of a DSAVertexAttribBindingBuilder record class.

Method Summary

Modifier and Type	Method	Description
VertexArrayBuilder	clearVertexAttributes()	Clears all defined vertex attributes.
VertexArrayBuilder	clearVertexBuffers()	Clears all mapped buffer regions.
VertexArrayBuilder	defineVertexBuffer(int index, int buffer, int offset, int stride, int divisor)	Maps a buffer region to the specified index.
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.
VertexArrayBuilder	removeAttribute(int index)	Removes the attribute with the specified index.
VertexArrayBuilder	removeVertexBuffer(int index)	Removes the buffer mapping with the specified index.
VertexArrayBuilder	setVertexAttribute(int index, int bufferIndex, int size, VertexArrayBuilder.DataType type, boolean normalized, int relativeOffset)	Defines a floating-point vertex attribute.
VertexArrayBuilder	setVertexIAttribute(int index, int bufferIndex, int size, VertexArrayBuilder.DataType type, int relativeOffset)	Defines an integer vertex attribute.
VertexArrayBuilder	setVertexLAttribute(int index, int bufferIndex, int size, VertexArrayBuilder.DataType type, int relativeOffset)	Defines a long vertex attribute.
final String	toString()	Returns a string representation of this record class.
int	vao()	Returns the value of the vao record component.
VertexArray	vertexArray()	Returns the value of the vertexArray record component.

Methods inherited from class java.lang.Object

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

Methods inherited from interface foundry.veil.api.client.render.vertex.VertexArrayBuilder

applyFrom

Constructor Details

DSAVertexAttribBindingBuilder

public DSAVertexAttribBindingBuilder(VertexArray vertexArray,
 int vao)

Creates an instance of a DSAVertexAttribBindingBuilder record class.

Parameters:

vertexArray - the value for the vertexArray record component

vao - the value for the vao record component

Method Details

defineVertexBuffer

public VertexArrayBuilder defineVertexBuffer(int index,
 int buffer,
 int offset,
 int stride,
 int divisor)

Description copied from interface: VertexArrayBuilder

Maps a buffer region to the specified index. Allows swapping out vertex data with a single GL call.

Specified by:

defineVertexBuffer in interface VertexArrayBuilder

Parameters:

index - The index to assign to. It must be between 0 and VeilRenderSystem.maxVertexAttributes()

buffer - The buffer to assign

offset - The offset into the buffer to bind to

stride - The size of the region to map

divisor - The number of instances that have to pass to increment this data or 0 to increment per vertex

setVertexAttribute

public VertexArrayBuilder setVertexAttribute(int index,
 int bufferIndex,
 int size,
 VertexArrayBuilder.DataType type,
 boolean normalized,
 int relativeOffset)

Description copied from interface: VertexArrayBuilder

Defines a floating-point vertex attribute.

Specified by:

setVertexAttribute in interface VertexArrayBuilder

Parameters:

index - The index of the attribute to assign

bufferIndex - The defined buffer index to use. Defined with VertexArrayBuilder.defineVertexBuffer(int, int, int, int, int)

size - The size of the attribute. Can be 1, 2, 3, or 4

type - The type of data the shader will use

normalized - Whether to normalize the data from -1 to 1 automatically

relativeOffset - The offset in the buffer region the vertex data is defined at. It must be between 0 and VeilRenderSystem.maxVertexAttributeRelativeOffset()

setVertexIAttribute

public VertexArrayBuilder setVertexIAttribute(int index,
 int bufferIndex,
 int size,
 VertexArrayBuilder.DataType type,
 int relativeOffset)

Description copied from interface: VertexArrayBuilder

Defines an integer vertex attribute.

Specified by:

setVertexIAttribute in interface VertexArrayBuilder

Parameters:

index - The index of the attribute to assign

bufferIndex - The defined buffer index to use. Defined with VertexArrayBuilder.defineVertexBuffer(int, int, int, int, int)

size - The size of the attribute. Can be 1, 2, 3, or 4

type - The type of data the shader will use

relativeOffset - The offset in the buffer region the vertex data is defined at. It must be between 0 and VeilRenderSystem.maxVertexAttributeRelativeOffset()

setVertexLAttribute

public VertexArrayBuilder setVertexLAttribute(int index,
 int bufferIndex,
 int size,
 VertexArrayBuilder.DataType type,
 int relativeOffset)

Description copied from interface: VertexArrayBuilder

Defines a long vertex attribute.

Specified by:

setVertexLAttribute in interface VertexArrayBuilder

Parameters:

index - The index of the attribute to assign

bufferIndex - The defined buffer index to use. Defined with VertexArrayBuilder.defineVertexBuffer(int, int, int, int, int)

size - The size of the attribute. Can be 1, 2, 3, or 4

type - The type of data the shader will use

relativeOffset - The offset in the buffer region the vertex data is defined at. It must be between 0 and VeilRenderSystem.maxVertexAttributeRelativeOffset()

removeVertexBuffer

public VertexArrayBuilder removeVertexBuffer(int index)

Description copied from interface: VertexArrayBuilder

Removes the buffer mapping with the specified index.

Specified by:

removeVertexBuffer in interface VertexArrayBuilder

Parameters:

index - The index of the buffer to remove

removeAttribute

public VertexArrayBuilder removeAttribute(int index)

Description copied from interface: VertexArrayBuilder

Removes the attribute with the specified index.

Specified by:

removeAttribute in interface VertexArrayBuilder

Parameters:

index - The index of the attribute to remove

clearVertexBuffers

public VertexArrayBuilder clearVertexBuffers()

Description copied from interface: VertexArrayBuilder

Clears all mapped buffer regions.

Specified by:

clearVertexBuffers in interface VertexArrayBuilder

clearVertexAttributes

public VertexArrayBuilder clearVertexAttributes()

Description copied from interface: VertexArrayBuilder

Clears all defined vertex attributes.

Specified by:

clearVertexAttributes in interface VertexArrayBuilder

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

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.

vertexArray

public VertexArray vertexArray()

Returns the value of the vertexArray record component.

Specified by:

vertexArray in interface VertexArrayBuilder

Returns:

the value of the vertexArray record component

vao

public int vao()

Returns the value of the vao record component.

Returns:

the value of the vao record component