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

Record Class FramebufferSource

java.lang.Object

java.lang.Record

foundry.veil.api.client.render.shader.texture.FramebufferSource

Record Components:

name - The location of the framebuffer

sampler - The sampler to use. Ignored if depth is true

depth - Whether to sample the depth texture or not

All Implemented Interfaces:

ShaderTextureSource

public record FramebufferSource(net.minecraft.resources.ResourceLocation name, int sampler, boolean depth)
extends Record
implements ShaderTextureSource

Source of a shader texture using a framebuffer.

Nested Class Summary

Nested classes/interfaces inherited from interface foundry.veil.api.client.render.shader.texture.ShaderTextureSource

ShaderTextureSource.Context, ShaderTextureSource.Type

Field Summary

Fields

Modifier and Type	Field	Description
static final com.mojang.serialization.MapCodec<FramebufferSource>	CODEC

Fields inherited from interface foundry.veil.api.client.render.shader.texture.ShaderTextureSource

GLOBAL_CONTEXT, TYPE_CODEC

Constructor Summary

Constructors

Constructor	Description
FramebufferSource(net.minecraft.resources.ResourceLocation name, int sampler, boolean depth)	Creates an instance of a FramebufferSource record class.

Method Summary

Modifier and Type	Method	Description
boolean	depth()	Returns the value of the depth record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
int	getId(ShaderTextureSource.Context context)	Retrieves the id of this texture based on context.
ShaderTextureSource.Type	getType()
final int	hashCode()	Returns a hash code value for this object.
net.minecraft.resources.ResourceLocation	name()	Returns the value of the name record component.
int	sampler()	Returns the value of the sampler 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

Field Details

CODEC

public static final com.mojang.serialization.MapCodec<FramebufferSource> CODEC

Constructor Details

FramebufferSource

public FramebufferSource(net.minecraft.resources.ResourceLocation name,
 int sampler,
 boolean depth)

Creates an instance of a FramebufferSource record class.

Parameters:

name - the value for the name record component

sampler - the value for the sampler record component

depth - the value for the depth record component

Method Details

getId

public int getId(ShaderTextureSource.Context context)

Description copied from interface: ShaderTextureSource

Retrieves the id of this texture based on context.

Specified by:

getId in interface ShaderTextureSource

Parameters:

context - The context to use

Returns:

The id of the texture to bind

getType

public ShaderTextureSource.Type getType()

Specified by:

getType in interface ShaderTextureSource

Returns:

The type of shader texture this is

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.

name

public net.minecraft.resources.ResourceLocation name()

Returns the value of the name record component.

Returns:

the value of the name record component

sampler

public int sampler()

Returns the value of the sampler record component.

Returns:

the value of the sampler record component

depth

public boolean depth()

Returns the value of the depth record component.

Returns:

the value of the depth record component