Package ke.ric.renderer.api

Record Class RenderRecipe

java.lang.Object

java.lang.Record

ke.ric.renderer.api.RenderRecipe

Record Components:

orderedLayers - nonempty list, defensively copied; no null elements

public record RenderRecipe(List<RenderLayer> orderedLayers)
extends Record

Immutable, nonempty ordered render layers derived independently from one original capture. Layers are composited in list order: later layers paint over earlier layers according to opacity. Use RenderedFrame.image() for final composed pixels and RenderedFrame.passes() for each pass's native attachments, visibility and timing evidence.

 var highlight = RenderRecipe.layers(
         RenderLayer.scene().brightness(0.25),
         RenderLayer.entities(EntitySelector.living()).color(LayerColor.tint(0xffcc55)));
 // The entity layer respects walls. Add .occlusion(Occlusion.SELECTED_ONLY) for explicit Xray.
 

Constructor Summary

Constructors

Constructor	Description
RenderRecipe(List<RenderLayer> orderedLayers)	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.
static RenderRecipe	layers(RenderLayer... layers)	Copies layers in their composition order.
List<RenderLayer>	orderedLayers()	Returns the value of the orderedLayers 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

RenderRecipe

public RenderRecipe(List<RenderLayer> orderedLayers)

Constructs a validated immutable value.

Throws:

IllegalArgumentException - if the list is empty

NullPointerException - if the list or any layer is null

Method Details

layers

public static RenderRecipe layers(RenderLayer... layers)

Copies layers in their composition order. Each layer uses the same original captured evidence.

Parameters:

layers - at least one layer, from back to front

Returns:

an immutable recipe

Throws:

IllegalArgumentException - if no layers are supplied

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. All components in this record class are compared with Objects::equals(Object,Object).

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.

orderedLayers

public List<RenderLayer> orderedLayers()

Returns the value of the orderedLayers record component.

Returns:

the value of the orderedLayers record component