Pass:cylinder

Draws a cylinder.

Pass:cylinder(x, y, z, radius, length, angle, ax, ay, az, capped, angle1, angle2, segments)
Pass:cylinder(position, radius, length, orientation, capped, angle1, angle2, segments)
Pass:cylinder(transform, capped, angle1, angle2, segments)
Pass:cylinder(p1, p2, radius, capped, angle1, angle2, segments)

Arguments

Name	Type	Default	Description
x	number	0	The x coordinate of the center of the cylinder.
y	number	0	The y coordinate of the center of the cylinder.
z	number	0	The z coordinate of the center of the cylinder.
radius	number	1	The radius of the cylinder.
length	number	1	The length of the cylinder.
angle	number	0	The rotation of the cylinder 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.
capped	boolean	true	Whether the tops and bottoms of the cylinder should be rendered.
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 circular segments to render.

Returns

Nothing

Arguments

Name	Type	Default	Description
position	Vec3		The position of the center of the cylinder.
radius	number	1	The radius of the cylinder.
length	number	1	The length of the cylinder.
orientation	Quat		The orientation of the cylinder.
capped	boolean	true	Whether the tops and bottoms of the cylinder should be rendered.
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 circular segments to render.

Returns

Nothing

Arguments

Name	Type	Default	Description
transform	Mat4		The transform of the cylinder.
capped	boolean	true	Whether the tops and bottoms of the cylinder should be rendered.
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 circular segments to render.

Returns

Nothing

Arguments

Name	Type	Default	Description
p1	Vec3		The starting point of the cylinder.
p2	Vec3		The ending point of the cylinder.
radius	number	1	The radius of the cylinder.
capped	boolean	true	Whether the tops and bottoms of the cylinder should be rendered.
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 circular segments to render.

Returns

Nothing

Notes

The local origin is in the center of the cylinder, and the length of the cylinder is along the z axis.

Guides

Examples

Modules

Objects

Callbacks

Functions

Types

Pass:cylinder

Arguments

Returns

Arguments

Returns

Arguments

Returns

Arguments

Returns

Notes

See also