Input Docs

Mouse Input

Input Index

Purpose

Read mouse buttons, position, motion, wheel, and cursor capture/visibility state through InputContext.

Mouse Input explains behavior, constraints, and practical usage so implementation decisions stay consistent across scripts and scenes.

API Source

Functions

mouse_down!mouse_pressed!mouse_released!mouse_position!mouse_delta!mouse_wheel!mouse_mode!

Enums

MouseButtonMouseMode

Constants

cursor capture/visibility controls

Types

InputWindowVector2ScriptContext

Usage Pattern

let fire = mouse_pressed!(ipt, MouseButton::Left);let pos = mouse_position!(ipt);let delta = mouse_delta!(ipt);

Key Details

Mouse buttons include Left, Right, Middle, Back, and Forward.

Use button helpers for down/pressed/released.

Use position and motion helpers for pointer-driven gameplay.

Cursor capture gates relative mouse workflows.