Record Class GuiBackgroundSize

java.lang.Object

java.lang.Record

com.render.api.gui.paint.GuiBackgroundSize

Record Components:

mode - sizing mode

width - width relative to the positioning box for GuiBackgroundSize.Mode.EXPLICIT

height - height relative to the positioning box for GuiBackgroundSize.Mode.EXPLICIT

public record GuiBackgroundSize(GuiBackgroundSize.Mode mode, float width, float height)
extends Record

Background image sizing policy.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	GuiBackgroundSize.Mode

Constructor Summary

Constructors

Constructor	Description
GuiBackgroundSize(GuiBackgroundSize.Mode mode, float width, float height)	Creates an instance of a GuiBackgroundSize record class.

Method Summary

Modifier and Type	Method	Description
static GuiBackgroundSize	auto()
static GuiBackgroundSize	contain()
static GuiBackgroundSize	cover()
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.
float	height()	Returns the value of the height record component.
GuiBackgroundSize.Mode	mode()	Returns the value of the mode record component.
static GuiBackgroundSize	relative(float width, float height)
final String	toString()	Returns a string representation of this record class.
float	width()	Returns the value of the width record component.

Methods inherited from class Object

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

Constructor Details

GuiBackgroundSize

public GuiBackgroundSize(GuiBackgroundSize.Mode mode,
 float width,
 float height)

Creates an instance of a GuiBackgroundSize record class.

Parameters:

mode - the value for the mode record component

width - the value for the width record component

height - the value for the height record component

Method Details

auto

public static GuiBackgroundSize auto()

contain

public static GuiBackgroundSize contain()

cover

public static GuiBackgroundSize cover()

relative

public static GuiBackgroundSize relative(float width,
 float height)

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.

mode

public GuiBackgroundSize.Mode mode()

Returns the value of the mode record component.

Returns:

the value of the mode record component

width

public float width()

Returns the value of the width record component.

Returns:

the value of the width record component

height

public float height()

Returns the value of the height record component.

Returns:

the value of the height record component