> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nanoforge.eu/llms.txt
> Use this file to discover all available pages before exploring further.

# getMouseState

> Return the full mouse state snapshot for the current frame.

# getMouseState

## Summary

Return the full mouse state snapshot for the current frame.

## Signature

```typescript theme={null}
getMouseState(): MouseState;
```

## Parameters

*No parameters.*

## Returns

**Type**:`MouseState`

Return the full mouse state snapshot for the current frame.
