Record Class RenderTargetDescriptor

java.lang.Object

java.lang.Record

com.mojang.blaze3d.resource.RenderTargetDescriptor

All Implemented Interfaces:

ResourceDescriptor<RenderTarget>

public record RenderTargetDescriptor(int width, int height, @Nullable RenderTargetDescriptor.TextureProperties color, @Nullable RenderTargetDescriptor.TextureProperties depth)
extends Record
implements ResourceDescriptor<RenderTarget>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	RenderTargetDescriptor.TextureProperties

Field Summary

Fields

Modifier and Type	Field	Description
private final @Nullable RenderTargetDescriptor.TextureProperties	color	The field for the color record component.
private final @Nullable RenderTargetDescriptor.TextureProperties	depth	The field for the depth record component.
private final int	height	The field for the height record component.
private final int	width	The field for the width record component.

Constructor Summary

Constructors

Constructor	Description
RenderTargetDescriptor(int width, int height, @Nullable RenderTargetDescriptor.TextureProperties color, @Nullable RenderTargetDescriptor.TextureProperties depth)	Creates an instance of a RenderTargetDescriptor record class.

Method Summary

Modifier and Type	Method	Description
RenderTarget	allocate()
boolean	canUsePhysicalResource(ResourceDescriptor<?> other)
@Nullable RenderTargetDescriptor.TextureProperties	color()	Returns the value of the color record component.
@Nullable RenderTargetDescriptor.TextureProperties	depth()	Returns the value of the depth record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
void	free(RenderTarget resource)
final int	hashCode()	Returns a hash code value for this object.
int	height()	Returns the value of the height record component.
void	prepare(RenderTarget resource)
final String	toString()	Returns a string representation of this record class.
int	width()	Returns the value of the width record component.

Methods inherited from class Object

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

Field Details

width

private final int width

The field for the width record component.

height

private final int height

The field for the height record component.

color

private final @Nullable RenderTargetDescriptor.TextureProperties color

The field for the color record component.

depth

private final @Nullable RenderTargetDescriptor.TextureProperties depth

The field for the depth record component.

Constructor Details

RenderTargetDescriptor

public RenderTargetDescriptor(int width,
 int height,
 @Nullable RenderTargetDescriptor.TextureProperties color,
 @Nullable RenderTargetDescriptor.TextureProperties depth)

Creates an instance of a RenderTargetDescriptor record class.

Parameters:

width - the value for the width record component

height - the value for the height record component

color - the value for the color record component

depth - the value for the depth record component

Method Details

allocate

public RenderTarget allocate()

Specified by:

allocate in interface ResourceDescriptor<RenderTarget>

prepare

public void prepare(RenderTarget resource)

Specified by:

prepare in interface ResourceDescriptor<RenderTarget>

free

public void free(RenderTarget resource)

Specified by:

free in interface ResourceDescriptor<RenderTarget>

canUsePhysicalResource

public boolean canUsePhysicalResource(ResourceDescriptor<?> other)

Specified by:

canUsePhysicalResource in interface ResourceDescriptor<RenderTarget>

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 the compare method from their corresponding wrapper classes.

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.

width

public int width()

Returns the value of the width record component.

Returns:

the value of the width record component

height

public int height()

Returns the value of the height record component.

Returns:

the value of the height record component

color

public @Nullable RenderTargetDescriptor.TextureProperties color()

Returns the value of the color record component.

Returns:

the value of the color record component

depth

public @Nullable RenderTargetDescriptor.TextureProperties depth()

Returns the value of the depth record component.

Returns:

the value of the depth record component