# {py:mod}`simvx.graphics.ui.ui_pass`

```{py:module} simvx.graphics.ui.ui_pass
```

```{autodoc2-docstring} simvx.graphics.ui.ui_pass
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`UIPass <simvx.graphics.ui.ui_pass.UIPass>`
  - ```{autodoc2-docstring} simvx.graphics.ui.ui_pass.UIPass
    :summary:
    ```
* - {py:obj}`TextButton <simvx.graphics.ui.ui_pass.TextButton>`
  - ```{autodoc2-docstring} simvx.graphics.ui.ui_pass.TextButton
    :summary:
    ```
````

### Data

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

* - {py:obj}`__all__ <simvx.graphics.ui.ui_pass.__all__>`
  - ```{autodoc2-docstring} simvx.graphics.ui.ui_pass.__all__
    :summary:
    ```
* - {py:obj}`UI_VERTEX_DTYPE <simvx.graphics.ui.ui_pass.UI_VERTEX_DTYPE>`
  - ```{autodoc2-docstring} simvx.graphics.ui.ui_pass.UI_VERTEX_DTYPE
    :summary:
    ```
* - {py:obj}`MAX_UI_VERTICES <simvx.graphics.ui.ui_pass.MAX_UI_VERTICES>`
  - ```{autodoc2-docstring} simvx.graphics.ui.ui_pass.MAX_UI_VERTICES
    :summary:
    ```
* - {py:obj}`GLYPH_WIDTH <simvx.graphics.ui.ui_pass.GLYPH_WIDTH>`
  - ```{autodoc2-docstring} simvx.graphics.ui.ui_pass.GLYPH_WIDTH
    :summary:
    ```
* - {py:obj}`GLYPH_HEIGHT <simvx.graphics.ui.ui_pass.GLYPH_HEIGHT>`
  - ```{autodoc2-docstring} simvx.graphics.ui.ui_pass.GLYPH_HEIGHT
    :summary:
    ```
* - {py:obj}`PIXEL_SCALE <simvx.graphics.ui.ui_pass.PIXEL_SCALE>`
  - ```{autodoc2-docstring} simvx.graphics.ui.ui_pass.PIXEL_SCALE
    :summary:
    ```
````

### API

````{py:data} __all__
:canonical: simvx.graphics.ui.ui_pass.__all__
:value: >
   ['UIPass', 'TextButton']

```{autodoc2-docstring} simvx.graphics.ui.ui_pass.__all__
```

````

````{py:data} UI_VERTEX_DTYPE
:canonical: simvx.graphics.ui.ui_pass.UI_VERTEX_DTYPE
:value: >
   'dtype(...)'

```{autodoc2-docstring} simvx.graphics.ui.ui_pass.UI_VERTEX_DTYPE
```

````

````{py:data} MAX_UI_VERTICES
:canonical: simvx.graphics.ui.ui_pass.MAX_UI_VERTICES
:value: >
   4096

```{autodoc2-docstring} simvx.graphics.ui.ui_pass.MAX_UI_VERTICES
```

````

````{py:data} GLYPH_WIDTH
:canonical: simvx.graphics.ui.ui_pass.GLYPH_WIDTH
:value: >
   6

```{autodoc2-docstring} simvx.graphics.ui.ui_pass.GLYPH_WIDTH
```

````

````{py:data} GLYPH_HEIGHT
:canonical: simvx.graphics.ui.ui_pass.GLYPH_HEIGHT
:value: >
   8

```{autodoc2-docstring} simvx.graphics.ui.ui_pass.GLYPH_HEIGHT
```

````

````{py:data} PIXEL_SCALE
:canonical: simvx.graphics.ui.ui_pass.PIXEL_SCALE
:value: >
   3

```{autodoc2-docstring} simvx.graphics.ui.ui_pass.PIXEL_SCALE
```

````

`````{py:class} UIPass(device: typing.Any, physical_device: typing.Any, extent: tuple[int, int])
:canonical: simvx.graphics.ui.ui_pass.UIPass

```{autodoc2-docstring} simvx.graphics.ui.ui_pass.UIPass
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.graphics.ui.ui_pass.UIPass.__init__
```

````{py:method} create(pipeline: typing.Any, pipeline_layout: typing.Any, vb: tuple[typing.Any, typing.Any] | None = None) -> None
:canonical: simvx.graphics.ui.ui_pass.UIPass.create

```{autodoc2-docstring} simvx.graphics.ui.ui_pass.UIPass.create
```

````

````{py:method} begin_batch() -> None
:canonical: simvx.graphics.ui.ui_pass.UIPass.begin_batch

```{autodoc2-docstring} simvx.graphics.ui.ui_pass.UIPass.begin_batch
```

````

````{py:method} add_quad(x: float, y: float, w: float, h: float, color: tuple[float, ...] | numpy.ndarray = (1.0, 1.0, 1.0, 1.0)) -> None
:canonical: simvx.graphics.ui.ui_pass.UIPass.add_quad

```{autodoc2-docstring} simvx.graphics.ui.ui_pass.UIPass.add_quad
```

````

````{py:method} add_text(text: str, x: float, y: float, color: tuple[float, ...] | numpy.ndarray = (1.0, 1.0, 1.0, 1.0)) -> None
:canonical: simvx.graphics.ui.ui_pass.UIPass.add_text

```{autodoc2-docstring} simvx.graphics.ui.ui_pass.UIPass.add_text
```

````

````{py:method} flush(cmd: typing.Any) -> None
:canonical: simvx.graphics.ui.ui_pass.UIPass.flush

```{autodoc2-docstring} simvx.graphics.ui.ui_pass.UIPass.flush
```

````

````{py:method} resize(extent: tuple[int, int]) -> None
:canonical: simvx.graphics.ui.ui_pass.UIPass.resize

```{autodoc2-docstring} simvx.graphics.ui.ui_pass.UIPass.resize
```

````

````{py:method} destroy() -> None
:canonical: simvx.graphics.ui.ui_pass.UIPass.destroy

```{autodoc2-docstring} simvx.graphics.ui.ui_pass.UIPass.destroy
```

````

`````

`````{py:class} TextButton(text: str, x: float, y: float)
:canonical: simvx.graphics.ui.ui_pass.TextButton

```{autodoc2-docstring} simvx.graphics.ui.ui_pass.TextButton
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.graphics.ui.ui_pass.TextButton.__init__
```

````{py:method} contains(mx: float, my: float) -> bool
:canonical: simvx.graphics.ui.ui_pass.TextButton.contains

```{autodoc2-docstring} simvx.graphics.ui.ui_pass.TextButton.contains
```

````

`````