Package ke.ric.renderer.api

Record Class RenderPassResult

java.lang.Object

java.lang.Record

ke.ric.renderer.api.RenderPassResult

Record Components:

index - zero-based recipe layer index

result - original immutable pixels, attachments, visibility and measured timings

public record RenderPassResult(int index, RenderResult result)
extends Record

Immutable original native evidence for one recipe layer. These pixels precede the layer's post-render colour, brightness and opacity treatment. Native visibility describes this pass, not inferred coverage in the final composite image.

Constructor Summary

Constructors

Constructor	Description
RenderPassResult(int index, RenderResult result)	Constructs a validated immutable value.

Method Summary

Modifier and Type	Method	Description
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.
int	index()	Returns the value of the index record component.
RenderResult	result()	Returns the value of the result 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

Constructor Details

RenderPassResult

public RenderPassResult(int index,
 RenderResult result)

Constructs a validated immutable value.

Throws:

IllegalArgumentException - if index is negative

NullPointerException - if result is null

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.

index

public int index()

Returns the value of the index record component.

Returns:

the value of the index record component

result

public RenderResult result()

Returns the value of the result record component.

Returns:

the value of the result record component