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

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

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

## Module Contents

### Classes

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

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

### Functions

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

* - {py:obj}`hiz_mip_count <simvx.graphics.renderer.hiz_pass.hiz_mip_count>`
  - ```{autodoc2-docstring} simvx.graphics.renderer.hiz_pass.hiz_mip_count
    :summary:
    ```
* - {py:obj}`hiz_mip_sizes <simvx.graphics.renderer.hiz_pass.hiz_mip_sizes>`
  - ```{autodoc2-docstring} simvx.graphics.renderer.hiz_pass.hiz_mip_sizes
    :summary:
    ```
````

### Data

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

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

### API

````{py:data} __all__
:canonical: simvx.graphics.renderer.hiz_pass.__all__
:value: >
   ['HiZPass', 'hiz_mip_count', 'hiz_mip_sizes']

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

````

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

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

````

````{py:function} hiz_mip_count(width: int, height: int) -> int
:canonical: simvx.graphics.renderer.hiz_pass.hiz_mip_count

```{autodoc2-docstring} simvx.graphics.renderer.hiz_pass.hiz_mip_count
```
````

````{py:function} hiz_mip_sizes(width: int, height: int) -> list[tuple[int, int]]
:canonical: simvx.graphics.renderer.hiz_pass.hiz_mip_sizes

```{autodoc2-docstring} simvx.graphics.renderer.hiz_pass.hiz_mip_sizes
```
````

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

```{autodoc2-docstring} simvx.graphics.renderer.hiz_pass.HiZPass
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.graphics.renderer.hiz_pass.HiZPass.__init__
```

````{py:property} mip_count
:canonical: simvx.graphics.renderer.hiz_pass.HiZPass.mip_count
:type: int

```{autodoc2-docstring} simvx.graphics.renderer.hiz_pass.HiZPass.mip_count
```

````

````{py:property} image
:canonical: simvx.graphics.renderer.hiz_pass.HiZPass.image
:type: typing.Any

```{autodoc2-docstring} simvx.graphics.renderer.hiz_pass.HiZPass.image
```

````

````{py:property} sampled_view
:canonical: simvx.graphics.renderer.hiz_pass.HiZPass.sampled_view
:type: typing.Any

```{autodoc2-docstring} simvx.graphics.renderer.hiz_pass.HiZPass.sampled_view
```

````

````{py:property} sampler
:canonical: simvx.graphics.renderer.hiz_pass.HiZPass.sampler
:type: typing.Any

```{autodoc2-docstring} simvx.graphics.renderer.hiz_pass.HiZPass.sampler
```

````

````{py:property} base_extent
:canonical: simvx.graphics.renderer.hiz_pass.HiZPass.base_extent
:type: tuple[int, int]

```{autodoc2-docstring} simvx.graphics.renderer.hiz_pass.HiZPass.base_extent
```

````

````{py:method} setup(width: int, height: int, depth_view: typing.Any, depth_image: typing.Any) -> None
:canonical: simvx.graphics.renderer.hiz_pass.HiZPass.setup

```{autodoc2-docstring} simvx.graphics.renderer.hiz_pass.HiZPass.setup
```

````

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

```{autodoc2-docstring} simvx.graphics.renderer.hiz_pass.HiZPass.render
```

````

````{py:method} resize(width: int, height: int, depth_view: typing.Any, depth_image: typing.Any) -> None
:canonical: simvx.graphics.renderer.hiz_pass.HiZPass.resize

```{autodoc2-docstring} simvx.graphics.renderer.hiz_pass.HiZPass.resize
```

````

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

```{autodoc2-docstring} simvx.graphics.renderer.hiz_pass.HiZPass.cleanup
```

````

`````