# {py:mod}`simvx.graphics.renderer.text_pass`

```{py:module} simvx.graphics.renderer.text_pass
```

```{autodoc2-docstring} simvx.graphics.renderer.text_pass
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`TextPass <simvx.graphics.renderer.text_pass.TextPass>`
  - ```{autodoc2-docstring} simvx.graphics.renderer.text_pass.TextPass
    :summary:
    ```
````

### Data

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

* - {py:obj}`__all__ <simvx.graphics.renderer.text_pass.__all__>`
  - ```{autodoc2-docstring} simvx.graphics.renderer.text_pass.__all__
    :summary:
    ```
* - {py:obj}`log <simvx.graphics.renderer.text_pass.log>`
  - ```{autodoc2-docstring} simvx.graphics.renderer.text_pass.log
    :summary:
    ```
* - {py:obj}`SHADER_DIR <simvx.graphics.renderer.text_pass.SHADER_DIR>`
  - ```{autodoc2-docstring} simvx.graphics.renderer.text_pass.SHADER_DIR
    :summary:
    ```
* - {py:obj}`VERTEX_STRIDE <simvx.graphics.renderer.text_pass.VERTEX_STRIDE>`
  - ```{autodoc2-docstring} simvx.graphics.renderer.text_pass.VERTEX_STRIDE
    :summary:
    ```
* - {py:obj}`MAX_CHARS <simvx.graphics.renderer.text_pass.MAX_CHARS>`
  - ```{autodoc2-docstring} simvx.graphics.renderer.text_pass.MAX_CHARS
    :summary:
    ```
* - {py:obj}`VERTEX_BUF_SIZE <simvx.graphics.renderer.text_pass.VERTEX_BUF_SIZE>`
  - ```{autodoc2-docstring} simvx.graphics.renderer.text_pass.VERTEX_BUF_SIZE
    :summary:
    ```
* - {py:obj}`INDEX_BUF_SIZE <simvx.graphics.renderer.text_pass.INDEX_BUF_SIZE>`
  - ```{autodoc2-docstring} simvx.graphics.renderer.text_pass.INDEX_BUF_SIZE
    :summary:
    ```
````

### API

````{py:data} __all__
:canonical: simvx.graphics.renderer.text_pass.__all__
:value: >
   ['TextPass']

```{autodoc2-docstring} simvx.graphics.renderer.text_pass.__all__
```

````

````{py:data} log
:canonical: simvx.graphics.renderer.text_pass.log
:value: >
   'getLogger(...)'

```{autodoc2-docstring} simvx.graphics.renderer.text_pass.log
```

````

````{py:data} SHADER_DIR
:canonical: simvx.graphics.renderer.text_pass.SHADER_DIR
:value: >
   None

```{autodoc2-docstring} simvx.graphics.renderer.text_pass.SHADER_DIR
```

````

````{py:data} VERTEX_STRIDE
:canonical: simvx.graphics.renderer.text_pass.VERTEX_STRIDE
:value: >
   32

```{autodoc2-docstring} simvx.graphics.renderer.text_pass.VERTEX_STRIDE
```

````

````{py:data} MAX_CHARS
:canonical: simvx.graphics.renderer.text_pass.MAX_CHARS
:value: >
   4096

```{autodoc2-docstring} simvx.graphics.renderer.text_pass.MAX_CHARS
```

````

````{py:data} VERTEX_BUF_SIZE
:canonical: simvx.graphics.renderer.text_pass.VERTEX_BUF_SIZE
:value: >
   None

```{autodoc2-docstring} simvx.graphics.renderer.text_pass.VERTEX_BUF_SIZE
```

````

````{py:data} INDEX_BUF_SIZE
:canonical: simvx.graphics.renderer.text_pass.INDEX_BUF_SIZE
:value: >
   None

```{autodoc2-docstring} simvx.graphics.renderer.text_pass.INDEX_BUF_SIZE
```

````

`````{py:class} TextPass(engine: typing.Any)
:canonical: simvx.graphics.renderer.text_pass.TextPass

```{autodoc2-docstring} simvx.graphics.renderer.text_pass.TextPass
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.graphics.renderer.text_pass.TextPass.__init__
```

````{py:method} setup() -> None
:canonical: simvx.graphics.renderer.text_pass.TextPass.setup

```{autodoc2-docstring} simvx.graphics.renderer.text_pass.TextPass.setup
```

````

````{py:property} pipeline
:canonical: simvx.graphics.renderer.text_pass.TextPass.pipeline
:type: typing.Any

```{autodoc2-docstring} simvx.graphics.renderer.text_pass.TextPass.pipeline
```

````

````{py:property} pipeline_layout
:canonical: simvx.graphics.renderer.text_pass.TextPass.pipeline_layout
:type: typing.Any

```{autodoc2-docstring} simvx.graphics.renderer.text_pass.TextPass.pipeline_layout
```

````

````{py:property} descriptor_set
:canonical: simvx.graphics.renderer.text_pass.TextPass.descriptor_set
:type: typing.Any

```{autodoc2-docstring} simvx.graphics.renderer.text_pass.TextPass.descriptor_set
```

````

````{py:property} px_range
:canonical: simvx.graphics.renderer.text_pass.TextPass.px_range
:type: float

```{autodoc2-docstring} simvx.graphics.renderer.text_pass.TextPass.px_range
```

````

````{py:property} atlas_version
:canonical: simvx.graphics.renderer.text_pass.TextPass.atlas_version
:type: int

```{autodoc2-docstring} simvx.graphics.renderer.text_pass.TextPass.atlas_version
```

````

````{py:method} upload_atlas_if_dirty() -> None
:canonical: simvx.graphics.renderer.text_pass.TextPass.upload_atlas_if_dirty

```{autodoc2-docstring} simvx.graphics.renderer.text_pass.TextPass.upload_atlas_if_dirty
```

````

````{py:method} upload_atlas(atlas_data: numpy.ndarray, version: int = 1, px_range: float = 4.0) -> None
:canonical: simvx.graphics.renderer.text_pass.TextPass.upload_atlas

```{autodoc2-docstring} simvx.graphics.renderer.text_pass.TextPass.upload_atlas
```

````

````{py:method} upload_geometry(vertices: numpy.ndarray, indices: numpy.ndarray) -> None
:canonical: simvx.graphics.renderer.text_pass.TextPass.upload_geometry

```{autodoc2-docstring} simvx.graphics.renderer.text_pass.TextPass.upload_geometry
```

````

````{py:method} render(cmd: typing.Any, width: int, height: int) -> None
:canonical: simvx.graphics.renderer.text_pass.TextPass.render

```{autodoc2-docstring} simvx.graphics.renderer.text_pass.TextPass.render
```

````

````{py:method} cleanup() -> None
:canonical: simvx.graphics.renderer.text_pass.TextPass.cleanup

```{autodoc2-docstring} simvx.graphics.renderer.text_pass.TextPass.cleanup
```

````

`````