DrawingImmediate.Circle

Draws circles.

Syntax

DrawingImmediate.Circle(pos: Vector2, radius: number, color: Color3, thickness?: number, segments?: any) -> nil

Parameters

Parameter	Type	Description
`pos`	`Vector2`	The pos value used by the call.
`radius`	`number`	The radius value used by the call.
`color`	`Color3`	The color value used by the call.
`thickness?`	`number`	The thickness value used by the call.
`segments?`	`any`	The segments value used by the call.

Returns

Type	Description
`nil`	This function does not return a value.

Description

DrawingImmediate.Circle is part of the DrawingImmediate library. Immediate drawing runs inside a paint callback registered with DrawingImmediate.GetPaint(); primitives are emitted for the current frame only.

The operation is performed immediately using the arguments supplied at the call site.

The aliases FilledCircle(pos, radius, color, segments?) resolve to the same implementation.

Example

-- inside a DrawingImmediate.GetPaint():Connect callback
DrawingImmediate.Circle(Vector2.new(100, 100), 40, Color3.new(0, 1, 0), 2)
DrawingImmediate.FilledCircle(Vector2.new(200, 100), 30, Color3.new(0, 0.5, 1))

Notes

Aliases: FilledCircle(pos, radius, color, segments?).
Draw calls must run inside a callback registered with DrawingImmediate.GetPaint().