Immediate-mode drawing primitives backed by the overlay renderer. Submit filled shapes, outlines, lines, text and images each frame; the surface clears between frames.
Draws a circle. Must be used inside RunService.PreRender. Returns true if the circle was successfully rendered, false if rendering failed.
Draws a Line from one point to another. Must be used inside RunService.PreRender. Returns true if the line was successfully rendered, false if rendering failed.
Draws a rectangle. Must be used inside RunService.PreRender. Returns true if the rectangle was successfully rendered, false if rendering failed.
| topLeft | Vector2 | Vector3 | The top left of the rectangle. |
| bottomRight | Vector2 | Vector3 | The bottom right of the rectangle. |
| roundness | number | The roundness of the rectangle. |
| filled | boolean | Whether the rectangle is filled. |
| outlined | boolean | Whether the rectangle is rendered with an outline |
| color | Color4 | The color of the rectangle |
Draws text given a custom font. Must be used inside RunService.PreRender. Returns true if the text was successfully rendered, false if rendering failed.
| topLeft | Vector2 | Vector3 | The top left origin of the text. |
| text | string | The text to render. |
| fontDescriptor | FontDescriptor | The descriptor. |
| outlined | boolean | Whether the text is rendered with an outline |
| color | Color4 | The color of the text |
Measures the pixel size a string would occupy if it were drawn with the given font, without actually rendering anything. Must be used inside RunService.PreRender.
| text | string | The text to measure. |
| fontDescriptor | FontDescriptor | The font the text would be drawn with. |
Draws an image obtained from the image library inside a rectangular region. Must be used inside RunService.PreRender. Returns true if the image was successfully rendered, false if the image was invalid or the projection failed.
| image | Image | The image handle to draw. |
| topLeft | Vector2 | Vector3 | The top-left of the destination rectangle. |
| bottomRight | Vector2 | Vector3 | The bottom-right of the destination rectangle. |
| tint | Color4? | Optional tint color multiplied with the texture. Defaults to opaque white. |
| rounding | number? | Optional corner rounding in pixels. Defaults to 0 (no rounding). |
Fills a convex polygon. Must be used inside RunService.PreRender. The point list must already describe a convex polygon (see the convex_hull helpers in the Luau convex_hull library); ImGui does not re-validate convexity, so a non-convex input renders incorrectly. Returns true if the polygon was successfully rendered, false if the input had fewer than three points.