✏️Layer

A layer is a type that is used to store render commands, as well as vertex and index data. This is the only way to push shapes and control rendering state.

g

FieldRead only

Type: Command

The next render command to be pushed to the queue. This is the object you want to change to, for example, set a texture, or change rendering modes.

---

font

Field

Type: FontBase

Font to use with add_text. If nothing has been set, no text will get rendered.

---

texSz

Field

Type: Vec2?

Texture dimensions. This value is only required if you are trying to render rounded shapes with a texture, so the rendering system will correctly map your UV coordinates to whatever shape you are rendering.

---

skipDpi

Field

Type: bool

If set to true, will skip global DPI scale. Defaults to true.

---

AddTriangleFilled

Method

Adds a filled triangle with a single color.

Arguments

Name	Type	Description
a	Vec2	A point.
b	Vec2	B point.
c	Vec2	C point.
col	Color	Shape color.

Returns

Nothing.

Example

layer:AddTriangleFilled(
    draw.Vec2(50, 50), draw.Vec2(25, 75),
    draw.Vec2(75, 75), draw.Color(255, 255, 255));

---

AddQuadFilled

Method

Adds a filled quad with a single color.

Arguments

Name	Type	Description
tl	Vec2	Top left point.
tr	Vec2	Top right point.
br	Vec2	Bottom right point.
bl	Vec2	Bottom left point.
col	Color	Shape color.

Returns

Nothing.

Example

layer:AddQuadFilled(
    draw.Vec2(50, 50), draw.Vec2(100, 60),
    draw.Vec2(100, 100), draw.Vec2(30, 70),
    draw.Color(255, 255, 255));

---

AddRectFilled

Method

Adds a filled rectangle with a single color.

Arguments

Name	Type	Description
r	Rect	Rectangle.
col	Color	Shape color.

Returns

Nothing.

Example

layer:AddRectFilled(draw.Rect(50, 50, 150, 150), draw.Color(255, 255, 255));

---

AddCircleFilled

Method

Adds a filled circle with a single color.

Arguments

Name	Type	Description
center	Vec2	Center point.
radius	float	Circle radius.
c	Color	Shape color.
segments	int	Circle segments. If set to 0, will attempt automatic segment deduction. Defaults to 0.
fill	float	Fill amount (clockwise, 0 to 1). Defaults to 1.

Returns

Nothing.

Example

layer:AddCircleFilled(draw.Vec2(50, 50), 10, draw.Color(255, 255, 255));

---

AddTriangleFilledMulticolor

Method

Adds a filled, multicolor triangle.

Arguments

Name	Type	Description
a	Vec2	A point.
b	Vec2	B point.
c	Vec2	C point.
cols	table[Color, Color, Color]	Colors for each point. Colors go in the very same order as the parameter list.

Returns

Nothing.

Example

layer:AddTriangleFilledMulticolor(
     draw.Vec2(50, 50), draw.Vec2(25, 75),
     draw.Vec2(75, 75), {
        draw.Color(255, 0, 0),
        draw.Color(0, 255, 0),
        draw.Color(0, 0, 255)
     });

---

AddRectFilledMulticolor

Method

Adds a filled, multicolor rectangle.

Arguments

Name	Type	Description
r	Rect	Rectangle.
cols	table[Color, Color, Color, Color]	Colors for each corner of the rectangle, in clockwise order starting from top-left.

Returns

Nothing.

Example

layer:AddRectFilledMulticolor(
    draw.Rect(50, 50, 150, 150), {
        draw.Color(255, 0, 0),
        draw.Color(0, 255, 0),
        draw.Color(0, 0, 255),
        draw.Color(255, 255, 0)
    });

---

AddCircleFilledMulticolor

Method

Adds a filled, multicolor circle.

Arguments

Name	Type	Description
center	Vec2	Center point.
radius	float	Circle radius.
cols	table[Color, Color]	Colors for the gradient, starting with the inner and ending with the outer color.
segments	int	The number of segments to approximate the circle. Defaults to 36.
fill	float	The portion of the circle to fill, where 1.0 is a full circle. Defaults to 1.0.

Returns

Nothing.

Example

layer:AddCircleFilledMulticolor(
    draw.Vec2(100, 100), 50, {
        draw.Color(255, 0, 0),
        draw.Color(0, 0, 255)
    }, 36, 1.0);

---

AddQuadFilledMulticolor

Method

Adds a filled, multicolor quad.

Arguments

Name	Type	Description
tl	Vec2	Top left point.
tr	Vec2	Top right point.
br	Vec2	Bottom right point.
bl	Vec2	Bottom left point.
cols	table[Color, Color]	Colors for the gradient, applied from bottom to top.

Returns

Nothing.

Example

layer:AddQuadFilledMulticolor(
    draw.Vec2(50, 50), draw.Vec2(150, 50),
    draw.Vec2(150, 150), draw.Vec2(50, 150), {
        draw.Color(255, 0, 0),
        draw.Color(0, 0, 255)
    });

---

AddPillMulticolor

Method

Adds a multicolor pill shape.

Arguments

Name	Type	Description
mins	Vec2	Top left point of the pill.
maxs	Vec2	Bottom right point of the pill.
radius_min	float	The minimum radius of the pill's rounded edges.
radius_max	float	The maximum radius of the pill's rounded edges.
cols	table[Color, Color]	Colors for the gradient, applied from bottom to top.
segments	int	The number of segments for approximating rounded edges. Defaults to 16.

Returns

Nothing.

Example

layer:AddPillMulticolor(
    draw.Vec2(50, 50), draw.Vec2(150, 100),
    10, 20, {
        draw.Color(255, 0, 0),
        draw.Color(0, 0, 255)
    }, 16);

---

AddShadowLine

Method

Adds a shadow line.

Arguments

Name	Type	Description
r	Rect	Bounding box for the shadow line.
dir	ShadowDir	Shadow direction.
a	float	Max opacity. Defaults to 0.25.

Returns

Nothing.

Example

layer:AddShadowLine(
    draw.Rect(50, 50, 150, 150), draw.ShadowDir.DOWN, 0.25);

---

AddShadowRect

Method

Adds a shadowed rectangle.

Arguments

Name	Type	Description
r	Rect	Rectangle.
radius	float	Shadow distance, in pixels, outwards.
bg	bool	Whether to draw a background for the rectangle. Defaults to true.
a	float	Max opacity of the shadow. Defaults to 0.25.

Returns

Nothing.

Example

layer:AddShadowRect(
    draw.Rect(50, 50, 150, 150), 15, true, 0.25);

---

AddGlow

Method

Adds a glow box.

Arguments

Name	Type	Description
r	Rect	Box rectangle.
radius	float	Glow distance, in pixels, outwards.
c	Color	Glow color.
parts	GlowParts	Parts of the glow to enable. Defaults to ALL.

Returns

Nothing.

Example

layer:AddGlow(draw.Rect(50, 50, 150, 150), 15, draw.Color(255, 0, 0));

---

AddRectFilledRounded

Method

Adds a filled, rounded rectangle.

Arguments

Name	Type	Description
r	Rect	Rectangle.
c	Color	Fill color.
amount	float	Rounding amount.
rnd	Rounding	Rounding mode. Defaults to ALL.

Returns

Nothing.

Example

layer:AddRectFilledRounded(
    draw.Rect(50, 50, 150, 150),
    draw.Color(255, 0, 0),
    10,
    draw.Rounding.ALL
);

---

AddRectFilledRoundedMulticolor

Method

Adds a filled, multicolor rounded rectangle.

Arguments

Name	Type	Description
r	Rect	Rectangle.
c	table[Color, Color, Color, Color]	Fill colors. Used clockwise, starting from top left.
amount	float	Rounding amount.
rnd	Rounding	Rounding mode. Defaults to ALL.

Returns

Nothing.

Example

layer:AddRectFilledRoundedMulticolor(
    draw.Rect(50, 50, 150, 150), {
        draw.Color(255, 0, 0),
        draw.Color(0, 255, 0),
        draw.Color(0, 0, 255),
        draw.Color(255, 255, 0)
    },
    10,
    draw.Rounding.ALL
);

---

AddTriangle

Method

Adds a stroked triangle.

Arguments

Name	Type	Description
a	Vec2	Point A.
b	Vec2	Point B.
c	Vec2	Point C.
col	Color	Line color.
thickness	float	Line thickness. Defaults to 1.0.
mode	OutlineMode	Outline mode. Defaults to INSET.

Returns

Nothing.

Example

layer:AddTriangle(
    draw.Vec2(50, 50),
    draw.Vec2(25, 75),
    draw.Vec2(75, 75),
    draw.Color(255, 0, 0),
    1.0,
    draw.OutlineMode.INSET
);

---

AddQuad

Method

Adds a stroked quad.

Arguments

Name	Type	Description
tl	Vec2	Top-left point.
tr	Vec2	Top-right point.
br	Vec2	Bottom-right point.
bl	Vec2	Bottom-left point.
c	Color	Line color.
thickness	float	Line thickness. Defaults to 1.0.
mode	OutlineMode	Outline mode. Defaults to INSET.

Returns

Nothing.

Example

layer:AddQuad(
    draw.Vec2(50, 50),
    draw.Vec2(150, 50),
    draw.Vec2(150, 150),
    draw.Vec2(50, 150),
    draw.Color(255, 0, 0),
    1.0,
    draw.OutlineMode.INSET
);

---

AddRect

Method

Adds a stroked rectangle.

Arguments

Name	Type	Description
r	Rect	Rectangle.
c	Color	Line color.
thickness	float	Line thickness. Defaults to 1.0.
mode	OutlineMode	Outline mode. Defaults to INSET.

Returns

Nothing.

Example

layer:AddRect(
    draw.Rect(50, 50, 150, 150),
    draw.Color(255, 0, 0),
    1.0,
    draw.OutlineMode.INSET
);

---

AddCircle

Method

Adds a stroked circle.

Arguments

Name	Type	Description
center	Vec2	Center point.
radius	float	Circle radius.
c	Color	Line color.
segments	int	Circle segments. Defaults to 36.
fill	float	Fill amount. Defaults to 1.0.
thickness	float	Line thickness. Defaults to 1.0.
mode	OutlineMode	Outline mode. Defaults to INSET.

Returns

Nothing.

Example

layer:AddCircle(
    draw.Vec2(100, 100),
    50,
    draw.Color(255, 0, 0),
    36,
    1.0,
    1.0,
    draw.OutlineMode.INSET
);

---

AddLine

Method

Adds a line.

Arguments

Name	Type	Description
a	Vec2	Start point.
b	Vec2	End point.
c	Color	Line color.
thickness	float	Line thickness. Defaults to 1.0

Returns

Nothing.

Example

layer:AddLine(
    draw.Vec2(50, 50),
    draw.Vec2(150, 150),
    draw.Color(255, 0, 0)
);

---

AddLineMulticolor

Method

Adds a multicolor line.

Arguments

Name	Type	Description
a	Vec2	Start point.
b	Vec2	End point.
c	Color	Start color.
c2	Color	End color.
thickness	float	Line thickness. Defaults to 1.0.

Returns

Nothing.

Example

layer:AddLineMulticolor(
    draw.Vec2(50, 50),
    draw.Vec2(150, 150),
    draw.Color(255, 0, 0),
    draw.Color(0, 0, 255),
    2.0
);

---

AddRectRounded

Method

Adds a rounded, filled rectangle.

Arguments

Name	Type	Description
r	Rect	Rectangle.
c	Color	Line color.
amount	float	Rounding amount.
rnd	Rounding	Rounding mode. Defaults to ALL.
thickness	float	Line thickness. Defaults to 1.0.
mode	OutlineMode	Outline mode. Defaults to INSET.

Returns

Nothing.

Example

layer:AddRectRounded(draw.Rect(50, 50, 150, 150),
    draw.Color(255, 255, 255), 14);

---

AddText

Method

Adds text.

If font wasn't set, this function will do nothing.

You can control the color while rendering the text. To change the color, add \fRRGGBBAA to the string. To reset the color, add \b.

Arguments

Name	Type	Description
p	Vec2	Text origin point.
text	string	Text.
c	Color	Text color.
params	TextParams?	Text aligning parameters. Defaults to nil.

Returns

Nothing.

Example

layer:AddText(draw.Vec2(50, 50), 'Hello world!', draw.Color(255, 255, 255));

---

OverrideClipRect

Method

Overrides clip rectangle with support of intersection.

Arguments

Name	Type	Description
r	Rect?	New clip rect.
intersect	bool	Whether this function should intersect previous rect with the new one. Defaults to true.

Returns

Nothing.

Example

layer:OverrideClipRect(draw.Rect(50, 50, 150, 150));

---

AddWithBlur

Method

Renders a section with blur applied to it.

Arguments

Name	Type	Description
area	Rect	Blurred area
callback	function	Render callback, applies the effect on all render calls inside it

Returns

Nothing.

Example

layer:AddWithBlur(draw.Rect(0, 0, 200, 200), function()
    layer:AddText(draw.Vec2(100, 100), "I'm so blurry!", draw.Color.White())
end)

---

AddWithBlurShared

Method

Renders a section with blur applied to it. Uses a shared texture.

This method is preferred over AddWithBlur as it performs better.

Arguments

Name	Type	Description
area	Rect	Blurred area
callback	function	Render callback, applies the effect on all render calls inside it

Returns

Nothing.

Example

layer:AddWithBlurShared(draw.Rect(0, 0, 200, 200), function()
    layer:AddText(draw.Vec2(100, 100), "I can't read this either...", draw.Color.White())
end)

---

AddWithFrost

Method

Renders a section with a frosted effect to it, like in the Xmas theme.

Arguments

Name	Type	Description
area	Rect	Blurred area
callback	function	Render callback, applies the effect on all render calls inside it

Returns

Nothing.

Example

layer:AddWithFrost(draw.Rect(0, 0, 200, 200), function()
    layer:AddText(draw.Vec2(100, 100), "Chilly", draw.Color.White())
end)