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

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

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

## Module Contents

### Functions

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

* - {py:obj}`normalise_buttons <simvx.core.input.gamepad.normalise_buttons>`
  - ```{autodoc2-docstring} simvx.core.input.gamepad.normalise_buttons
    :summary:
    ```
* - {py:obj}`normalise_axes <simvx.core.input.gamepad.normalise_axes>`
  - ```{autodoc2-docstring} simvx.core.input.gamepad.normalise_axes
    :summary:
    ```
* - {py:obj}`out_of_range_axes <simvx.core.input.gamepad.out_of_range_axes>`
  - ```{autodoc2-docstring} simvx.core.input.gamepad.out_of_range_axes
    :summary:
    ```
````

### Data

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

* - {py:obj}`__all__ <simvx.core.input.gamepad.__all__>`
  - ```{autodoc2-docstring} simvx.core.input.gamepad.__all__
    :summary:
    ```
* - {py:obj}`BUTTON_NAMES <simvx.core.input.gamepad.BUTTON_NAMES>`
  - ```{autodoc2-docstring} simvx.core.input.gamepad.BUTTON_NAMES
    :summary:
    ```
* - {py:obj}`STICK_NAMES <simvx.core.input.gamepad.STICK_NAMES>`
  - ```{autodoc2-docstring} simvx.core.input.gamepad.STICK_NAMES
    :summary:
    ```
* - {py:obj}`TRIGGER_NAMES <simvx.core.input.gamepad.TRIGGER_NAMES>`
  - ```{autodoc2-docstring} simvx.core.input.gamepad.TRIGGER_NAMES
    :summary:
    ```
* - {py:obj}`AXIS_NAMES <simvx.core.input.gamepad.AXIS_NAMES>`
  - ```{autodoc2-docstring} simvx.core.input.gamepad.AXIS_NAMES
    :summary:
    ```
````

### API

````{py:data} __all__
:canonical: simvx.core.input.gamepad.__all__
:value: >
   ['AXIS_NAMES', 'BUTTON_NAMES', 'STICK_NAMES', 'TRIGGER_NAMES', 'normalise_axes', 'normalise_buttons'...

```{autodoc2-docstring} simvx.core.input.gamepad.__all__
```

````

````{py:data} BUTTON_NAMES
:canonical: simvx.core.input.gamepad.BUTTON_NAMES
:type: tuple[str, ...]
:value: >
   ('a', 'b', 'x', 'y', 'lb', 'rb', 'back', 'start', 'guide', 'l3', 'r3', 'dpad_up', 'dpad_right', 'dpa...

```{autodoc2-docstring} simvx.core.input.gamepad.BUTTON_NAMES
```

````

````{py:data} STICK_NAMES
:canonical: simvx.core.input.gamepad.STICK_NAMES
:type: tuple[str, ...]
:value: >
   ('left_x', 'left_y', 'right_x', 'right_y')

```{autodoc2-docstring} simvx.core.input.gamepad.STICK_NAMES
```

````

````{py:data} TRIGGER_NAMES
:canonical: simvx.core.input.gamepad.TRIGGER_NAMES
:type: tuple[str, ...]
:value: >
   ('lt', 'rt')

```{autodoc2-docstring} simvx.core.input.gamepad.TRIGGER_NAMES
```

````

````{py:data} AXIS_NAMES
:canonical: simvx.core.input.gamepad.AXIS_NAMES
:type: tuple[str, ...]
:value: >
   None

```{autodoc2-docstring} simvx.core.input.gamepad.AXIS_NAMES
```

````

````{py:function} normalise_buttons(raw: collections.abc.Mapping[str, object]) -> dict[str, bool]
:canonical: simvx.core.input.gamepad.normalise_buttons

```{autodoc2-docstring} simvx.core.input.gamepad.normalise_buttons
```
````

````{py:function} normalise_axes(raw: collections.abc.Mapping[str, float], *, stick_scale: float, trigger_range: tuple[float, float]) -> dict[str, float]
:canonical: simvx.core.input.gamepad.normalise_axes

```{autodoc2-docstring} simvx.core.input.gamepad.normalise_axes
```
````

````{py:function} out_of_range_axes(axes: collections.abc.Mapping[str, float]) -> list[str]
:canonical: simvx.core.input.gamepad.out_of_range_axes

```{autodoc2-docstring} simvx.core.input.gamepad.out_of_range_axes
```
````