Record Class GuiMaskLayer

java.lang.Object

java.lang.Record

com.render.api.gui.effects.GuiMaskLayer

Record Components:

image - image supplying mask samples

mode - alpha or luminance sampling mode

position - image position inside the positioning area

size - resolved mask-image size

origin - box defining the positioning area

clip - box limiting mask painting

repeat - mask-image repeat behavior

composite - operation combining this layer with lower mask layers

public record GuiMaskLayer(GuiImage image, GuiMaskMode mode, GuiBackgroundPosition position, GuiBackgroundSize size, GuiBackgroundBox origin, GuiBackgroundBox clip, GuiBackgroundRepeat repeat, GuiMaskComposite composite)
extends Record

One immutable ordered image-mask layer.

Constructor Summary

Constructors

Constructor	Description
GuiMaskLayer(GuiImage image, GuiMaskMode mode, GuiBackgroundPosition position, GuiBackgroundSize size, GuiBackgroundBox origin, GuiBackgroundBox clip, GuiBackgroundRepeat repeat, GuiMaskComposite composite)	Creates an instance of a GuiMaskLayer record class.

Method Summary

Modifier and Type	Method	Description
static GuiMaskLayer	alpha(GuiImage image)
GuiBackgroundBox	clip()	Returns the value of the clip record component.
GuiMaskComposite	composite()	Returns the value of the composite 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.
GuiImage	image()	Returns the value of the image record component.
GuiMaskMode	mode()	Returns the value of the mode record component.
GuiBackgroundBox	origin()	Returns the value of the origin record component.
GuiBackgroundPosition	position()	Returns the value of the position record component.
GuiBackgroundRepeat	repeat()	Returns the value of the repeat record component.
GuiBackgroundSize	size()	Returns the value of the size record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

GuiMaskLayer

public GuiMaskLayer(GuiImage image,
 GuiMaskMode mode,
 GuiBackgroundPosition position,
 GuiBackgroundSize size,
 GuiBackgroundBox origin,
 GuiBackgroundBox clip,
 GuiBackgroundRepeat repeat,
 GuiMaskComposite composite)

Creates an instance of a GuiMaskLayer record class.

Parameters:

image - the value for the image record component

mode - the value for the mode record component

position - the value for the position record component

size - the value for the size record component

origin - the value for the origin record component

clip - the value for the clip record component

repeat - the value for the repeat record component

composite - the value for the composite record component

Method Details

alpha

public static GuiMaskLayer alpha(GuiImage image)

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.

image

public GuiImage image()

Returns the value of the image record component.

Returns:

the value of the image record component

mode

public GuiMaskMode mode()

Returns the value of the mode record component.

Returns:

the value of the mode record component

position

public GuiBackgroundPosition position()

Returns the value of the position record component.

Returns:

the value of the position record component

size

public GuiBackgroundSize size()

Returns the value of the size record component.

Returns:

the value of the size record component

origin

public GuiBackgroundBox origin()

Returns the value of the origin record component.

Returns:

the value of the origin record component

clip

public GuiBackgroundBox clip()

Returns the value of the clip record component.

Returns:

the value of the clip record component

repeat

public GuiBackgroundRepeat repeat()

Returns the value of the repeat record component.

Returns:

the value of the repeat record component

composite

public GuiMaskComposite composite()

Returns the value of the composite record component.

Returns:

the value of the composite record component