---
orphan: true
---

# {py:mod}`simvx.graphics.platform._base`

```{py:module} simvx.graphics.platform._base
```

```{autodoc2-docstring} simvx.graphics.platform._base
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`WindowBackend <simvx.graphics.platform._base.WindowBackend>`
  - ```{autodoc2-docstring} simvx.graphics.platform._base.WindowBackend
    :summary:
    ```
````

### Data

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

* - {py:obj}`__all__ <simvx.graphics.platform._base.__all__>`
  - ```{autodoc2-docstring} simvx.graphics.platform._base.__all__
    :summary:
    ```
````

### API

````{py:data} __all__
:canonical: simvx.graphics.platform._base.__all__
:value: >
   ['WindowBackend']

```{autodoc2-docstring} simvx.graphics.platform._base.__all__
```

````

`````{py:class} WindowBackend
:canonical: simvx.graphics.platform._base.WindowBackend

Bases: {py:obj}`typing.Protocol`

```{autodoc2-docstring} simvx.graphics.platform._base.WindowBackend
```

````{py:method} create_window(width: int, height: int, title: str, *, visible: bool = True) -> None
:canonical: simvx.graphics.platform._base.WindowBackend.create_window

```{autodoc2-docstring} simvx.graphics.platform._base.WindowBackend.create_window
```

````

````{py:method} set_window_size(width: int, height: int) -> None
:canonical: simvx.graphics.platform._base.WindowBackend.set_window_size

```{autodoc2-docstring} simvx.graphics.platform._base.WindowBackend.set_window_size
```

````

````{py:method} create_vulkan_surface(instance: typing.Any) -> typing.Any
:canonical: simvx.graphics.platform._base.WindowBackend.create_vulkan_surface

```{autodoc2-docstring} simvx.graphics.platform._base.WindowBackend.create_vulkan_surface
```

````

````{py:method} get_required_extensions() -> list[str]
:canonical: simvx.graphics.platform._base.WindowBackend.get_required_extensions

```{autodoc2-docstring} simvx.graphics.platform._base.WindowBackend.get_required_extensions
```

````

````{py:method} poll_events() -> None
:canonical: simvx.graphics.platform._base.WindowBackend.poll_events

```{autodoc2-docstring} simvx.graphics.platform._base.WindowBackend.poll_events
```

````

````{py:method} should_close() -> bool
:canonical: simvx.graphics.platform._base.WindowBackend.should_close

```{autodoc2-docstring} simvx.graphics.platform._base.WindowBackend.should_close
```

````

````{py:method} get_framebuffer_size() -> tuple[int, int]
:canonical: simvx.graphics.platform._base.WindowBackend.get_framebuffer_size

```{autodoc2-docstring} simvx.graphics.platform._base.WindowBackend.get_framebuffer_size
```

````

````{py:method} get_window_size() -> tuple[int, int]
:canonical: simvx.graphics.platform._base.WindowBackend.get_window_size

```{autodoc2-docstring} simvx.graphics.platform._base.WindowBackend.get_window_size
```

````

````{py:method} set_key_callback(callback: collections.abc.Callable[[int, int, int], None] | None) -> None
:canonical: simvx.graphics.platform._base.WindowBackend.set_key_callback

```{autodoc2-docstring} simvx.graphics.platform._base.WindowBackend.set_key_callback
```

````

````{py:method} set_mouse_button_callback(callback: collections.abc.Callable[[int, int, int], None] | None) -> None
:canonical: simvx.graphics.platform._base.WindowBackend.set_mouse_button_callback

```{autodoc2-docstring} simvx.graphics.platform._base.WindowBackend.set_mouse_button_callback
```

````

````{py:method} set_cursor_pos_callback(callback: collections.abc.Callable[[float, float], None] | None) -> None
:canonical: simvx.graphics.platform._base.WindowBackend.set_cursor_pos_callback

```{autodoc2-docstring} simvx.graphics.platform._base.WindowBackend.set_cursor_pos_callback
```

````

````{py:method} set_char_callback(callback: collections.abc.Callable[[int], None] | None) -> None
:canonical: simvx.graphics.platform._base.WindowBackend.set_char_callback

```{autodoc2-docstring} simvx.graphics.platform._base.WindowBackend.set_char_callback
```

````

````{py:method} get_cursor_pos() -> tuple[float, float]
:canonical: simvx.graphics.platform._base.WindowBackend.get_cursor_pos

```{autodoc2-docstring} simvx.graphics.platform._base.WindowBackend.get_cursor_pos
```

````

````{py:method} set_cursor_shape(shape: int) -> None
:canonical: simvx.graphics.platform._base.WindowBackend.set_cursor_shape

```{autodoc2-docstring} simvx.graphics.platform._base.WindowBackend.set_cursor_shape
```

````

````{py:method} destroy() -> None
:canonical: simvx.graphics.platform._base.WindowBackend.destroy

```{autodoc2-docstring} simvx.graphics.platform._base.WindowBackend.destroy
```

````

````{py:attribute} __slots__
:canonical: simvx.graphics.platform._base.WindowBackend.__slots__
:value: >
   ()

````

````{py:method} __init_subclass__(*args, **kwargs)
:canonical: simvx.graphics.platform._base.WindowBackend.__init_subclass__
:classmethod:

````

````{py:method} __class_getitem__(item)
:canonical: simvx.graphics.platform._base.WindowBackend.__class_getitem__
:classmethod:

````

`````