# {py:mod}`simvx.core.input.state`

```{py:module} simvx.core.input.state
```

```{autodoc2-docstring} simvx.core.input.state
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`Input <simvx.core.input.state.Input>`
  - ```{autodoc2-docstring} simvx.core.input.state.Input
    :summary:
    ```
````

### API

`````{py:class} Input
:canonical: simvx.core.input.state.Input

```{autodoc2-docstring} simvx.core.input.state.Input
```

````{py:method} is_action_pressed(action: str) -> bool
:canonical: simvx.core.input.state.Input.is_action_pressed
:classmethod:

```{autodoc2-docstring} simvx.core.input.state.Input.is_action_pressed
```

````

````{py:method} is_action_just_pressed(action: str) -> bool
:canonical: simvx.core.input.state.Input.is_action_just_pressed
:classmethod:

```{autodoc2-docstring} simvx.core.input.state.Input.is_action_just_pressed
```

````

````{py:method} is_action_just_released(action: str) -> bool
:canonical: simvx.core.input.state.Input.is_action_just_released
:classmethod:

```{autodoc2-docstring} simvx.core.input.state.Input.is_action_just_released
```

````

````{py:method} get_action_strength(action: str) -> float
:canonical: simvx.core.input.state.Input.get_action_strength
:classmethod:

```{autodoc2-docstring} simvx.core.input.state.Input.get_action_strength
```

````

````{py:attribute} get_strength
:canonical: simvx.core.input.state.Input.get_strength
:value: >
   None

```{autodoc2-docstring} simvx.core.input.state.Input.get_strength
```

````

````{py:method} get_axis(negative_action: str, positive_action: str) -> float
:canonical: simvx.core.input.state.Input.get_axis
:classmethod:

```{autodoc2-docstring} simvx.core.input.state.Input.get_axis
```

````

````{py:method} get_vector(neg_x: str, pos_x: str, neg_y: str, pos_y: str) -> simvx.core.math.types.Vec2
:canonical: simvx.core.input.state.Input.get_vector
:classmethod:

```{autodoc2-docstring} simvx.core.input.state.Input.get_vector
```

````

````{py:method} is_key_pressed(key: simvx.core.input.enums.Key) -> bool
:canonical: simvx.core.input.state.Input.is_key_pressed
:classmethod:

```{autodoc2-docstring} simvx.core.input.state.Input.is_key_pressed
```

````

````{py:method} is_key_just_pressed(key: simvx.core.input.enums.Key) -> bool
:canonical: simvx.core.input.state.Input.is_key_just_pressed
:classmethod:

```{autodoc2-docstring} simvx.core.input.state.Input.is_key_just_pressed
```

````

````{py:method} is_key_just_released(key: simvx.core.input.enums.Key) -> bool
:canonical: simvx.core.input.state.Input.is_key_just_released
:classmethod:

```{autodoc2-docstring} simvx.core.input.state.Input.is_key_just_released
```

````

````{py:method} is_mouse_button_pressed(button: simvx.core.input.enums.MouseButton) -> bool
:canonical: simvx.core.input.state.Input.is_mouse_button_pressed
:classmethod:

```{autodoc2-docstring} simvx.core.input.state.Input.is_mouse_button_pressed
```

````

````{py:method} is_mouse_button_just_pressed(button: simvx.core.input.enums.MouseButton) -> bool
:canonical: simvx.core.input.state.Input.is_mouse_button_just_pressed
:classmethod:

```{autodoc2-docstring} simvx.core.input.state.Input.is_mouse_button_just_pressed
```

````

````{py:method} is_mouse_button_just_released(button: simvx.core.input.enums.MouseButton) -> bool
:canonical: simvx.core.input.state.Input.is_mouse_button_just_released
:classmethod:

```{autodoc2-docstring} simvx.core.input.state.Input.is_mouse_button_just_released
```

````

````{py:method} get_mouse_position() -> simvx.core.math.types.Vec2
:canonical: simvx.core.input.state.Input.get_mouse_position
:classmethod:

```{autodoc2-docstring} simvx.core.input.state.Input.get_mouse_position
```

````

````{py:method} get_mouse_delta() -> simvx.core.math.types.Vec2
:canonical: simvx.core.input.state.Input.get_mouse_delta
:classmethod:

```{autodoc2-docstring} simvx.core.input.state.Input.get_mouse_delta
```

````

````{py:method} get_scroll_delta() -> tuple[float, float]
:canonical: simvx.core.input.state.Input.get_scroll_delta
:classmethod:

```{autodoc2-docstring} simvx.core.input.state.Input.get_scroll_delta
```

````

````{py:method} set_touch_emulation(enabled: bool = True)
:canonical: simvx.core.input.state.Input.set_touch_emulation
:classmethod:

```{autodoc2-docstring} simvx.core.input.state.Input.set_touch_emulation
```

````

````{py:method} set_mouse_capture_mode(mode: simvx.core.input.enums.MouseCaptureMode)
:canonical: simvx.core.input.state.Input.set_mouse_capture_mode
:classmethod:

```{autodoc2-docstring} simvx.core.input.state.Input.set_mouse_capture_mode
```

````

````{py:method} get_mouse_capture_mode() -> simvx.core.input.enums.MouseCaptureMode
:canonical: simvx.core.input.state.Input.get_mouse_capture_mode
:classmethod:

```{autodoc2-docstring} simvx.core.input.state.Input.get_mouse_capture_mode
```

````

````{py:method} get_gamepad_axis(pad_id: int = 0, axis: str | simvx.core.input.enums.JoyAxis = 'left_x') -> float
:canonical: simvx.core.input.state.Input.get_gamepad_axis
:classmethod:

```{autodoc2-docstring} simvx.core.input.state.Input.get_gamepad_axis
```

````

````{py:method} is_gamepad_pressed(pad_id: int = 0, button: str | simvx.core.input.enums.JoyButton = 'a') -> bool
:canonical: simvx.core.input.state.Input.is_gamepad_pressed
:classmethod:

```{autodoc2-docstring} simvx.core.input.state.Input.is_gamepad_pressed
```

````

````{py:method} get_gamepad_vector(pad_id: int = 0, stick: str = 'left') -> simvx.core.math.types.Vec2
:canonical: simvx.core.input.state.Input.get_gamepad_vector
:classmethod:

```{autodoc2-docstring} simvx.core.input.state.Input.get_gamepad_vector
```

````

````{py:method} inject_key(key: int | simvx.core.input.enums.Key, pressed: bool) -> None
:canonical: simvx.core.input.state.Input.inject_key
:classmethod:

```{autodoc2-docstring} simvx.core.input.state.Input.inject_key
```

````

````{py:method} inject_mouse_button(button: int | simvx.core.input.enums.MouseButton, pressed: bool) -> None
:canonical: simvx.core.input.state.Input.inject_mouse_button
:classmethod:

```{autodoc2-docstring} simvx.core.input.state.Input.inject_mouse_button
```

````

````{py:method} get_touches() -> dict[int, tuple[float, float, float]]
:canonical: simvx.core.input.state.Input.get_touches
:classmethod:

```{autodoc2-docstring} simvx.core.input.state.Input.get_touches
```

````

````{py:method} get_touches_just_pressed() -> dict[int, tuple[float, float, float]]
:canonical: simvx.core.input.state.Input.get_touches_just_pressed
:classmethod:

```{autodoc2-docstring} simvx.core.input.state.Input.get_touches_just_pressed
```

````

````{py:method} get_touches_just_released() -> set[int]
:canonical: simvx.core.input.state.Input.get_touches_just_released
:classmethod:

```{autodoc2-docstring} simvx.core.input.state.Input.get_touches_just_released
```

````

````{py:method} get_touch_positions() -> list[tuple[int, float, float, float]]
:canonical: simvx.core.input.state.Input.get_touch_positions
:staticmethod:

```{autodoc2-docstring} simvx.core.input.state.Input.get_touch_positions
```

````

````{py:method} is_touch_pressed(finger_id: int = 0) -> bool
:canonical: simvx.core.input.state.Input.is_touch_pressed
:staticmethod:

```{autodoc2-docstring} simvx.core.input.state.Input.is_touch_pressed
```

````

````{py:method} get_touch_count() -> int
:canonical: simvx.core.input.state.Input.get_touch_count
:staticmethod:

```{autodoc2-docstring} simvx.core.input.state.Input.get_touch_count
```

````

`````