Record Class GuiPaintContext.BoxOptions

java.lang.Object

java.lang.Record

com.render.api.gui.GuiPaintContext.BoxOptions

Record Components:

backgroundColor - background fill color

borderColor - border color

borderWidth - border width in design-space pixels

cornerRadius - corner radius in design-space pixels

opacity - opacity multiplier from zero through one

shadow - optional box shadow

glow - optional box glow

gradient - optional background gradient

animatedBorder - optional animated-border effect

Enclosing class:

GuiPaintContext

public static record GuiPaintContext.BoxOptions(RenderColor backgroundColor, RenderColor borderColor, float borderWidth, float cornerRadius, float opacity, GuiShadow shadow, GuiGlow glow, GuiGradient gradient, GuiAnimatedBorder animatedBorder)
extends Record

Immutable options for a custom box paint operation.

Mutable effect objects are copied when the options are created and when returned through their accessors, so a shared options instance can safely be reused.

Constructor Summary

Constructors

Constructor	Description
BoxOptions(RenderColor backgroundColor, RenderColor borderColor, float borderWidth, float cornerRadius, float opacity, GuiShadow shadow, GuiGlow glow, GuiGradient gradient, GuiAnimatedBorder animatedBorder)	Creates an instance of a BoxOptions record class.

Method Summary

Modifier and Type	Method	Description
GuiAnimatedBorder	animatedBorder()	Returns the value of the animatedBorder record component.
RenderColor	backgroundColor()	Returns the value of the backgroundColor record component.
RenderColor	borderColor()	Returns the value of the borderColor record component.
float	borderWidth()	Returns the value of the borderWidth record component.
float	cornerRadius()	Returns the value of the cornerRadius record component.
static GuiPaintContext.BoxOptions	defaults()
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
GuiGlow	glow()	Returns the value of the glow record component.
GuiGradient	gradient()	Returns the value of the gradient record component.
final int	hashCode()	Returns a hash code value for this object.
float	opacity()	Returns the value of the opacity record component.
GuiShadow	shadow()	Returns the value of the shadow record component.
static GuiPaintContext.BoxOptions	solid(RenderColor color)
final String	toString()	Returns a string representation of this record class.
GuiPaintContext.BoxOptions	withAnimatedBorder(GuiAnimatedBorder animatedBorder)
GuiPaintContext.BoxOptions	withBackground(RenderColor color)
GuiPaintContext.BoxOptions	withBorder(RenderColor color, float width)
GuiPaintContext.BoxOptions	withCornerRadius(float radius)
GuiPaintContext.BoxOptions	withGlow(GuiGlow glow)
GuiPaintContext.BoxOptions	withGradient(GuiGradient gradient)
GuiPaintContext.BoxOptions	withOpacity(float opacity)
GuiPaintContext.BoxOptions	withShadow(GuiShadow shadow)

Methods inherited from class Object

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

Constructor Details

BoxOptions

public BoxOptions(RenderColor backgroundColor,
 RenderColor borderColor,
 float borderWidth,
 float cornerRadius,
 float opacity,
 GuiShadow shadow,
 GuiGlow glow,
 GuiGradient gradient,
 GuiAnimatedBorder animatedBorder)

Creates an instance of a BoxOptions record class.

Parameters:

backgroundColor - the value for the backgroundColor record component

borderColor - the value for the borderColor record component

borderWidth - the value for the borderWidth record component

cornerRadius - the value for the cornerRadius record component

opacity - the value for the opacity record component

shadow - the value for the shadow record component

glow - the value for the glow record component

gradient - the value for the gradient record component

animatedBorder - the value for the animatedBorder record component

Method Details

defaults

public static GuiPaintContext.BoxOptions defaults()

solid

public static GuiPaintContext.BoxOptions solid(RenderColor color)

withBackground

public GuiPaintContext.BoxOptions withBackground(RenderColor color)

withBorder

public GuiPaintContext.BoxOptions withBorder(RenderColor color,
 float width)

withCornerRadius

public GuiPaintContext.BoxOptions withCornerRadius(float radius)

withOpacity

public GuiPaintContext.BoxOptions withOpacity(float opacity)

withShadow

public GuiPaintContext.BoxOptions withShadow(GuiShadow shadow)

withGlow

public GuiPaintContext.BoxOptions withGlow(GuiGlow glow)

withGradient

public GuiPaintContext.BoxOptions withGradient(GuiGradient gradient)

withAnimatedBorder

public GuiPaintContext.BoxOptions withAnimatedBorder(GuiAnimatedBorder animatedBorder)

shadow

public GuiShadow shadow()

Returns the value of the shadow record component.

Returns:

the value of the shadow record component

glow

public GuiGlow glow()

Returns the value of the glow record component.

Returns:

the value of the glow record component

gradient

public GuiGradient gradient()

Returns the value of the gradient record component.

Returns:

the value of the gradient record component

animatedBorder

public GuiAnimatedBorder animatedBorder()

Returns the value of the animatedBorder record component.

Returns:

the value of the animatedBorder record component

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.

backgroundColor

public RenderColor backgroundColor()

Returns the value of the backgroundColor record component.

Returns:

the value of the backgroundColor record component

borderColor

public RenderColor borderColor()

Returns the value of the borderColor record component.

Returns:

the value of the borderColor record component

borderWidth

public float borderWidth()

Returns the value of the borderWidth record component.

Returns:

the value of the borderWidth record component

cornerRadius

public float cornerRadius()

Returns the value of the cornerRadius record component.

Returns:

the value of the cornerRadius record component

opacity

public float opacity()

Returns the value of the opacity record component.

Returns:

the value of the opacity record component