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

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

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

## Module Contents

### Classes

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

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

### Data

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

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

### API

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

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

````

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

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

````

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

```{autodoc2-docstring} simvx.graphics.renderer.particle_compute.ParticleCompute
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.graphics.renderer.particle_compute.ParticleCompute.__init__
```

````{py:method} setup(max_particles: int = 65536) -> None
:canonical: simvx.graphics.renderer.particle_compute.ParticleCompute.setup

```{autodoc2-docstring} simvx.graphics.renderer.particle_compute.ParticleCompute.setup
```

````

````{py:method} dispatch(cmd: typing.Any, dt: float, emitter_config: dict) -> None
:canonical: simvx.graphics.renderer.particle_compute.ParticleCompute.dispatch

```{autodoc2-docstring} simvx.graphics.renderer.particle_compute.ParticleCompute.dispatch
```

````

````{py:method} get_particle_ssbo() -> typing.Any
:canonical: simvx.graphics.renderer.particle_compute.ParticleCompute.get_particle_ssbo

```{autodoc2-docstring} simvx.graphics.renderer.particle_compute.ParticleCompute.get_particle_ssbo
```

````

````{py:method} get_particle_memory() -> typing.Any
:canonical: simvx.graphics.renderer.particle_compute.ParticleCompute.get_particle_memory

```{autodoc2-docstring} simvx.graphics.renderer.particle_compute.ParticleCompute.get_particle_memory
```

````

````{py:property} max_particles
:canonical: simvx.graphics.renderer.particle_compute.ParticleCompute.max_particles
:type: int

```{autodoc2-docstring} simvx.graphics.renderer.particle_compute.ParticleCompute.max_particles
```

````

````{py:property} ready
:canonical: simvx.graphics.renderer.particle_compute.ParticleCompute.ready
:type: bool

```{autodoc2-docstring} simvx.graphics.renderer.particle_compute.ParticleCompute.ready
```

````

````{py:method} upload_initial_particles(particles: numpy.ndarray) -> None
:canonical: simvx.graphics.renderer.particle_compute.ParticleCompute.upload_initial_particles

```{autodoc2-docstring} simvx.graphics.renderer.particle_compute.ParticleCompute.upload_initial_particles
```

````

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

```{autodoc2-docstring} simvx.graphics.renderer.particle_compute.ParticleCompute.cleanup
```

````

`````