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

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

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

## Module Contents

### Functions

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

* - {py:obj}`pack_ocean_surface <simvx.graphics.renderer.ocean_pack.pack_ocean_surface>`
  - ```{autodoc2-docstring} simvx.graphics.renderer.ocean_pack.pack_ocean_surface
    :summary:
    ```
* - {py:obj}`build_ocean_records <simvx.graphics.renderer.ocean_pack.build_ocean_records>`
  - ```{autodoc2-docstring} simvx.graphics.renderer.ocean_pack.build_ocean_records
    :summary:
    ```
````

### Data

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

* - {py:obj}`__all__ <simvx.graphics.renderer.ocean_pack.__all__>`
  - ```{autodoc2-docstring} simvx.graphics.renderer.ocean_pack.__all__
    :summary:
    ```
* - {py:obj}`OCEAN_SURFACE_DTYPE <simvx.graphics.renderer.ocean_pack.OCEAN_SURFACE_DTYPE>`
  - ```{autodoc2-docstring} simvx.graphics.renderer.ocean_pack.OCEAN_SURFACE_DTYPE
    :summary:
    ```
* - {py:obj}`OCEAN_SURFACE_STRIDE <simvx.graphics.renderer.ocean_pack.OCEAN_SURFACE_STRIDE>`
  - ```{autodoc2-docstring} simvx.graphics.renderer.ocean_pack.OCEAN_SURFACE_STRIDE
    :summary:
    ```
````

### API

````{py:data} __all__
:canonical: simvx.graphics.renderer.ocean_pack.__all__
:value: >
   ['OCEAN_SURFACE_DTYPE', 'OCEAN_SURFACE_STRIDE', 'build_ocean_records', 'pack_ocean_surface']

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

````

````{py:data} OCEAN_SURFACE_DTYPE
:canonical: simvx.graphics.renderer.ocean_pack.OCEAN_SURFACE_DTYPE
:value: >
   'dtype(...)'

```{autodoc2-docstring} simvx.graphics.renderer.ocean_pack.OCEAN_SURFACE_DTYPE
```

````

````{py:data} OCEAN_SURFACE_STRIDE
:canonical: simvx.graphics.renderer.ocean_pack.OCEAN_SURFACE_STRIDE
:value: >
   None

```{autodoc2-docstring} simvx.graphics.renderer.ocean_pack.OCEAN_SURFACE_STRIDE
```

````

````{py:function} pack_ocean_surface(model: numpy.ndarray, mat: typing.Any, subdivisions: int, size: tuple[float, float], patch_lengths: tuple[float, ...], *, choppiness: float, displacement_scale: float, foam_intensity: float) -> numpy.ndarray
:canonical: simvx.graphics.renderer.ocean_pack.pack_ocean_surface

```{autodoc2-docstring} simvx.graphics.renderer.ocean_pack.pack_ocean_surface
```
````

````{py:function} build_ocean_records(surfaces: list[typing.Any], patch_lengths: tuple[float, ...], *, choppiness: float, displacement_scale: float = 1.0, foam_intensity: float = 1.0) -> tuple[numpy.ndarray, int]
:canonical: simvx.graphics.renderer.ocean_pack.build_ocean_records

```{autodoc2-docstring} simvx.graphics.renderer.ocean_pack.build_ocean_records
```
````