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

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

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

## Module Contents

### Classes

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

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

### Data

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

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

### API

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

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

````

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

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

````

````{py:data} PUSH_SIZE
:canonical: simvx.graphics.renderer.light2d_pass.PUSH_SIZE
:value: >
   48

```{autodoc2-docstring} simvx.graphics.renderer.light2d_pass.PUSH_SIZE
```

````

````{py:data} SHADOW_MAP_RESOLUTION
:canonical: simvx.graphics.renderer.light2d_pass.SHADOW_MAP_RESOLUTION
:value: >
   64

```{autodoc2-docstring} simvx.graphics.renderer.light2d_pass.SHADOW_MAP_RESOLUTION
```

````

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

```{autodoc2-docstring} simvx.graphics.renderer.light2d_pass.Light2DPass
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.graphics.renderer.light2d_pass.Light2DPass.__init__
```

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

```{autodoc2-docstring} simvx.graphics.renderer.light2d_pass.Light2DPass.setup
```

````

````{py:method} submit_light(position: tuple[float, float], color: tuple[float, float, float], energy: float, light_range: float, falloff: float = 1.0, blend_mode: str = 'add', shadow_enabled: bool = False, shadow_color: tuple[float, ...] = (0.0, 0.0, 0.0, 0.5)) -> None
:canonical: simvx.graphics.renderer.light2d_pass.Light2DPass.submit_light

```{autodoc2-docstring} simvx.graphics.renderer.light2d_pass.Light2DPass.submit_light
```

````

````{py:method} submit_occluder(polygon_vertices: list[tuple[float, float]]) -> None
:canonical: simvx.graphics.renderer.light2d_pass.Light2DPass.submit_occluder

```{autodoc2-docstring} simvx.graphics.renderer.light2d_pass.Light2DPass.submit_occluder
```

````

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

```{autodoc2-docstring} simvx.graphics.renderer.light2d_pass.Light2DPass.begin_frame
```

````

````{py:method} render(cmd: typing.Any, extent: tuple[int, int]) -> None
:canonical: simvx.graphics.renderer.light2d_pass.Light2DPass.render

```{autodoc2-docstring} simvx.graphics.renderer.light2d_pass.Light2DPass.render
```

````

````{py:method} get_light_texture_view() -> typing.Any
:canonical: simvx.graphics.renderer.light2d_pass.Light2DPass.get_light_texture_view

```{autodoc2-docstring} simvx.graphics.renderer.light2d_pass.Light2DPass.get_light_texture_view
```

````

````{py:method} get_light_sampler() -> typing.Any
:canonical: simvx.graphics.renderer.light2d_pass.Light2DPass.get_light_sampler

```{autodoc2-docstring} simvx.graphics.renderer.light2d_pass.Light2DPass.get_light_sampler
```

````

````{py:property} has_lights
:canonical: simvx.graphics.renderer.light2d_pass.Light2DPass.has_lights
:type: bool

```{autodoc2-docstring} simvx.graphics.renderer.light2d_pass.Light2DPass.has_lights
```

````

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

```{autodoc2-docstring} simvx.graphics.renderer.light2d_pass.Light2DPass.cleanup
```

````

`````