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

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

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

## Module Contents

### Functions

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

* - {py:obj}`button_label <simvx.core.input.prompts.button_label>`
  - ```{autodoc2-docstring} simvx.core.input.prompts.button_label
    :summary:
    ```
* - {py:obj}`axis_label <simvx.core.input.prompts.axis_label>`
  - ```{autodoc2-docstring} simvx.core.input.prompts.axis_label
    :summary:
    ```
* - {py:obj}`key_binding_label <simvx.core.input.prompts.key_binding_label>`
  - ```{autodoc2-docstring} simvx.core.input.prompts.key_binding_label
    :summary:
    ```
* - {py:obj}`pointer_button_label <simvx.core.input.prompts.pointer_button_label>`
  - ```{autodoc2-docstring} simvx.core.input.prompts.pointer_button_label
    :summary:
    ```
* - {py:obj}`key_label <simvx.core.input.prompts.key_label>`
  - ```{autodoc2-docstring} simvx.core.input.prompts.key_label
    :summary:
    ```
````

### Data

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

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

### API

````{py:data} __all__
:canonical: simvx.core.input.prompts.__all__
:value: >
   ['axis_label', 'button_label', 'key_binding_label', 'key_label', 'pointer_button_label']

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

````

````{py:function} button_label(button: simvx.core.input.controls.DeviceButton, family: simvx.core.input.enums.ControllerFamily = ControllerFamily.GENERIC) -> str
:canonical: simvx.core.input.prompts.button_label

```{autodoc2-docstring} simvx.core.input.prompts.button_label
```
````

````{py:function} axis_label(axis: simvx.core.input.controls.DeviceAxis, family: simvx.core.input.enums.ControllerFamily = ControllerFamily.GENERIC, *, positive: bool | None = None) -> str
:canonical: simvx.core.input.prompts.axis_label

```{autodoc2-docstring} simvx.core.input.prompts.axis_label
```
````

````{py:function} key_binding_label(key_combo: str) -> str
:canonical: simvx.core.input.prompts.key_binding_label

```{autodoc2-docstring} simvx.core.input.prompts.key_binding_label
```
````

````{py:function} pointer_button_label(button: simvx.core.input.controls.DeviceButton) -> str
:canonical: simvx.core.input.prompts.pointer_button_label

```{autodoc2-docstring} simvx.core.input.prompts.pointer_button_label
```
````

````{py:function} key_label(key: simvx.core.input.controls.DeviceButton) -> str
:canonical: simvx.core.input.prompts.key_label

```{autodoc2-docstring} simvx.core.input.prompts.key_label
```
````