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

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

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

## Module Contents

### Classes

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

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

### Functions

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

* - {py:obj}`find_font_path <simvx.graphics.text_utils.find_font_path>`
  - ```{autodoc2-docstring} simvx.graphics.text_utils.find_font_path
    :summary:
    ```
* - {py:obj}`rasterize_text <simvx.graphics.text_utils.rasterize_text>`
  - ```{autodoc2-docstring} simvx.graphics.text_utils.rasterize_text
    :summary:
    ```
* - {py:obj}`create_text_texture <simvx.graphics.text_utils.create_text_texture>`
  - ```{autodoc2-docstring} simvx.graphics.text_utils.create_text_texture
    :summary:
    ```
````

### Data

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

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

### API

````{py:data} __all__
:canonical: simvx.graphics.text_utils.__all__
:value: >
   ['TextTexture', 'create_text_texture', 'find_font_path', 'rasterize_text']

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

````

````{py:function} find_font_path() -> str
:canonical: simvx.graphics.text_utils.find_font_path

```{autodoc2-docstring} simvx.graphics.text_utils.find_font_path
```
````

````{py:function} rasterize_text(text: str, atlas: typing.Any, font_size: int, width: int, height: int, colour: tuple) -> numpy.ndarray
:canonical: simvx.graphics.text_utils.rasterize_text

```{autodoc2-docstring} simvx.graphics.text_utils.rasterize_text
```
````

`````{py:class} TextTexture(ctx: simvx.graphics.gpu.context.GPUContext, register_texture: typing.Any, texture_descriptor_set: typing.Any, default_sampler: typing.Any, font: str | None = None, size: int = 32, width: int = 256, height: int = 64)
:canonical: simvx.graphics.text_utils.TextTexture

```{autodoc2-docstring} simvx.graphics.text_utils.TextTexture
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.graphics.text_utils.TextTexture.__init__
```

````{py:property} text
:canonical: simvx.graphics.text_utils.TextTexture.text
:type: str

```{autodoc2-docstring} simvx.graphics.text_utils.TextTexture.text
```

````

````{py:property} colour
:canonical: simvx.graphics.text_utils.TextTexture.colour
:type: tuple

```{autodoc2-docstring} simvx.graphics.text_utils.TextTexture.colour
```

````

`````

````{py:function} create_text_texture(ctx: simvx.graphics.gpu.context.GPUContext, register_texture: typing.Any, texture_descriptor_set: typing.Any, default_sampler: typing.Any, font: str | None = None, size: int = 32, width: int = 256, height: int = 64) -> simvx.graphics.text_utils.TextTexture
:canonical: simvx.graphics.text_utils.create_text_texture

```{autodoc2-docstring} simvx.graphics.text_utils.create_text_texture
```
````