Input¶

Description¶

Input is a static polling class that provides the current keyboard, mouse, and touch state at any point during a frame. Use it inside onUpdate or onFixedUpdate to check whether a key or button is held down. For event-based input (press/release notifications), subscribe to the Engine callback events instead.

#include "Doriax.h"
using namespace doriax;

// Inside an update callback:
if (Input::isKeyPressed(S_KEY_SPACE)) {
    player.jump();
}

-- Inside update:
if Input.isKeyPressed(S_KEY_SPACE) then
    player:jump()
end

Methods¶

Keys¶

Key constants are preprocessor #define values (C++) and global numeric constants (Lua). Prefix: S_KEY_.

Mouse buttons¶

Modifiers¶

Modifier bits returned by getModifiers and passed to key/mouse callbacks.

Method details¶

isKeyPressed¶

• static bool isKeyPressed(int key)

Returns true while the given key is held down. Use S_KEY_* constants for the key code.

if (Input::isKeyPressed(S_KEY_W)) {
    player.moveForward(Engine::getDeltatime() * speed);
}

if Input.isKeyPressed(S_KEY_W) then
    player:moveForward(Engine.deltatime * speed)
end

isMousePressed¶

• static bool isMousePressed(int button)

Returns true while the given mouse button is held down. Use S_MOUSE_BUTTON_* constants.

if (Input::isMousePressed(S_MOUSE_BUTTON_LEFT)) {
    // drag logic
}

if Input.isMousePressed(S_MOUSE_BUTTON_LEFT) then
    -- drag logic
end

isTouch¶

• static bool isTouch()

Returns true if there is at least one active touch contact.

isMouseEntered¶

• static bool isMouseEntered()

Returns true while the mouse cursor is inside the canvas boundary.

getMousePosition¶

• static Vector2 getMousePosition()

Current cursor position in canvas coordinates. Updated every frame; use for hover detection in onUpdate.

Vector2 pos = Input::getMousePosition();

local pos = Input.getMousePosition()

getMouseScroll¶

• static Vector2 getMouseScroll()

Accumulated scroll wheel delta since the last frame, in (xoffset, yoffset). Reset each frame.

getTouchPosition¶

• static Vector2 getTouchPosition(int pointer)

Returns the current position of the touch contact identified by pointer. Use findTouchIndex to convert a pointer ID to an array index if needed.

getTouches¶

• static std::vector<Touch> getTouches()

Returns all active touch contacts. Each Touch has int pointer and Vector2 position.

for (const auto& touch : Input::getTouches()) {
    drawCircle(touch.position.x, touch.position.y, 10.0f);
}

local touches = Input.getTouches()
for i = 1, #touches do
    drawCircle(touches[i].position.x, touches[i].position.y, 10)
end

numTouches¶

• static size_t numTouches()

Returns the count of currently active touch contacts.

getModifiers¶

• static int getModifiers()

Returns the current modifier key bitmask. Check individual modifiers with bitwise AND.

int mods = Input::getModifiers();
if (mods & S_MODIFIER_SHIFT) {
    // Shift is held
}

local mods = Input.getModifiers()
if (mods & S_MODIFIER_SHIFT) ~= 0 then
    -- Shift is held
end

findTouchIndex¶

• static size_t findTouchIndex(int pointer)

Returns the index into the getTouches array for the given pointer ID. Returns SIZE_MAX if not found.