---
orphan: true
---

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

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

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

## Module Contents

### Classes

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

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

### Data

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

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

### API

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

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

````

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

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

````

`````{py:class} Renderer
:canonical: simvx.graphics.renderer._base.Renderer

Bases: {py:obj}`abc.ABC`

```{autodoc2-docstring} simvx.graphics.renderer._base.Renderer
```

````{py:method} begin_frame() -> None
:canonical: simvx.graphics.renderer._base.Renderer.begin_frame
:abstractmethod:

```{autodoc2-docstring} simvx.graphics.renderer._base.Renderer.begin_frame
```

````

````{py:method} pre_render(cmd: typing.Any) -> None
:canonical: simvx.graphics.renderer._base.Renderer.pre_render
:abstractmethod:

```{autodoc2-docstring} simvx.graphics.renderer._base.Renderer.pre_render
```

````

````{py:method} render(cmd: typing.Any) -> None
:canonical: simvx.graphics.renderer._base.Renderer.render
:abstractmethod:

```{autodoc2-docstring} simvx.graphics.renderer._base.Renderer.render
```

````

````{py:method} resize(width: int, height: int) -> None
:canonical: simvx.graphics.renderer._base.Renderer.resize
:abstractmethod:

```{autodoc2-docstring} simvx.graphics.renderer._base.Renderer.resize
```

````

````{py:method} destroy() -> None
:canonical: simvx.graphics.renderer._base.Renderer.destroy
:abstractmethod:

```{autodoc2-docstring} simvx.graphics.renderer._base.Renderer.destroy
```

````

````{py:method} submit_instance(mesh_handle: simvx.graphics._types.MeshHandle, transform: numpy.ndarray, material_id: int, viewport_id: int = 0) -> None
:canonical: simvx.graphics.renderer._base.Renderer.submit_instance
:abstractmethod:

```{autodoc2-docstring} simvx.graphics.renderer._base.Renderer.submit_instance
```

````

````{py:method} submit_multimesh(mesh_handle: simvx.graphics._types.MeshHandle, transforms: numpy.ndarray, material_id: int = 0, material_ids: numpy.ndarray | None = None, viewport_id: int = 0, count: int = 0) -> None
:canonical: simvx.graphics.renderer._base.Renderer.submit_multimesh
:abstractmethod:

```{autodoc2-docstring} simvx.graphics.renderer._base.Renderer.submit_multimesh
```

````

````{py:method} submit_skinned_instance(mesh_handle: simvx.graphics._types.MeshHandle, transform: numpy.ndarray, material_id: int, joint_matrices: numpy.ndarray) -> None
:canonical: simvx.graphics.renderer._base.Renderer.submit_skinned_instance
:abstractmethod:

```{autodoc2-docstring} simvx.graphics.renderer._base.Renderer.submit_skinned_instance
```

````

````{py:method} set_materials(materials: numpy.ndarray) -> None
:canonical: simvx.graphics.renderer._base.Renderer.set_materials
:abstractmethod:

```{autodoc2-docstring} simvx.graphics.renderer._base.Renderer.set_materials
```

````

````{py:method} set_lights(lights: numpy.ndarray) -> None
:canonical: simvx.graphics.renderer._base.Renderer.set_lights
:abstractmethod:

```{autodoc2-docstring} simvx.graphics.renderer._base.Renderer.set_lights
```

````

````{py:method} submit_text(text: str, x: float, y: float, size: float, colour: tuple[float, float, float, float], **kwargs: typing.Any) -> None
:canonical: simvx.graphics.renderer._base.Renderer.submit_text
:abstractmethod:

```{autodoc2-docstring} simvx.graphics.renderer._base.Renderer.submit_text
```

````

````{py:method} submit_particles(particle_data: numpy.ndarray) -> None
:canonical: simvx.graphics.renderer._base.Renderer.submit_particles
:abstractmethod:

```{autodoc2-docstring} simvx.graphics.renderer._base.Renderer.submit_particles
```

````

````{py:method} submit_light2d(**kwargs: typing.Any) -> None
:canonical: simvx.graphics.renderer._base.Renderer.submit_light2d
:abstractmethod:

```{autodoc2-docstring} simvx.graphics.renderer._base.Renderer.submit_light2d
```

````

````{py:method} register_mesh(vertices: numpy.ndarray, indices: numpy.ndarray) -> simvx.graphics._types.MeshHandle
:canonical: simvx.graphics.renderer._base.Renderer.register_mesh
:abstractmethod:

```{autodoc2-docstring} simvx.graphics.renderer._base.Renderer.register_mesh
```

````

````{py:method} register_texture(pixels: numpy.ndarray, width: int, height: int) -> int
:canonical: simvx.graphics.renderer._base.Renderer.register_texture
:abstractmethod:

```{autodoc2-docstring} simvx.graphics.renderer._base.Renderer.register_texture
```

````

````{py:method} capture_frame() -> numpy.ndarray
:canonical: simvx.graphics.renderer._base.Renderer.capture_frame
:abstractmethod:

```{autodoc2-docstring} simvx.graphics.renderer._base.Renderer.capture_frame
```

````

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

````

`````