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

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

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

## Module Contents

### Classes

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

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

### Data

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

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

### API

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

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

````

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

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

````

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

```{autodoc2-docstring} simvx.graphics.renderer.ocean_compute.OceanCompute
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.graphics.renderer.ocean_compute.OceanCompute.__init__
```

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

```{autodoc2-docstring} simvx.graphics.renderer.ocean_compute.OceanCompute.setup
```

````

````{py:property} disp_view
:canonical: simvx.graphics.renderer.ocean_compute.OceanCompute.disp_view
:type: typing.Any

```{autodoc2-docstring} simvx.graphics.renderer.ocean_compute.OceanCompute.disp_view
```

````

````{py:property} grad_view
:canonical: simvx.graphics.renderer.ocean_compute.OceanCompute.grad_view
:type: typing.Any

```{autodoc2-docstring} simvx.graphics.renderer.ocean_compute.OceanCompute.grad_view
```

````

````{py:property} size
:canonical: simvx.graphics.renderer.ocean_compute.OceanCompute.size
:type: int

```{autodoc2-docstring} simvx.graphics.renderer.ocean_compute.OceanCompute.size
```

````

````{py:property} cascades
:canonical: simvx.graphics.renderer.ocean_compute.OceanCompute.cascades
:type: int

```{autodoc2-docstring} simvx.graphics.renderer.ocean_compute.OceanCompute.cascades
```

````

````{py:method} resize(fft: simvx.graphics.renderer.ocean_fft.OceanFFT, size: int, cascades: int) -> None
:canonical: simvx.graphics.renderer.ocean_compute.OceanCompute.resize

```{autodoc2-docstring} simvx.graphics.renderer.ocean_compute.OceanCompute.resize
```

````

````{py:method} upload_spectrum_if_dirty(fft: simvx.graphics.renderer.ocean_fft.OceanFFT) -> None
:canonical: simvx.graphics.renderer.ocean_compute.OceanCompute.upload_spectrum_if_dirty

```{autodoc2-docstring} simvx.graphics.renderer.ocean_compute.OceanCompute.upload_spectrum_if_dirty
```

````

````{py:method} dispatch(cmd: typing.Any, time: float, choppiness: float, foam_threshold: float, foam_decay: float) -> None
:canonical: simvx.graphics.renderer.ocean_compute.OceanCompute.dispatch

```{autodoc2-docstring} simvx.graphics.renderer.ocean_compute.OceanCompute.dispatch
```

````

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

```{autodoc2-docstring} simvx.graphics.renderer.ocean_compute.OceanCompute.cleanup
```

````

`````