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

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

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

## Module Contents

### Classes

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

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

### Data

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

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

### API

````{py:data} __all__
:canonical: simvx.graphics.renderer.ocean_pass.__all__
:value: >
   ['OceanPass', 'OCEAN_SURFACE_DTYPE']

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

````

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

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

````

````{py:data} MAX_SURFACES
:canonical: simvx.graphics.renderer.ocean_pass.MAX_SURFACES
:value: >
   16

```{autodoc2-docstring} simvx.graphics.renderer.ocean_pass.MAX_SURFACES
```

````

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

```{autodoc2-docstring} simvx.graphics.renderer.ocean_pass.OceanPass
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.graphics.renderer.ocean_pass.OceanPass.__init__
```

````{py:method} setup(ssbo_layout: typing.Any, render_pass: typing.Any = None) -> None
:canonical: simvx.graphics.renderer.ocean_pass.OceanPass.setup

```{autodoc2-docstring} simvx.graphics.renderer.ocean_pass.OceanPass.setup
```

````

````{py:method} rebuild_pipeline(render_pass: typing.Any) -> None
:canonical: simvx.graphics.renderer.ocean_pass.OceanPass.rebuild_pipeline

```{autodoc2-docstring} simvx.graphics.renderer.ocean_pass.OceanPass.rebuild_pipeline
```

````

````{py:method} begin_frame() -> None
:canonical: simvx.graphics.renderer.ocean_pass.OceanPass.begin_frame

```{autodoc2-docstring} simvx.graphics.renderer.ocean_pass.OceanPass.begin_frame
```

````

````{py:method} submit(model_matrix: numpy.ndarray, material: typing.Any, subdivisions: int, size: tuple[float, float]) -> None
:canonical: simvx.graphics.renderer.ocean_pass.OceanPass.submit

```{autodoc2-docstring} simvx.graphics.renderer.ocean_pass.OceanPass.submit
```

````

````{py:property} has_surfaces
:canonical: simvx.graphics.renderer.ocean_pass.OceanPass.has_surfaces
:type: bool

```{autodoc2-docstring} simvx.graphics.renderer.ocean_pass.OceanPass.has_surfaces
```

````

````{py:method} prepare(cmd: typing.Any, env: typing.Any, time: float) -> None
:canonical: simvx.graphics.renderer.ocean_pass.OceanPass.prepare

```{autodoc2-docstring} simvx.graphics.renderer.ocean_pass.OceanPass.prepare
```

````

````{py:method} render(cmd: typing.Any, view_proj: numpy.ndarray, cam_pos: numpy.ndarray, near: float, far: float, has_skybox: bool, extent: tuple[int, int], ssbo_set: typing.Any) -> None
:canonical: simvx.graphics.renderer.ocean_pass.OceanPass.render

```{autodoc2-docstring} simvx.graphics.renderer.ocean_pass.OceanPass.render
```

````

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

```{autodoc2-docstring} simvx.graphics.renderer.ocean_pass.OceanPass.cleanup
```

````

`````