Interface GuiClipPath

All Known Implementing Classes:

GuiClipPath.Circle, GuiClipPath.Ellipse, GuiClipPath.Inset, GuiClipPath.Path, GuiClipPath.Polygon

public sealed interface GuiClipPath
permits GuiClipPath.Inset, GuiClipPath.Circle, GuiClipPath.Ellipse, GuiClipPath.Polygon, GuiClipPath.Path

Immutable component clip path.

Basic shapes and tessellated SVG paths provide exact retained hit and mask geometry. The GPU compositor paints the same coverage into its pooled mask targets.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	GuiClipPath.Circle	Circle values are normalized to the reference box.
static final record	GuiClipPath.Ellipse	Ellipse radii and center coordinates are normalized to the reference box.
static final record	GuiClipPath.Inset
static final record	GuiClipPath.Path	Retained path data interpreted by a capable compositor path backend.
static final record	GuiClipPath.Point
static final record	GuiClipPath.Polygon	Polygon whose points use normalized reference-box coordinates.
static enum	GuiClipPath.ReferenceBox

Method Summary

Modifier and Type	Method	Description
static GuiClipPath.Circle	circle(float radius, float centerX, float centerY)
GuiRect	conservativeBounds(GuiRect reference)
default boolean	contains(GuiRect reference, float x, float y)	Tests a design-space point against the authored clip.
static GuiClipPath.Ellipse	ellipse(float radiusX, float radiusY, float centerX, float centerY)
default boolean	inputExact()
static GuiClipPath.Inset	inset(float inset)
static GuiClipPath.Inset	inset(float top, float right, float bottom, float left, float radius)
default boolean	portableExact()
GuiClipPath.ReferenceBox	referenceBox()

Method Details

referenceBox

GuiClipPath.ReferenceBox referenceBox()

conservativeBounds

GuiRect conservativeBounds(GuiRect reference)

contains

default boolean contains(GuiRect reference,
 float x,
 float y)

Tests a design-space point against the authored clip. Basic shapes are exact; retained path data is flattened using the motion-path tessellator.

portableExact

default boolean portableExact()

inputExact

default boolean inputExact()

inset

static GuiClipPath.Inset inset(float inset)

inset

static GuiClipPath.Inset inset(float top,
 float right,
 float bottom,
 float left,
 float radius)

circle

static GuiClipPath.Circle circle(float radius,
 float centerX,
 float centerY)

ellipse

static GuiClipPath.Ellipse ellipse(float radiusX,
 float radiusY,
 float centerX,
 float centerY)