Input Handling

Input event handling functions for ImGui.

Functions

---

IsKeyDown()

IsKeyDown(user_key_index:integer) -> boolean

• Description: Checks if key is down
• Parameters: user_key_index:integer - Key index
• Returns: boolean - Key is down

---

IsKeyPressed()

IsKeyPressed(user_key_index:integer, repeat:boolean|nil) -> boolean

• Description: Checks if key was pressed
• Parameters:
  • user_key_index:integer - Key index
  • repeat:boolean|nil - Allow repeat (optional)
• Returns: boolean - Key was pressed

---

IsKeyReleased()

IsKeyReleased(user_key_index:integer) -> boolean

• Description: Checks if key was released
• Parameters: user_key_index:integer - Key index
• Returns: boolean - Key was released

---

IsMouseDown()

IsMouseDown(button:integer) -> boolean

• Description: Checks if mouse button is down
• Parameters: button:integer - Mouse button
• Returns: boolean - Mouse button is down

---

IsMouseClicked()

IsMouseClicked(button:integer, repeat:boolean|nil) -> boolean

• Description: Checks if mouse button was clicked
• Parameters:
  • button:integer - Mouse button
  • repeat:boolean|nil - Allow repeat (optional)
• Returns: boolean - Mouse button was clicked

---

IsMouseReleased()

IsMouseReleased(button:integer) -> boolean

• Description: Checks if mouse button was released
• Parameters: button:integer - Mouse button
• Returns: boolean - Mouse button was released

---

IsMouseDoubleClicked()

IsMouseDoubleClicked(button:integer) -> boolean

• Description: Checks if mouse button was double clicked
• Parameters: button:integer - Mouse button
• Returns: boolean - Mouse button was double clicked

---

GetMousePos()

GetMousePos() -> ImVec2

• Description: Gets mouse position
• Returns: ImVec2 - Mouse position

---

GetMouseDragDelta()

GetMouseDragDelta(button:integer|nil) -> ImVec2

• Description: Gets mouse drag delta
• Parameters: button:integer|nil - Mouse button (optional)
• Returns: ImVec2 - Drag delta

---

ResetMouseDragDelta()

ResetMouseDragDelta(button:integer|nil)

• Description: Resets mouse drag delta
• Parameters: button:integer|nil - Mouse button (optional)
• Returns: None

---

GetMouseCursor()

GetMouseCursor() -> ImGuiMouseCursor

• Description: Gets mouse cursor
• Returns: ImGuiMouseCursor - Mouse cursor

---

SetMouseCursor()

SetMouseCursor(cursor:ImGuiMouseCursor)

• Description: Sets mouse cursor
• Parameters: cursor:ImGuiMouseCursor - Mouse cursor
• Returns: None

---

GetKeyIndex()

GetKeyIndex(imgui_key:ImGuiKey) -> integer

• Description: Gets key index
• Parameters: imgui_key:ImGuiKey - ImGui key
• Returns: integer - Key index

---

CaptureKeyboardFromApp()

CaptureKeyboardFromApp(want_capture_keyboard:boolean)

• Description: Capture keyboard from app
• Parameters: want_capture_keyboard:boolean - Want capture keyboard
• Returns: None

---

CaptureMouseFromApp()

CaptureMouseFromApp(want_capture_mouse:boolean)

• Description: Capture mouse from app
• Parameters: want_capture_mouse:boolean - Want capture mouse
• Returns: None

---

SetNextFrameWantCaptureKeyboard()

SetNextFrameWantCaptureKeyboard(want_capture_keyboard:boolean)

• Description: Set next frame keyboard capture
• Parameters: want_capture_keyboard:boolean - Want capture keyboard
• Returns: None

---

SetNextFrameWantCaptureMouse()

SetNextFrameWantCaptureMouse(want_capture_mouse:boolean)

• Description: Set next frame mouse capture
• Parameters: want_capture_mouse:boolean - Want capture mouse
• Returns: None