Package net.ixdarklord.coolcatcanvas.api.client.effect

Record Class ScreenEffectDefinition.Target

java.lang.Object

java.lang.Record

net.ixdarklord.coolcatcanvas.api.client.effect.ScreenEffectDefinition.Target

Record Components:

width - in pixels, or the screen's

height - in pixels, or the screen's

persistent - kept across frames, for effects that feed back into themselves; otherwise cleared to clearColor every frame

clearColor - packed ARGB

Enclosing class:

ScreenEffectDefinition

public static record ScreenEffectDefinition.Target(Optional<Integer> width, Optional<Integer> height, boolean persistent, int clearColor)
extends Record

A target a pass can draw into.

Field Summary

Fields

Modifier and Type	Field	Description
static final com.mojang.serialization.Codec<ScreenEffectDefinition.Target>	CODEC
static final ScreenEffectDefinition.Target	PERSISTENT_SCREEN	Screen-sized, kept across frames.
static final ScreenEffectDefinition.Target	SCREEN	Screen-sized, cleared every frame.

Constructor Summary

Constructors

Constructor	Description
Target(Optional<Integer> width, Optional<Integer> height, boolean persistent, int clearColor)	Creates an instance of a Target record class.

Method Summary

Modifier and Type	Method	Description
int	clearColor()	Returns the value of the clearColor 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.
Optional<Integer>	height()	Returns the value of the height record component.
boolean	persistent()	Returns the value of the persistent record component.
final String	toString()	Returns a string representation of this record class.
Optional<Integer>	width()	Returns the value of the width record component.

Methods inherited from class java.lang.Object

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

Field Details

CODEC

public static final com.mojang.serialization.Codec<ScreenEffectDefinition.Target> CODEC

SCREEN

public static final ScreenEffectDefinition.Target SCREEN

Screen-sized, cleared every frame.

PERSISTENT_SCREEN

public static final ScreenEffectDefinition.Target PERSISTENT_SCREEN

Screen-sized, kept across frames.

Constructor Details

Target

public Target(Optional<Integer> width,
 Optional<Integer> height,
 boolean persistent,
 int clearColor)

Creates an instance of a Target record class.

Parameters:

width - the value for the width record component

height - the value for the height record component

persistent - the value for the persistent record component

clearColor - the value for the clearColor record component

Method Details

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.

width

public Optional<Integer> width()

Returns the value of the width record component.

Returns:

the value of the width record component

height

public Optional<Integer> height()

Returns the value of the height record component.

Returns:

the value of the height record component

persistent

public boolean persistent()

Returns the value of the persistent record component.

Returns:

the value of the persistent record component

clearColor

public int clearColor()

Returns the value of the clearColor record component.

Returns:

the value of the clearColor record component