Syntax
ImGuiWindow.Checkbox(window: ImGuiWindow, label: string, checked: any, onChange: function): ImGuiWindowArguments
| Name | Type | Description |
|---|---|---|
window | ImGuiWindow | ImGuiWindow object returned by imgui.create. A destroyed or invalid window raises a Lua error. |
label | string | Checkbox label string passed to the rendered ImGui checkbox. |
checked | any | Initial checked value. nil and false are treated as false; other values are treated as true. |
onChange | function | Function stored for this checkbox and invoked with the new boolean state after a change event is processed. |
Returns
| Name | Type | Description |
|---|---|---|
window | ImGuiWindow | The same ImGuiWindow object, allowing chained method calls. |
Description
Appends a checkbox element to an ImGuiWindow. The callback is invoked with the new boolean value when the checkbox changes, and the method returns the same ImGuiWindow object.
Call it with 4 parameter(s): window, label, checked, onChange. The argument table explains which values are required and which ones only refine the behavior.
It returns window (ImGuiWindow). Use the returns table to separate successful values from nil results and recoverable errors.
Example
Example call with placeholder values.
local result = ImGuiWindow.Checkbox(nil, "example", nil, function() end)
print(result)Types
ImGuiWindow
Handle returned by imgui.create. Control-building methods return the same handle so calls can be chained.
Button (label: string, onClick: () -> ()) -> ImGuiWindow Appends a button and queues the callback with no arguments after a click.Checkbox (label: string, checked: any, onChange: (boolean) -> ()) -> ImGuiWindow Appends a checkbox initialized from the checked value.CollapsingHeader (label: string, content: (ImGuiWindow) -> ()) -> ImGuiWindow Immediately runs content to append elements that render under a collapsible header.ColorPicker (label: string, red: number?, green: number?, blue: number?, alpha: number?, onChange: (number, number, number, number) -> ()) -> ImGuiWindow Appends a ColorEdit4-backed RGBA editor; onChange is read from argument 7.InputText (label: string, text: string?, onChange: (string) -> ()) -> ImGuiWindow Appends a single-line InputText using a fixed 256-byte buffer; onChange is argument 4.SameLine () -> ImGuiWindow Appends a SameLine layout marker that calls same-line layout during rendering.Separator () -> ImGuiWindow Appends a Separator marker that calls a separator during rendering.SliderFloat (label: string, value: number, minimum: number, maximum: number, onChange: (number) -> ()) -> ImGuiWindow Appends a SliderFloat element and queues onChange with one Lua number when the value changes.SliderInt (label: string, value: integer, minimum: integer, maximum: integer, onChange: (number) -> ()) -> ImGuiWindow Appends a SliderInt element and queues onChange with one Lua number when the integer value changes.Text (text: string) -> ImGuiWindow Appends a non-interactive text element.destroy () -> () Removes the window and releases its registered callbacks.