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

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

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

## Module Contents

### Classes

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

* - {py:obj}`InputBinding <simvx.core.input.events.InputBinding>`
  - ```{autodoc2-docstring} simvx.core.input.events.InputBinding
    :summary:
    ```
* - {py:obj}`InputEventKey <simvx.core.input.events.InputEventKey>`
  - ```{autodoc2-docstring} simvx.core.input.events.InputEventKey
    :summary:
    ```
* - {py:obj}`InputEventMouse <simvx.core.input.events.InputEventMouse>`
  - ```{autodoc2-docstring} simvx.core.input.events.InputEventMouse
    :summary:
    ```
````

### API

`````{py:class} InputBinding
:canonical: simvx.core.input.events.InputBinding

```{autodoc2-docstring} simvx.core.input.events.InputBinding
```

````{py:attribute} key
:canonical: simvx.core.input.events.InputBinding.key
:type: simvx.core.input.enums.Key | None
:value: >
   None

```{autodoc2-docstring} simvx.core.input.events.InputBinding.key
```

````

````{py:attribute} mouse_button
:canonical: simvx.core.input.events.InputBinding.mouse_button
:type: simvx.core.input.enums.MouseButton | None
:value: >
   None

```{autodoc2-docstring} simvx.core.input.events.InputBinding.mouse_button
```

````

````{py:attribute} joy_button
:canonical: simvx.core.input.events.InputBinding.joy_button
:type: simvx.core.input.enums.JoyButton | None
:value: >
   None

```{autodoc2-docstring} simvx.core.input.events.InputBinding.joy_button
```

````

````{py:attribute} joy_axis
:canonical: simvx.core.input.events.InputBinding.joy_axis
:type: simvx.core.input.enums.JoyAxis | None
:value: >
   None

```{autodoc2-docstring} simvx.core.input.events.InputBinding.joy_axis
```

````

````{py:attribute} joy_axis_positive
:canonical: simvx.core.input.events.InputBinding.joy_axis_positive
:type: bool
:value: >
   True

```{autodoc2-docstring} simvx.core.input.events.InputBinding.joy_axis_positive
```

````

````{py:attribute} deadzone
:canonical: simvx.core.input.events.InputBinding.deadzone
:type: float
:value: >
   0.2

```{autodoc2-docstring} simvx.core.input.events.InputBinding.deadzone
```

````

`````

`````{py:class} InputEventKey(key: simvx.core.input.enums.Key, pressed: bool, echo: bool = False, shift: bool = False, ctrl: bool = False, alt: bool = False)
:canonical: simvx.core.input.events.InputEventKey

```{autodoc2-docstring} simvx.core.input.events.InputEventKey
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.input.events.InputEventKey.__init__
```

````{py:attribute} __slots__
:canonical: simvx.core.input.events.InputEventKey.__slots__
:value: >
   ('key', 'pressed', 'echo', 'shift', 'ctrl', 'alt', 'handled')

```{autodoc2-docstring} simvx.core.input.events.InputEventKey.__slots__
```

````

````{py:method} __repr__() -> str
:canonical: simvx.core.input.events.InputEventKey.__repr__

````

`````

`````{py:class} InputEventMouse(button: simvx.core.input.enums.MouseButton, pressed: bool, position: tuple[float, float] = (0.0, 0.0), shift: bool = False, ctrl: bool = False, alt: bool = False)
:canonical: simvx.core.input.events.InputEventMouse

```{autodoc2-docstring} simvx.core.input.events.InputEventMouse
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.input.events.InputEventMouse.__init__
```

````{py:attribute} __slots__
:canonical: simvx.core.input.events.InputEventMouse.__slots__
:value: >
   ('button', 'pressed', 'position', 'shift', 'ctrl', 'alt', 'handled')

```{autodoc2-docstring} simvx.core.input.events.InputEventMouse.__slots__
```

````

````{py:method} __repr__() -> str
:canonical: simvx.core.input.events.InputEventMouse.__repr__

````

`````