Mouse

Mouse related functions

Get Pos

get_pos() → Vec2

Get the current position of the mouse cursor.

Returns

tuple[float, float] : The current mouse position as (x, y) coordinates.

Get Rel

get_rel() → Vec2

Get the relative mouse movement since the last frame.

Returns

tuple[float, float] : The relative movement of the mouse as (dx, dy).

Hide

hide() → None

Hide the mouse cursor from view.

The cursor will be invisible but mouse input will still be tracked.

Is Hidden

is_hidden() → bool

Check if the mouse cursor is currently hidden.

Returns

bool : True if the cursor is hidden.

Is Just Pressed

is_just_pressed(button: MouseButton) → bool

Check if a mouse button was pressed this frame.

Args

  • button : The mouse button to check.

Returns

bool : True if the button was just pressed.

Is Just Released

is_just_released(button: MouseButton) → bool

Check if a mouse button was released this frame.

Args

  • button : The mouse button to check.

Returns

bool : True if the button was just released.

Is Locked

is_locked() → bool

Check if the mouse is currently locked to the window.

Returns

bool : True if the mouse is locked.

Is Pressed

is_pressed(button: MouseButton) → bool

Check if a mouse button is currently pressed.

Args

  • button : The mouse button to check (e.g., kn.MOUSE_LEFT).

Returns

bool : True if the button is currently pressed.

Lock

lock() → None

Lock the mouse to the center of the window.

Useful for first-person controls where you want to capture mouse movement without letting the cursor leave the window area.

Show

show() → None

Show the mouse cursor if it was hidden.

Unlock

unlock() → None

Unlock the mouse from the window, allowing it to move freely.