Class GuiGradient

java.lang.Object

com.render.api.gui.GuiGradient

public final class GuiGradient
extends Object

Browser-style gradient configuration for GUI backgrounds.

Linear gradients keep the original two-color API, while arbitrary color stops, radial/conic geometry, repeating paint, and lookup quality are additive options. Keep a configured instance on a retained component or custom painted component instead of constructing an equivalent gradient every frame; this lets the renderer reuse one managed lookup texture. If that GPU texture is invalidated, the current frame safely uses the adaptive mesh path and recreates the lookup on demand.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	GuiGradient.ColorStop	A color stop with an optional second position.
static final record	GuiGradient.Hint	Explicit color interpolation hint between the neighboring color stops.
static enum	GuiGradient.HueDirection	Direction used when interpolating the hue component of a polar color space.
static enum	GuiGradient.InterpolationSpace	Color space used between gradient stops.
static final record	GuiGradient.Position	Typed stop position.
static enum	GuiGradient.PositionUnit	Unit carried by an advanced stop or hint position.
static interface	GuiGradient.Step	One item in an advanced stop sequence.
static final record	GuiGradient.Stop	A compatibility color stop.
static enum	GuiGradient.Type

Constructor Summary

Constructors

Constructor	Description
GuiGradient()

Method Summary

Modifier and Type	Method	Description
float	angleDegrees()
GuiGradient	angleDegrees(float angleDegrees)
GuiGradient	center(float x, float y)
float	centerX()
float	centerY()
RenderColor	colorAt(float progress)
RenderColor	colorAt(float progress, float referenceLength)	Samples with a resolved pixel reference length for typed pixel stops.
GuiGradient	conic()
GuiGradient	copy()
RenderColor	endColor()
GuiGradient	endColor(int argb)	Deprecated. Use endColor(RenderColor).
GuiGradient	endColor(RenderColor color)
GuiGradient.HueDirection	hueDirection()
GuiGradient	interpolation(GuiGradient.InterpolationSpace space, GuiGradient.HueDirection hueDirection)	Selects the interpolation color space and hue path.
GuiGradient.InterpolationSpace	interpolationSpace()
GuiGradient	linear()
GuiGradient	radial()
float	radius()
GuiGradient	radius(float radius)	Sets the radial reach relative to the farthest box corner.
boolean	repeating()
GuiGradient	repeating(boolean repeating)
int	resolution()
GuiGradient	resolution(int resolution)	Sets gradient lookup precision.
RenderColor	startColor()
GuiGradient	startColor(int argb)	Deprecated. Use startColor(RenderColor).
GuiGradient	startColor(RenderColor color)
List<GuiGradient.Step>	steps()
GuiGradient	steps(GuiGradient.Step... steps)	Replaces the sequence with typed color stops and interpolation hints.
GuiGradient	stop(float position, int argb)	Deprecated. Use stop(float, RenderColor).
GuiGradient	stop(float position, RenderColor color)	Appends a color stop.
List<GuiGradient.Stop>	stops()
GuiGradient	stops(GuiGradient.Stop... stops)	Replaces all stops.
GuiGradient.Type	type()
GuiGradient	type(GuiGradient.Type type)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

GuiGradient

public GuiGradient()

Method Details

startColor

public RenderColor startColor()

startColor

public GuiGradient startColor(RenderColor color)

startColor

@Deprecated(forRemoval=false)
public GuiGradient startColor(int argb)

Deprecated.

Use startColor(RenderColor).

endColor

public RenderColor endColor()

endColor

public GuiGradient endColor(RenderColor color)

endColor

@Deprecated(forRemoval=false)
public GuiGradient endColor(int argb)

Deprecated.

Use endColor(RenderColor).

angleDegrees

public float angleDegrees()

angleDegrees

public GuiGradient angleDegrees(float angleDegrees)

type

public GuiGradient.Type type()

type

public GuiGradient type(GuiGradient.Type type)

linear

public GuiGradient linear()

radial

public GuiGradient radial()

conic

public GuiGradient conic()

center

public GuiGradient center(float x,
 float y)

centerX

public float centerX()

centerY

public float centerY()

radius

public GuiGradient radius(float radius)

Sets the radial reach relative to the farthest box corner.

radius

public float radius()

repeating

public GuiGradient repeating(boolean repeating)

repeating

public boolean repeating()

resolution

public GuiGradient resolution(int resolution)

Sets gradient lookup precision. Higher values improve very large or sharp gradients at the cost of a larger cached one-dimensional texture; the accepted range is 4 through 64. The same value controls subdivision density if the shader lookup path is unavailable.

resolution

public int resolution()

interpolation

public GuiGradient interpolation(GuiGradient.InterpolationSpace space,
 GuiGradient.HueDirection hueDirection)

Selects the interpolation color space and hue path.

Parameters:

space - interpolation color space

hueDirection - polar hue direction

Returns:

this gradient

interpolationSpace

public GuiGradient.InterpolationSpace interpolationSpace()

hueDirection

public GuiGradient.HueDirection hueDirection()

stop

public GuiGradient stop(float position,
 RenderColor color)

Appends a color stop. Equal positions are retained, enabling hard transitions.

stop

@Deprecated(forRemoval=false)
public GuiGradient stop(float position,
 int argb)

Deprecated.

Use stop(float, RenderColor).

stops

public GuiGradient stops(GuiGradient.Stop... stops)

Replaces all stops. At least two stops are required.

stops

public List<GuiGradient.Stop> stops()

steps

public GuiGradient steps(GuiGradient.Step... steps)

Replaces the sequence with typed color stops and interpolation hints.

At least two color stops are required. Hints must appear between color stops.

Parameters:

steps - typed sequence

Returns:

this gradient

steps

public List<GuiGradient.Step> steps()

colorAt

public RenderColor colorAt(float progress)

colorAt

public RenderColor colorAt(float progress,
 float referenceLength)

Samples with a resolved pixel reference length for typed pixel stops.

Parameters:

progress - geometric gradient progress

referenceLength - resolved gradient-line length in design or device pixels

Returns:

interpolated color

copy

public GuiGradient copy()