# {py:mod}`simvx.core.light2d`

```{py:module} simvx.core.light2d
```

```{autodoc2-docstring} simvx.core.light2d
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`Light2D <simvx.core.light2d.Light2D>`
  - ```{autodoc2-docstring} simvx.core.light2d.Light2D
    :summary:
    ```
* - {py:obj}`PointLight2D <simvx.core.light2d.PointLight2D>`
  - ```{autodoc2-docstring} simvx.core.light2d.PointLight2D
    :summary:
    ```
* - {py:obj}`DirectionalLight2D <simvx.core.light2d.DirectionalLight2D>`
  - ```{autodoc2-docstring} simvx.core.light2d.DirectionalLight2D
    :summary:
    ```
* - {py:obj}`LightOccluder2D <simvx.core.light2d.LightOccluder2D>`
  - ```{autodoc2-docstring} simvx.core.light2d.LightOccluder2D
    :summary:
    ```
````

### Functions

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

* - {py:obj}`collect_lights <simvx.core.light2d.collect_lights>`
  - ```{autodoc2-docstring} simvx.core.light2d.collect_lights
    :summary:
    ```
* - {py:obj}`collect_occluders <simvx.core.light2d.collect_occluders>`
  - ```{autodoc2-docstring} simvx.core.light2d.collect_occluders
    :summary:
    ```
````

### Data

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

* - {py:obj}`__all__ <simvx.core.light2d.__all__>`
  - ```{autodoc2-docstring} simvx.core.light2d.__all__
    :summary:
    ```
````

### API

````{py:data} __all__
:canonical: simvx.core.light2d.__all__
:value: >
   ['Light2D', 'PointLight2D', 'DirectionalLight2D', 'LightOccluder2D']

```{autodoc2-docstring} simvx.core.light2d.__all__
```

````

`````{py:class} Light2D(**kwargs)
:canonical: simvx.core.light2d.Light2D

Bases: {py:obj}`simvx.core.engine.Node2D`

```{autodoc2-docstring} simvx.core.light2d.Light2D
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.light2d.Light2D.__init__
```

````{py:attribute} color
:canonical: simvx.core.light2d.Light2D.color
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.light2d.Light2D.color
```

````

````{py:attribute} energy
:canonical: simvx.core.light2d.Light2D.energy
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.light2d.Light2D.energy
```

````

````{py:attribute} range
:canonical: simvx.core.light2d.Light2D.range
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.light2d.Light2D.range
```

````

````{py:attribute} blend_mode
:canonical: simvx.core.light2d.Light2D.blend_mode
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.light2d.Light2D.blend_mode
```

````

````{py:attribute} enabled
:canonical: simvx.core.light2d.Light2D.enabled
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.light2d.Light2D.enabled
```

````

````{py:attribute} shadow_enabled
:canonical: simvx.core.light2d.Light2D.shadow_enabled
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.light2d.Light2D.shadow_enabled
```

````

````{py:attribute} shadow_color
:canonical: simvx.core.light2d.Light2D.shadow_color
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.light2d.Light2D.shadow_color
```

````

````{py:attribute} texture_scale
:canonical: simvx.core.light2d.Light2D.texture_scale
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.light2d.Light2D.texture_scale
```

````

````{py:attribute} z_index
:canonical: simvx.core.light2d.Light2D.z_index
:value: >
   'Property(...)'

````

````{py:attribute} z_as_relative
:canonical: simvx.core.light2d.Light2D.z_as_relative
:value: >
   'Property(...)'

````

````{py:property} absolute_z_index
:canonical: simvx.core.light2d.Light2D.absolute_z_index
:type: int

````

````{py:property} position
:canonical: simvx.core.light2d.Light2D.position
:type: simvx.core.math.types.Vec2

````

````{py:property} rotation
:canonical: simvx.core.light2d.Light2D.rotation
:type: float

````

````{py:property} rotation_degrees
:canonical: simvx.core.light2d.Light2D.rotation_degrees
:type: float

````

````{py:property} scale
:canonical: simvx.core.light2d.Light2D.scale
:type: simvx.core.math.types.Vec2

````

````{py:property} global_position
:canonical: simvx.core.light2d.Light2D.global_position
:type: simvx.core.math.types.Vec2

````

````{py:property} global_rotation
:canonical: simvx.core.light2d.Light2D.global_rotation
:type: float

````

````{py:property} global_scale
:canonical: simvx.core.light2d.Light2D.global_scale
:type: simvx.core.math.types.Vec2

````

````{py:property} forward
:canonical: simvx.core.light2d.Light2D.forward
:type: simvx.core.math.types.Vec2

````

````{py:property} right
:canonical: simvx.core.light2d.Light2D.right
:type: simvx.core.math.types.Vec2

````

````{py:method} translate(offset: tuple[float, float] | numpy.ndarray)
:canonical: simvx.core.light2d.Light2D.translate

````

````{py:method} rotate(radians: float)
:canonical: simvx.core.light2d.Light2D.rotate

````

````{py:method} rotate_deg(degrees: float)
:canonical: simvx.core.light2d.Light2D.rotate_deg

````

````{py:method} look_at(target: tuple[float, float] | numpy.ndarray)
:canonical: simvx.core.light2d.Light2D.look_at

````

````{py:method} transform_points(points: list[simvx.core.math.types.Vec2]) -> list[simvx.core.math.types.Vec2]
:canonical: simvx.core.light2d.Light2D.transform_points

````

````{py:method} draw_polygon(renderer, points: list[simvx.core.math.types.Vec2], closed=True, color=None)
:canonical: simvx.core.light2d.Light2D.draw_polygon

````

````{py:method} wrap_screen(margin: float = 20)
:canonical: simvx.core.light2d.Light2D.wrap_screen

````

````{py:attribute} script_error_raised
:canonical: simvx.core.light2d.Light2D.script_error_raised
:value: >
   'Signal(...)'

````

````{py:method} __init_subclass__(**kwargs)
:canonical: simvx.core.light2d.Light2D.__init_subclass__
:classmethod:

````

````{py:property} name
:canonical: simvx.core.light2d.Light2D.name
:type: str

````

````{py:property} process_mode
:canonical: simvx.core.light2d.Light2D.process_mode
:type: simvx.core.descriptors.ProcessMode

````

````{py:method} reset_error() -> None
:canonical: simvx.core.light2d.Light2D.reset_error

````

````{py:method} add_child(node: simvx.core.node.Node) -> simvx.core.node.Node
:canonical: simvx.core.light2d.Light2D.add_child

````

````{py:method} remove_child(node: simvx.core.node.Node)
:canonical: simvx.core.light2d.Light2D.remove_child

````

````{py:method} reparent(new_parent: simvx.core.node.Node)
:canonical: simvx.core.light2d.Light2D.reparent

````

````{py:method} get_node(path: str) -> simvx.core.node.Node
:canonical: simvx.core.light2d.Light2D.get_node

````

````{py:method} find_child(name: str, recursive: bool = False) -> simvx.core.node.Node | None
:canonical: simvx.core.light2d.Light2D.find_child

````

````{py:method} find(node_type: type) -> simvx.core.node.Node | None
:canonical: simvx.core.light2d.Light2D.find

````

````{py:method} find_all(node_type: type, recursive: bool = True) -> list
:canonical: simvx.core.light2d.Light2D.find_all

````

````{py:property} path
:canonical: simvx.core.light2d.Light2D.path
:type: str

````

````{py:method} add_to_group(group: str)
:canonical: simvx.core.light2d.Light2D.add_to_group

````

````{py:method} remove_from_group(group: str)
:canonical: simvx.core.light2d.Light2D.remove_from_group

````

````{py:method} is_in_group(group: str) -> bool
:canonical: simvx.core.light2d.Light2D.is_in_group

````

````{py:method} ready() -> None
:canonical: simvx.core.light2d.Light2D.ready

````

````{py:method} enter_tree() -> None
:canonical: simvx.core.light2d.Light2D.enter_tree

````

````{py:method} exit_tree() -> None
:canonical: simvx.core.light2d.Light2D.exit_tree

````

````{py:method} process(dt: float) -> None
:canonical: simvx.core.light2d.Light2D.process

````

````{py:method} physics_process(dt: float) -> None
:canonical: simvx.core.light2d.Light2D.physics_process

````

````{py:method} draw(renderer) -> None
:canonical: simvx.core.light2d.Light2D.draw

````

````{py:method} input_event(event: simvx.core.events.InputEvent) -> None
:canonical: simvx.core.light2d.Light2D.input_event

````

````{py:method} input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.light2d.Light2D.input

````

````{py:method} unhandled_input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.light2d.Light2D.unhandled_input

````

````{py:method} start_coroutine(gen: simvx.core.descriptors.Coroutine) -> simvx.core.descriptors.CoroutineHandle
:canonical: simvx.core.light2d.Light2D.start_coroutine

````

````{py:method} stop_coroutine(gen_or_handle)
:canonical: simvx.core.light2d.Light2D.stop_coroutine

````

````{py:method} destroy()
:canonical: simvx.core.light2d.Light2D.destroy

````

````{py:attribute} queue_free
:canonical: simvx.core.light2d.Light2D.queue_free
:value: >
   None

````

````{py:property} tree
:canonical: simvx.core.light2d.Light2D.tree
:type: simvx.core.scene_tree.SceneTree

````

````{py:method} get_tree() -> simvx.core.scene_tree.SceneTree
:canonical: simvx.core.light2d.Light2D.get_tree

````

````{py:method} __getitem__(key: str)
:canonical: simvx.core.light2d.Light2D.__getitem__

````

````{py:method} get_properties() -> dict[str, simvx.core.descriptors.Property]
:canonical: simvx.core.light2d.Light2D.get_properties
:classmethod:

````

````{py:attribute} get_settings
:canonical: simvx.core.light2d.Light2D.get_settings
:value: >
   None

````

````{py:method} __repr__()
:canonical: simvx.core.light2d.Light2D.__repr__

````

`````

`````{py:class} PointLight2D(**kwargs)
:canonical: simvx.core.light2d.PointLight2D

Bases: {py:obj}`simvx.core.light2d.Light2D`

```{autodoc2-docstring} simvx.core.light2d.PointLight2D
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.light2d.PointLight2D.__init__
```

````{py:attribute} falloff
:canonical: simvx.core.light2d.PointLight2D.falloff
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.light2d.PointLight2D.falloff
```

````

````{py:attribute} color
:canonical: simvx.core.light2d.PointLight2D.color
:value: >
   'Property(...)'

````

````{py:attribute} energy
:canonical: simvx.core.light2d.PointLight2D.energy
:value: >
   'Property(...)'

````

````{py:attribute} range
:canonical: simvx.core.light2d.PointLight2D.range
:value: >
   'Property(...)'

````

````{py:attribute} blend_mode
:canonical: simvx.core.light2d.PointLight2D.blend_mode
:value: >
   'Property(...)'

````

````{py:attribute} enabled
:canonical: simvx.core.light2d.PointLight2D.enabled
:value: >
   'Property(...)'

````

````{py:attribute} shadow_enabled
:canonical: simvx.core.light2d.PointLight2D.shadow_enabled
:value: >
   'Property(...)'

````

````{py:attribute} shadow_color
:canonical: simvx.core.light2d.PointLight2D.shadow_color
:value: >
   'Property(...)'

````

````{py:attribute} texture_scale
:canonical: simvx.core.light2d.PointLight2D.texture_scale
:value: >
   'Property(...)'

````

````{py:attribute} z_index
:canonical: simvx.core.light2d.PointLight2D.z_index
:value: >
   'Property(...)'

````

````{py:attribute} z_as_relative
:canonical: simvx.core.light2d.PointLight2D.z_as_relative
:value: >
   'Property(...)'

````

````{py:property} absolute_z_index
:canonical: simvx.core.light2d.PointLight2D.absolute_z_index
:type: int

````

````{py:property} position
:canonical: simvx.core.light2d.PointLight2D.position
:type: simvx.core.math.types.Vec2

````

````{py:property} rotation
:canonical: simvx.core.light2d.PointLight2D.rotation
:type: float

````

````{py:property} rotation_degrees
:canonical: simvx.core.light2d.PointLight2D.rotation_degrees
:type: float

````

````{py:property} scale
:canonical: simvx.core.light2d.PointLight2D.scale
:type: simvx.core.math.types.Vec2

````

````{py:property} global_position
:canonical: simvx.core.light2d.PointLight2D.global_position
:type: simvx.core.math.types.Vec2

````

````{py:property} global_rotation
:canonical: simvx.core.light2d.PointLight2D.global_rotation
:type: float

````

````{py:property} global_scale
:canonical: simvx.core.light2d.PointLight2D.global_scale
:type: simvx.core.math.types.Vec2

````

````{py:property} forward
:canonical: simvx.core.light2d.PointLight2D.forward
:type: simvx.core.math.types.Vec2

````

````{py:property} right
:canonical: simvx.core.light2d.PointLight2D.right
:type: simvx.core.math.types.Vec2

````

````{py:method} translate(offset: tuple[float, float] | numpy.ndarray)
:canonical: simvx.core.light2d.PointLight2D.translate

````

````{py:method} rotate(radians: float)
:canonical: simvx.core.light2d.PointLight2D.rotate

````

````{py:method} rotate_deg(degrees: float)
:canonical: simvx.core.light2d.PointLight2D.rotate_deg

````

````{py:method} look_at(target: tuple[float, float] | numpy.ndarray)
:canonical: simvx.core.light2d.PointLight2D.look_at

````

````{py:method} transform_points(points: list[simvx.core.math.types.Vec2]) -> list[simvx.core.math.types.Vec2]
:canonical: simvx.core.light2d.PointLight2D.transform_points

````

````{py:method} draw_polygon(renderer, points: list[simvx.core.math.types.Vec2], closed=True, color=None)
:canonical: simvx.core.light2d.PointLight2D.draw_polygon

````

````{py:method} wrap_screen(margin: float = 20)
:canonical: simvx.core.light2d.PointLight2D.wrap_screen

````

````{py:attribute} script_error_raised
:canonical: simvx.core.light2d.PointLight2D.script_error_raised
:value: >
   'Signal(...)'

````

````{py:method} __init_subclass__(**kwargs)
:canonical: simvx.core.light2d.PointLight2D.__init_subclass__
:classmethod:

````

````{py:property} name
:canonical: simvx.core.light2d.PointLight2D.name
:type: str

````

````{py:property} process_mode
:canonical: simvx.core.light2d.PointLight2D.process_mode
:type: simvx.core.descriptors.ProcessMode

````

````{py:method} reset_error() -> None
:canonical: simvx.core.light2d.PointLight2D.reset_error

````

````{py:method} add_child(node: simvx.core.node.Node) -> simvx.core.node.Node
:canonical: simvx.core.light2d.PointLight2D.add_child

````

````{py:method} remove_child(node: simvx.core.node.Node)
:canonical: simvx.core.light2d.PointLight2D.remove_child

````

````{py:method} reparent(new_parent: simvx.core.node.Node)
:canonical: simvx.core.light2d.PointLight2D.reparent

````

````{py:method} get_node(path: str) -> simvx.core.node.Node
:canonical: simvx.core.light2d.PointLight2D.get_node

````

````{py:method} find_child(name: str, recursive: bool = False) -> simvx.core.node.Node | None
:canonical: simvx.core.light2d.PointLight2D.find_child

````

````{py:method} find(node_type: type) -> simvx.core.node.Node | None
:canonical: simvx.core.light2d.PointLight2D.find

````

````{py:method} find_all(node_type: type, recursive: bool = True) -> list
:canonical: simvx.core.light2d.PointLight2D.find_all

````

````{py:property} path
:canonical: simvx.core.light2d.PointLight2D.path
:type: str

````

````{py:method} add_to_group(group: str)
:canonical: simvx.core.light2d.PointLight2D.add_to_group

````

````{py:method} remove_from_group(group: str)
:canonical: simvx.core.light2d.PointLight2D.remove_from_group

````

````{py:method} is_in_group(group: str) -> bool
:canonical: simvx.core.light2d.PointLight2D.is_in_group

````

````{py:method} ready() -> None
:canonical: simvx.core.light2d.PointLight2D.ready

````

````{py:method} enter_tree() -> None
:canonical: simvx.core.light2d.PointLight2D.enter_tree

````

````{py:method} exit_tree() -> None
:canonical: simvx.core.light2d.PointLight2D.exit_tree

````

````{py:method} process(dt: float) -> None
:canonical: simvx.core.light2d.PointLight2D.process

````

````{py:method} physics_process(dt: float) -> None
:canonical: simvx.core.light2d.PointLight2D.physics_process

````

````{py:method} draw(renderer) -> None
:canonical: simvx.core.light2d.PointLight2D.draw

````

````{py:method} input_event(event: simvx.core.events.InputEvent) -> None
:canonical: simvx.core.light2d.PointLight2D.input_event

````

````{py:method} input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.light2d.PointLight2D.input

````

````{py:method} unhandled_input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.light2d.PointLight2D.unhandled_input

````

````{py:method} start_coroutine(gen: simvx.core.descriptors.Coroutine) -> simvx.core.descriptors.CoroutineHandle
:canonical: simvx.core.light2d.PointLight2D.start_coroutine

````

````{py:method} stop_coroutine(gen_or_handle)
:canonical: simvx.core.light2d.PointLight2D.stop_coroutine

````

````{py:method} destroy()
:canonical: simvx.core.light2d.PointLight2D.destroy

````

````{py:attribute} queue_free
:canonical: simvx.core.light2d.PointLight2D.queue_free
:value: >
   None

````

````{py:property} tree
:canonical: simvx.core.light2d.PointLight2D.tree
:type: simvx.core.scene_tree.SceneTree

````

````{py:method} get_tree() -> simvx.core.scene_tree.SceneTree
:canonical: simvx.core.light2d.PointLight2D.get_tree

````

````{py:method} __getitem__(key: str)
:canonical: simvx.core.light2d.PointLight2D.__getitem__

````

````{py:method} get_properties() -> dict[str, simvx.core.descriptors.Property]
:canonical: simvx.core.light2d.PointLight2D.get_properties
:classmethod:

````

````{py:attribute} get_settings
:canonical: simvx.core.light2d.PointLight2D.get_settings
:value: >
   None

````

````{py:method} __repr__()
:canonical: simvx.core.light2d.PointLight2D.__repr__

````

`````

`````{py:class} DirectionalLight2D(**kwargs)
:canonical: simvx.core.light2d.DirectionalLight2D

Bases: {py:obj}`simvx.core.light2d.Light2D`

```{autodoc2-docstring} simvx.core.light2d.DirectionalLight2D
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.light2d.DirectionalLight2D.__init__
```

````{py:attribute} direction
:canonical: simvx.core.light2d.DirectionalLight2D.direction
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.light2d.DirectionalLight2D.direction
```

````

````{py:attribute} color
:canonical: simvx.core.light2d.DirectionalLight2D.color
:value: >
   'Property(...)'

````

````{py:attribute} energy
:canonical: simvx.core.light2d.DirectionalLight2D.energy
:value: >
   'Property(...)'

````

````{py:attribute} range
:canonical: simvx.core.light2d.DirectionalLight2D.range
:value: >
   'Property(...)'

````

````{py:attribute} blend_mode
:canonical: simvx.core.light2d.DirectionalLight2D.blend_mode
:value: >
   'Property(...)'

````

````{py:attribute} enabled
:canonical: simvx.core.light2d.DirectionalLight2D.enabled
:value: >
   'Property(...)'

````

````{py:attribute} shadow_enabled
:canonical: simvx.core.light2d.DirectionalLight2D.shadow_enabled
:value: >
   'Property(...)'

````

````{py:attribute} shadow_color
:canonical: simvx.core.light2d.DirectionalLight2D.shadow_color
:value: >
   'Property(...)'

````

````{py:attribute} texture_scale
:canonical: simvx.core.light2d.DirectionalLight2D.texture_scale
:value: >
   'Property(...)'

````

````{py:attribute} z_index
:canonical: simvx.core.light2d.DirectionalLight2D.z_index
:value: >
   'Property(...)'

````

````{py:attribute} z_as_relative
:canonical: simvx.core.light2d.DirectionalLight2D.z_as_relative
:value: >
   'Property(...)'

````

````{py:property} absolute_z_index
:canonical: simvx.core.light2d.DirectionalLight2D.absolute_z_index
:type: int

````

````{py:property} position
:canonical: simvx.core.light2d.DirectionalLight2D.position
:type: simvx.core.math.types.Vec2

````

````{py:property} rotation
:canonical: simvx.core.light2d.DirectionalLight2D.rotation
:type: float

````

````{py:property} rotation_degrees
:canonical: simvx.core.light2d.DirectionalLight2D.rotation_degrees
:type: float

````

````{py:property} scale
:canonical: simvx.core.light2d.DirectionalLight2D.scale
:type: simvx.core.math.types.Vec2

````

````{py:property} global_position
:canonical: simvx.core.light2d.DirectionalLight2D.global_position
:type: simvx.core.math.types.Vec2

````

````{py:property} global_rotation
:canonical: simvx.core.light2d.DirectionalLight2D.global_rotation
:type: float

````

````{py:property} global_scale
:canonical: simvx.core.light2d.DirectionalLight2D.global_scale
:type: simvx.core.math.types.Vec2

````

````{py:property} forward
:canonical: simvx.core.light2d.DirectionalLight2D.forward
:type: simvx.core.math.types.Vec2

````

````{py:property} right
:canonical: simvx.core.light2d.DirectionalLight2D.right
:type: simvx.core.math.types.Vec2

````

````{py:method} translate(offset: tuple[float, float] | numpy.ndarray)
:canonical: simvx.core.light2d.DirectionalLight2D.translate

````

````{py:method} rotate(radians: float)
:canonical: simvx.core.light2d.DirectionalLight2D.rotate

````

````{py:method} rotate_deg(degrees: float)
:canonical: simvx.core.light2d.DirectionalLight2D.rotate_deg

````

````{py:method} look_at(target: tuple[float, float] | numpy.ndarray)
:canonical: simvx.core.light2d.DirectionalLight2D.look_at

````

````{py:method} transform_points(points: list[simvx.core.math.types.Vec2]) -> list[simvx.core.math.types.Vec2]
:canonical: simvx.core.light2d.DirectionalLight2D.transform_points

````

````{py:method} draw_polygon(renderer, points: list[simvx.core.math.types.Vec2], closed=True, color=None)
:canonical: simvx.core.light2d.DirectionalLight2D.draw_polygon

````

````{py:method} wrap_screen(margin: float = 20)
:canonical: simvx.core.light2d.DirectionalLight2D.wrap_screen

````

````{py:attribute} script_error_raised
:canonical: simvx.core.light2d.DirectionalLight2D.script_error_raised
:value: >
   'Signal(...)'

````

````{py:method} __init_subclass__(**kwargs)
:canonical: simvx.core.light2d.DirectionalLight2D.__init_subclass__
:classmethod:

````

````{py:property} name
:canonical: simvx.core.light2d.DirectionalLight2D.name
:type: str

````

````{py:property} process_mode
:canonical: simvx.core.light2d.DirectionalLight2D.process_mode
:type: simvx.core.descriptors.ProcessMode

````

````{py:method} reset_error() -> None
:canonical: simvx.core.light2d.DirectionalLight2D.reset_error

````

````{py:method} add_child(node: simvx.core.node.Node) -> simvx.core.node.Node
:canonical: simvx.core.light2d.DirectionalLight2D.add_child

````

````{py:method} remove_child(node: simvx.core.node.Node)
:canonical: simvx.core.light2d.DirectionalLight2D.remove_child

````

````{py:method} reparent(new_parent: simvx.core.node.Node)
:canonical: simvx.core.light2d.DirectionalLight2D.reparent

````

````{py:method} get_node(path: str) -> simvx.core.node.Node
:canonical: simvx.core.light2d.DirectionalLight2D.get_node

````

````{py:method} find_child(name: str, recursive: bool = False) -> simvx.core.node.Node | None
:canonical: simvx.core.light2d.DirectionalLight2D.find_child

````

````{py:method} find(node_type: type) -> simvx.core.node.Node | None
:canonical: simvx.core.light2d.DirectionalLight2D.find

````

````{py:method} find_all(node_type: type, recursive: bool = True) -> list
:canonical: simvx.core.light2d.DirectionalLight2D.find_all

````

````{py:property} path
:canonical: simvx.core.light2d.DirectionalLight2D.path
:type: str

````

````{py:method} add_to_group(group: str)
:canonical: simvx.core.light2d.DirectionalLight2D.add_to_group

````

````{py:method} remove_from_group(group: str)
:canonical: simvx.core.light2d.DirectionalLight2D.remove_from_group

````

````{py:method} is_in_group(group: str) -> bool
:canonical: simvx.core.light2d.DirectionalLight2D.is_in_group

````

````{py:method} ready() -> None
:canonical: simvx.core.light2d.DirectionalLight2D.ready

````

````{py:method} enter_tree() -> None
:canonical: simvx.core.light2d.DirectionalLight2D.enter_tree

````

````{py:method} exit_tree() -> None
:canonical: simvx.core.light2d.DirectionalLight2D.exit_tree

````

````{py:method} process(dt: float) -> None
:canonical: simvx.core.light2d.DirectionalLight2D.process

````

````{py:method} physics_process(dt: float) -> None
:canonical: simvx.core.light2d.DirectionalLight2D.physics_process

````

````{py:method} draw(renderer) -> None
:canonical: simvx.core.light2d.DirectionalLight2D.draw

````

````{py:method} input_event(event: simvx.core.events.InputEvent) -> None
:canonical: simvx.core.light2d.DirectionalLight2D.input_event

````

````{py:method} input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.light2d.DirectionalLight2D.input

````

````{py:method} unhandled_input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.light2d.DirectionalLight2D.unhandled_input

````

````{py:method} start_coroutine(gen: simvx.core.descriptors.Coroutine) -> simvx.core.descriptors.CoroutineHandle
:canonical: simvx.core.light2d.DirectionalLight2D.start_coroutine

````

````{py:method} stop_coroutine(gen_or_handle)
:canonical: simvx.core.light2d.DirectionalLight2D.stop_coroutine

````

````{py:method} destroy()
:canonical: simvx.core.light2d.DirectionalLight2D.destroy

````

````{py:attribute} queue_free
:canonical: simvx.core.light2d.DirectionalLight2D.queue_free
:value: >
   None

````

````{py:property} tree
:canonical: simvx.core.light2d.DirectionalLight2D.tree
:type: simvx.core.scene_tree.SceneTree

````

````{py:method} get_tree() -> simvx.core.scene_tree.SceneTree
:canonical: simvx.core.light2d.DirectionalLight2D.get_tree

````

````{py:method} __getitem__(key: str)
:canonical: simvx.core.light2d.DirectionalLight2D.__getitem__

````

````{py:method} get_properties() -> dict[str, simvx.core.descriptors.Property]
:canonical: simvx.core.light2d.DirectionalLight2D.get_properties
:classmethod:

````

````{py:attribute} get_settings
:canonical: simvx.core.light2d.DirectionalLight2D.get_settings
:value: >
   None

````

````{py:method} __repr__()
:canonical: simvx.core.light2d.DirectionalLight2D.__repr__

````

`````

`````{py:class} LightOccluder2D(position=None, rotation: float = 0.0, scale=None, **kwargs)
:canonical: simvx.core.light2d.LightOccluder2D

Bases: {py:obj}`simvx.core.engine.Node2D`

```{autodoc2-docstring} simvx.core.light2d.LightOccluder2D
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.light2d.LightOccluder2D.__init__
```

````{py:attribute} polygon
:canonical: simvx.core.light2d.LightOccluder2D.polygon
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.light2d.LightOccluder2D.polygon
```

````

````{py:attribute} one_way
:canonical: simvx.core.light2d.LightOccluder2D.one_way
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.light2d.LightOccluder2D.one_way
```

````

````{py:method} get_global_polygon() -> list[tuple[float, float]]
:canonical: simvx.core.light2d.LightOccluder2D.get_global_polygon

```{autodoc2-docstring} simvx.core.light2d.LightOccluder2D.get_global_polygon
```

````

````{py:method} get_edge_segments() -> list[tuple[tuple[float, float], tuple[float, float]]]
:canonical: simvx.core.light2d.LightOccluder2D.get_edge_segments

```{autodoc2-docstring} simvx.core.light2d.LightOccluder2D.get_edge_segments
```

````

````{py:attribute} z_index
:canonical: simvx.core.light2d.LightOccluder2D.z_index
:value: >
   'Property(...)'

````

````{py:attribute} z_as_relative
:canonical: simvx.core.light2d.LightOccluder2D.z_as_relative
:value: >
   'Property(...)'

````

````{py:property} absolute_z_index
:canonical: simvx.core.light2d.LightOccluder2D.absolute_z_index
:type: int

````

````{py:property} position
:canonical: simvx.core.light2d.LightOccluder2D.position
:type: simvx.core.math.types.Vec2

````

````{py:property} rotation
:canonical: simvx.core.light2d.LightOccluder2D.rotation
:type: float

````

````{py:property} rotation_degrees
:canonical: simvx.core.light2d.LightOccluder2D.rotation_degrees
:type: float

````

````{py:property} scale
:canonical: simvx.core.light2d.LightOccluder2D.scale
:type: simvx.core.math.types.Vec2

````

````{py:property} global_position
:canonical: simvx.core.light2d.LightOccluder2D.global_position
:type: simvx.core.math.types.Vec2

````

````{py:property} global_rotation
:canonical: simvx.core.light2d.LightOccluder2D.global_rotation
:type: float

````

````{py:property} global_scale
:canonical: simvx.core.light2d.LightOccluder2D.global_scale
:type: simvx.core.math.types.Vec2

````

````{py:property} forward
:canonical: simvx.core.light2d.LightOccluder2D.forward
:type: simvx.core.math.types.Vec2

````

````{py:property} right
:canonical: simvx.core.light2d.LightOccluder2D.right
:type: simvx.core.math.types.Vec2

````

````{py:method} translate(offset: tuple[float, float] | numpy.ndarray)
:canonical: simvx.core.light2d.LightOccluder2D.translate

````

````{py:method} rotate(radians: float)
:canonical: simvx.core.light2d.LightOccluder2D.rotate

````

````{py:method} rotate_deg(degrees: float)
:canonical: simvx.core.light2d.LightOccluder2D.rotate_deg

````

````{py:method} look_at(target: tuple[float, float] | numpy.ndarray)
:canonical: simvx.core.light2d.LightOccluder2D.look_at

````

````{py:method} transform_points(points: list[simvx.core.math.types.Vec2]) -> list[simvx.core.math.types.Vec2]
:canonical: simvx.core.light2d.LightOccluder2D.transform_points

````

````{py:method} draw_polygon(renderer, points: list[simvx.core.math.types.Vec2], closed=True, color=None)
:canonical: simvx.core.light2d.LightOccluder2D.draw_polygon

````

````{py:method} wrap_screen(margin: float = 20)
:canonical: simvx.core.light2d.LightOccluder2D.wrap_screen

````

````{py:attribute} script_error_raised
:canonical: simvx.core.light2d.LightOccluder2D.script_error_raised
:value: >
   'Signal(...)'

````

````{py:method} __init_subclass__(**kwargs)
:canonical: simvx.core.light2d.LightOccluder2D.__init_subclass__
:classmethod:

````

````{py:property} name
:canonical: simvx.core.light2d.LightOccluder2D.name
:type: str

````

````{py:property} process_mode
:canonical: simvx.core.light2d.LightOccluder2D.process_mode
:type: simvx.core.descriptors.ProcessMode

````

````{py:method} reset_error() -> None
:canonical: simvx.core.light2d.LightOccluder2D.reset_error

````

````{py:method} add_child(node: simvx.core.node.Node) -> simvx.core.node.Node
:canonical: simvx.core.light2d.LightOccluder2D.add_child

````

````{py:method} remove_child(node: simvx.core.node.Node)
:canonical: simvx.core.light2d.LightOccluder2D.remove_child

````

````{py:method} reparent(new_parent: simvx.core.node.Node)
:canonical: simvx.core.light2d.LightOccluder2D.reparent

````

````{py:method} get_node(path: str) -> simvx.core.node.Node
:canonical: simvx.core.light2d.LightOccluder2D.get_node

````

````{py:method} find_child(name: str, recursive: bool = False) -> simvx.core.node.Node | None
:canonical: simvx.core.light2d.LightOccluder2D.find_child

````

````{py:method} find(node_type: type) -> simvx.core.node.Node | None
:canonical: simvx.core.light2d.LightOccluder2D.find

````

````{py:method} find_all(node_type: type, recursive: bool = True) -> list
:canonical: simvx.core.light2d.LightOccluder2D.find_all

````

````{py:property} path
:canonical: simvx.core.light2d.LightOccluder2D.path
:type: str

````

````{py:method} add_to_group(group: str)
:canonical: simvx.core.light2d.LightOccluder2D.add_to_group

````

````{py:method} remove_from_group(group: str)
:canonical: simvx.core.light2d.LightOccluder2D.remove_from_group

````

````{py:method} is_in_group(group: str) -> bool
:canonical: simvx.core.light2d.LightOccluder2D.is_in_group

````

````{py:method} ready() -> None
:canonical: simvx.core.light2d.LightOccluder2D.ready

````

````{py:method} enter_tree() -> None
:canonical: simvx.core.light2d.LightOccluder2D.enter_tree

````

````{py:method} exit_tree() -> None
:canonical: simvx.core.light2d.LightOccluder2D.exit_tree

````

````{py:method} process(dt: float) -> None
:canonical: simvx.core.light2d.LightOccluder2D.process

````

````{py:method} physics_process(dt: float) -> None
:canonical: simvx.core.light2d.LightOccluder2D.physics_process

````

````{py:method} draw(renderer) -> None
:canonical: simvx.core.light2d.LightOccluder2D.draw

````

````{py:method} input_event(event: simvx.core.events.InputEvent) -> None
:canonical: simvx.core.light2d.LightOccluder2D.input_event

````

````{py:method} input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.light2d.LightOccluder2D.input

````

````{py:method} unhandled_input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.light2d.LightOccluder2D.unhandled_input

````

````{py:method} start_coroutine(gen: simvx.core.descriptors.Coroutine) -> simvx.core.descriptors.CoroutineHandle
:canonical: simvx.core.light2d.LightOccluder2D.start_coroutine

````

````{py:method} stop_coroutine(gen_or_handle)
:canonical: simvx.core.light2d.LightOccluder2D.stop_coroutine

````

````{py:method} destroy()
:canonical: simvx.core.light2d.LightOccluder2D.destroy

````

````{py:attribute} queue_free
:canonical: simvx.core.light2d.LightOccluder2D.queue_free
:value: >
   None

````

````{py:property} tree
:canonical: simvx.core.light2d.LightOccluder2D.tree
:type: simvx.core.scene_tree.SceneTree

````

````{py:method} get_tree() -> simvx.core.scene_tree.SceneTree
:canonical: simvx.core.light2d.LightOccluder2D.get_tree

````

````{py:method} __getitem__(key: str)
:canonical: simvx.core.light2d.LightOccluder2D.__getitem__

````

````{py:method} get_properties() -> dict[str, simvx.core.descriptors.Property]
:canonical: simvx.core.light2d.LightOccluder2D.get_properties
:classmethod:

````

````{py:attribute} get_settings
:canonical: simvx.core.light2d.LightOccluder2D.get_settings
:value: >
   None

````

````{py:method} __repr__()
:canonical: simvx.core.light2d.LightOccluder2D.__repr__

````

`````

````{py:function} collect_lights(root: simvx.core.engine.Node2D) -> list[simvx.core.light2d.Light2D]
:canonical: simvx.core.light2d.collect_lights

```{autodoc2-docstring} simvx.core.light2d.collect_lights
```
````

````{py:function} collect_occluders(root: simvx.core.engine.Node2D) -> list[simvx.core.light2d.LightOccluder2D]
:canonical: simvx.core.light2d.collect_occluders

```{autodoc2-docstring} simvx.core.light2d.collect_occluders
```
````