Record Class GuiBackgroundLayer

java.lang.Object

java.lang.Record

com.render.api.gui.paint.GuiBackgroundLayer

Record Components:

image - reusable image value

position - layer alignment within its positioning area

size - layer sizing policy

repeat - repetition policy

origin - box used to position the image

clip - box used to clip the image

attachment - scroll/fixed attachment request

opacity - layer opacity

blendMode - requested blend operation with layers below it; unsupported non-normal modes use source-over and report compatibility telemetry

public record GuiBackgroundLayer(GuiImage image, GuiBackgroundPosition position, GuiBackgroundSize size, GuiBackgroundRepeat repeat, GuiBackgroundBox origin, GuiBackgroundBox clip, GuiBackgroundAttachment attachment, float opacity, GuiBlendMode blendMode)
extends Record

One ordered modern background image layer.

Constructor Summary

Constructors

Constructor	Description
GuiBackgroundLayer(GuiImage image, GuiBackgroundPosition position, GuiBackgroundSize size, GuiBackgroundRepeat repeat, GuiBackgroundBox origin, GuiBackgroundBox clip, GuiBackgroundAttachment attachment, float opacity, GuiBlendMode blendMode)	Creates an instance of a GuiBackgroundLayer record class.

Method Summary

Modifier and Type	Method	Description
GuiBackgroundAttachment	attachment()	Returns the value of the attachment record component.
GuiBlendMode	blendMode()	Returns the value of the blendMode record component.
GuiBackgroundBox	clip()	Returns the value of the clip 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.
static GuiBackgroundLayer	image(GuiImage image)
float	opacity()	Returns the value of the opacity 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.
GuiBackgroundLayer	withAttachment(GuiBackgroundAttachment value)
GuiBackgroundLayer	withBlendMode(GuiBlendMode value)
GuiBackgroundLayer	withBoxes(GuiBackgroundBox origin, GuiBackgroundBox clip)
GuiBackgroundLayer	withOpacity(float value)
GuiBackgroundLayer	withPosition(GuiBackgroundPosition value)
GuiBackgroundLayer	withRepeat(GuiBackgroundRepeat value)
GuiBackgroundLayer	withSize(GuiBackgroundSize value)

Methods inherited from class Object

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

Constructor Details

GuiBackgroundLayer

public GuiBackgroundLayer(GuiImage image,
 GuiBackgroundPosition position,
 GuiBackgroundSize size,
 GuiBackgroundRepeat repeat,
 GuiBackgroundBox origin,
 GuiBackgroundBox clip,
 GuiBackgroundAttachment attachment,
 float opacity,
 GuiBlendMode blendMode)

Creates an instance of a GuiBackgroundLayer record class.

Parameters:

image - the value for the image record component

position - the value for the position record component

size - the value for the size record component

repeat - the value for the repeat record component

origin - the value for the origin record component

clip - the value for the clip record component

attachment - the value for the attachment record component

opacity - the value for the opacity record component

blendMode - the value for the blendMode record component

Method Details

image

public static GuiBackgroundLayer image(GuiImage image)

withPosition

public GuiBackgroundLayer withPosition(GuiBackgroundPosition value)

withSize

public GuiBackgroundLayer withSize(GuiBackgroundSize value)

withRepeat

public GuiBackgroundLayer withRepeat(GuiBackgroundRepeat value)

withBoxes

public GuiBackgroundLayer withBoxes(GuiBackgroundBox origin,
 GuiBackgroundBox clip)

withAttachment

public GuiBackgroundLayer withAttachment(GuiBackgroundAttachment value)

withOpacity

public GuiBackgroundLayer withOpacity(float value)

withBlendMode

public GuiBackgroundLayer withBlendMode(GuiBlendMode value)

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.

image

public GuiImage image()

Returns the value of the image record component.

Returns:

the value of the image 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

repeat

public GuiBackgroundRepeat repeat()

Returns the value of the repeat record component.

Returns:

the value of the repeat 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

attachment

public GuiBackgroundAttachment attachment()

Returns the value of the attachment record component.

Returns:

the value of the attachment record component

opacity

public float opacity()

Returns the value of the opacity record component.

Returns:

the value of the opacity record component

blendMode

public GuiBlendMode blendMode()

Returns the value of the blendMode record component.

Returns:

the value of the blendMode record component