Package foundry.veil.api.client.render.framebuffer

Record Class FramebufferAttachmentDefinition

java.lang.Object

java.lang.Record

foundry.veil.api.client.render.framebuffer.FramebufferAttachmentDefinition

Record Components:

type - The type of attachment this is

format - The internal format of the data

depth - Whether this is a color or depth attachment

linear - Whether this should have linear filtering. Only applies to texture buffers

levels - The number of mipmaps for textures and samples for render buffers

name - The custom name to use when uploading this as a sampler to shaders

public record FramebufferAttachmentDefinition(FramebufferAttachmentDefinition.Type type, FramebufferAttachmentDefinition.Format format, FramebufferAttachmentDefinition.DataType dataType, boolean depth, boolean linear, int levels, @Nullable String name)
extends Record

Represents a framebuffer attachment that can be turned into a real framebuffer.

See Also:

• AdvancedFbo
• FramebufferManager
• PostProcessingManager

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	FramebufferAttachmentDefinition.DataType	The formats for attachments.
static enum	FramebufferAttachmentDefinition.Format	The formats for attachments.
static enum	FramebufferAttachmentDefinition.Type	The type of attachments.

Field Summary

Fields

Modifier and Type	Field	Description
static final com.mojang.serialization.Codec<FramebufferAttachmentDefinition>	COLOR_CODEC
static final com.mojang.serialization.Codec<FramebufferAttachmentDefinition>	DEPTH_CODEC

Constructor Summary

Constructors

Constructor	Description
FramebufferAttachmentDefinition(FramebufferAttachmentDefinition.Type type, FramebufferAttachmentDefinition.Format format, FramebufferAttachmentDefinition.DataType dataType, boolean depth, boolean linear, int levels, @Nullable String name)	Creates an instance of a FramebufferAttachmentDefinition record class.

Method Summary

Modifier and Type	Method	Description
FramebufferAttachmentDefinition.DataType	dataType()	Returns the value of the dataType record component.
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.
FramebufferAttachmentDefinition.Format	format()	Returns the value of the format record component.
final int	hashCode()	Returns a hash code value for this object.
boolean	isCompactDepthAttachment()
int	levels()	Returns the value of the levels record component.
boolean	linear()	Returns the value of the linear record component.
@Nullable String	name()	Returns the value of the name record component.
final String	toString()	Returns a string representation of this record class.
FramebufferAttachmentDefinition.Type	type()	Returns the value of the type record component.

Methods inherited from class java.lang.Object

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

Field Details

COLOR_CODEC

public static final com.mojang.serialization.Codec<FramebufferAttachmentDefinition> COLOR_CODEC

DEPTH_CODEC

public static final com.mojang.serialization.Codec<FramebufferAttachmentDefinition> DEPTH_CODEC

Constructor Details

FramebufferAttachmentDefinition

public FramebufferAttachmentDefinition(FramebufferAttachmentDefinition.Type type,
 FramebufferAttachmentDefinition.Format format,
 FramebufferAttachmentDefinition.DataType dataType,
 boolean depth,
 boolean linear,
 int levels,
 @Nullable
 @Nullable String name)

Creates an instance of a FramebufferAttachmentDefinition record class.

Parameters:

type - the value for the type record component

format - the value for the format record component

dataType - the value for the dataType record component

depth - the value for the depth record component

linear - the value for the linear record component

levels - the value for the levels record component

name - the value for the name record component

Method Details

isCompactDepthAttachment

public boolean isCompactDepthAttachment()

Returns:

Whether this attachment can be represented as "depth": true in the JSON

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.

type

public FramebufferAttachmentDefinition.Type type()

Returns the value of the type record component.

Returns:

the value of the type record component

format

public FramebufferAttachmentDefinition.Format format()

Returns the value of the format record component.

Returns:

the value of the format record component

dataType

public FramebufferAttachmentDefinition.DataType dataType()

Returns the value of the dataType record component.

Returns:

the value of the dataType record component

depth

public boolean depth()

Returns the value of the depth record component.

Returns:

the value of the depth record component

linear

public boolean linear()

Returns the value of the linear record component.

Returns:

the value of the linear record component

levels

public int levels()

Returns the value of the levels record component.

Returns:

the value of the levels record component

name

@Nullable
public @Nullable String name()

Returns the value of the name record component.

Returns:

the value of the name record component