Pass:circle

Draws a circle.

Pass:circle(x, y, z, radius, angle, ax, ay, az, style, angle1, angle2, segments)
Pass:circle(position, radius, orientation, style, angle1, angle2, segments)
Pass:circle(transform, style, angle1, angle2, segments)

Arguments

Name	Type	Default	Description
x	number	0	The x coordinate of the center of the circle.
y	number	0	The y coordinate of the center of the circle.
z	number	0	The z coordinate of the center of the circle.
radius	number	1	The radius of the circle.
angle	number	0	The rotation of the circle around its rotation axis, in radians.
ax	number	0	The x component of the axis of rotation.
ay	number	1	The y component of the axis of rotation.
az	number	0	The z component of the axis of rotation.
style	DrawStyle	'fill'	Whether the circle should be filled or outlined.
angle1	number	0	The angle of the beginning of the arc.
angle2	number	2 * math.pi	angle of the end of the arc.
segments	number	64	The number of segments to render.

Returns

Nothing

Arguments

Name	Type	Default	Description
position	Vec3		The position of the circle.
radius	number	1	The radius of the circle.
orientation	Quat		The orientation of the circle.
style	DrawStyle	'fill'	Whether the circle should be filled or outlined.
angle1	number	0	The angle of the beginning of the arc.
angle2	number	2 * math.pi	angle of the end of the arc.
segments	number	64	The number of segments to render.

Returns

Nothing

Arguments

Name	Type	Default	Description
transform	Mat4		The transform of the circle.
style	DrawStyle	'fill'	Whether the circle should be filled or outlined.
angle1	number	0	The angle of the beginning of the arc.
angle2	number	2 * math.pi	angle of the end of the arc.
segments	number	64	The number of segments to render.

Returns

Nothing

Notes

The local origin of the circle is in its center. The local z axis is perpendicular to the circle.

Guides

Examples

Modules

Objects

Callbacks

Functions

Types

Pass:circle

Arguments

Returns

Arguments

Returns

Arguments

Returns

Notes

See also