# {py:mod}`simvx.graphics.text_renderer`

```{py:module} simvx.graphics.text_renderer
```

```{autodoc2-docstring} simvx.graphics.text_renderer
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`TextRenderer <simvx.graphics.text_renderer.TextRenderer>`
  - ```{autodoc2-docstring} simvx.graphics.text_renderer.TextRenderer
    :summary:
    ```
````

### Functions

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

* - {py:obj}`get_shared_text_renderer <simvx.graphics.text_renderer.get_shared_text_renderer>`
  - ```{autodoc2-docstring} simvx.graphics.text_renderer.get_shared_text_renderer
    :summary:
    ```
````

### Data

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

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

### API

````{py:data} __all__
:canonical: simvx.graphics.text_renderer.__all__
:value: >
   ['TextRenderer', '_find_font', 'get_shared_text_renderer']

```{autodoc2-docstring} simvx.graphics.text_renderer.__all__
```

````

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

```{autodoc2-docstring} simvx.graphics.text_renderer.log
```

````

`````{py:class} TextRenderer(max_chars: int = 4096)
:canonical: simvx.graphics.text_renderer.TextRenderer

```{autodoc2-docstring} simvx.graphics.text_renderer.TextRenderer
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.graphics.text_renderer.TextRenderer.__init__
```

````{py:method} get_atlas(font_path: str, font_size: int = 64) -> simvx.core.text.MSDFAtlas
:canonical: simvx.graphics.text_renderer.TextRenderer.get_atlas

```{autodoc2-docstring} simvx.graphics.text_renderer.TextRenderer.get_atlas
```

````

````{py:method} begin_frame() -> None
:canonical: simvx.graphics.text_renderer.TextRenderer.begin_frame

```{autodoc2-docstring} simvx.graphics.text_renderer.TextRenderer.begin_frame
```

````

````{py:method} draw_text(text: str, x: float, y: float, font_path: str | None = None, size: float = 24.0, color: tuple[float, ...] = (1.0, 1.0, 1.0, 1.0), font_size: int = 48) -> None
:canonical: simvx.graphics.text_renderer.TextRenderer.draw_text

```{autodoc2-docstring} simvx.graphics.text_renderer.TextRenderer.draw_text
```

````

````{py:method} get_vertices() -> numpy.ndarray
:canonical: simvx.graphics.text_renderer.TextRenderer.get_vertices

```{autodoc2-docstring} simvx.graphics.text_renderer.TextRenderer.get_vertices
```

````

````{py:method} get_indices() -> numpy.ndarray
:canonical: simvx.graphics.text_renderer.TextRenderer.get_indices

```{autodoc2-docstring} simvx.graphics.text_renderer.TextRenderer.get_indices
```

````

````{py:property} char_count
:canonical: simvx.graphics.text_renderer.TextRenderer.char_count
:type: int

```{autodoc2-docstring} simvx.graphics.text_renderer.TextRenderer.char_count
```

````

````{py:property} has_text
:canonical: simvx.graphics.text_renderer.TextRenderer.has_text
:type: bool

```{autodoc2-docstring} simvx.graphics.text_renderer.TextRenderer.has_text
```

````

````{py:property} atlas_version
:canonical: simvx.graphics.text_renderer.TextRenderer.atlas_version
:type: int

```{autodoc2-docstring} simvx.graphics.text_renderer.TextRenderer.atlas_version
```

````

`````

````{py:function} get_shared_text_renderer() -> simvx.graphics.text_renderer.TextRenderer
:canonical: simvx.graphics.text_renderer.get_shared_text_renderer

```{autodoc2-docstring} simvx.graphics.text_renderer.get_shared_text_renderer
```
````