# {py:mod}`simvx.core.nodes_2d.canvas`

```{py:module} simvx.core.nodes_2d.canvas
```

```{autodoc2-docstring} simvx.core.nodes_2d.canvas
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`CanvasLayer <simvx.core.nodes_2d.canvas.CanvasLayer>`
  - ```{autodoc2-docstring} simvx.core.nodes_2d.canvas.CanvasLayer
    :summary:
    ```
* - {py:obj}`ParallaxBackground <simvx.core.nodes_2d.canvas.ParallaxBackground>`
  - ```{autodoc2-docstring} simvx.core.nodes_2d.canvas.ParallaxBackground
    :summary:
    ```
* - {py:obj}`ParallaxLayer <simvx.core.nodes_2d.canvas.ParallaxLayer>`
  - ```{autodoc2-docstring} simvx.core.nodes_2d.canvas.ParallaxLayer
    :summary:
    ```
* - {py:obj}`CanvasModulate <simvx.core.nodes_2d.canvas.CanvasModulate>`
  - ```{autodoc2-docstring} simvx.core.nodes_2d.canvas.CanvasModulate
    :summary:
    ```
````

### API

`````{py:class} CanvasLayer(name: str = '', **kwargs)
:canonical: simvx.core.nodes_2d.canvas.CanvasLayer

Bases: {py:obj}`simvx.core.node.Node`

```{autodoc2-docstring} simvx.core.nodes_2d.canvas.CanvasLayer
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.nodes_2d.canvas.CanvasLayer.__init__
```

````{py:attribute} layer
:canonical: simvx.core.nodes_2d.canvas.CanvasLayer.layer
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.nodes_2d.canvas.CanvasLayer.layer
```

````

````{py:attribute} offset
:canonical: simvx.core.nodes_2d.canvas.CanvasLayer.offset
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.nodes_2d.canvas.CanvasLayer.offset
```

````

````{py:attribute} rotation
:canonical: simvx.core.nodes_2d.canvas.CanvasLayer.rotation
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.nodes_2d.canvas.CanvasLayer.rotation
```

````

````{py:attribute} scale_val
:canonical: simvx.core.nodes_2d.canvas.CanvasLayer.scale_val
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.nodes_2d.canvas.CanvasLayer.scale_val
```

````

````{py:attribute} follow_viewport
:canonical: simvx.core.nodes_2d.canvas.CanvasLayer.follow_viewport
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.nodes_2d.canvas.CanvasLayer.follow_viewport
```

````

````{py:attribute} strict_errors
:canonical: simvx.core.nodes_2d.canvas.CanvasLayer.strict_errors
:type: typing.ClassVar[bool]
:value: >
   True

````

````{py:attribute} script_error_raised
:canonical: simvx.core.nodes_2d.canvas.CanvasLayer.script_error_raised
:value: >
   'Signal(...)'

````

````{py:method} __init_subclass__(**kwargs)
:canonical: simvx.core.nodes_2d.canvas.CanvasLayer.__init_subclass__
:classmethod:

````

````{py:property} name
:canonical: simvx.core.nodes_2d.canvas.CanvasLayer.name
:type: str

````

````{py:property} process_mode
:canonical: simvx.core.nodes_2d.canvas.CanvasLayer.process_mode
:type: simvx.core.descriptors.ProcessMode

````

````{py:method} reset_error() -> None
:canonical: simvx.core.nodes_2d.canvas.CanvasLayer.reset_error

````

````{py:method} add_child(node: simvx.core.node.Node) -> simvx.core.node.Node
:canonical: simvx.core.nodes_2d.canvas.CanvasLayer.add_child

````

````{py:method} remove_child(node: simvx.core.node.Node)
:canonical: simvx.core.nodes_2d.canvas.CanvasLayer.remove_child

````

````{py:method} reparent(new_parent: simvx.core.node.Node)
:canonical: simvx.core.nodes_2d.canvas.CanvasLayer.reparent

````

````{py:method} get_node(path: str) -> simvx.core.node.Node
:canonical: simvx.core.nodes_2d.canvas.CanvasLayer.get_node

````

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

````

````{py:method} find(node_type: type, recursive: bool = True) -> simvx.core.node.Node | None
:canonical: simvx.core.nodes_2d.canvas.CanvasLayer.find

````

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

````

````{py:property} path
:canonical: simvx.core.nodes_2d.canvas.CanvasLayer.path
:type: str

````

````{py:method} add_to_group(group: str)
:canonical: simvx.core.nodes_2d.canvas.CanvasLayer.add_to_group

````

````{py:method} remove_from_group(group: str)
:canonical: simvx.core.nodes_2d.canvas.CanvasLayer.remove_from_group

````

````{py:method} is_in_group(group: str) -> bool
:canonical: simvx.core.nodes_2d.canvas.CanvasLayer.is_in_group

````

````{py:method} ready() -> None
:canonical: simvx.core.nodes_2d.canvas.CanvasLayer.ready

````

````{py:method} enter_tree() -> None
:canonical: simvx.core.nodes_2d.canvas.CanvasLayer.enter_tree

````

````{py:method} exit_tree() -> None
:canonical: simvx.core.nodes_2d.canvas.CanvasLayer.exit_tree

````

````{py:method} process(dt: float) -> None
:canonical: simvx.core.nodes_2d.canvas.CanvasLayer.process

````

````{py:method} physics_process(dt: float) -> None
:canonical: simvx.core.nodes_2d.canvas.CanvasLayer.physics_process

````

````{py:method} draw(renderer) -> None
:canonical: simvx.core.nodes_2d.canvas.CanvasLayer.draw

````

````{py:method} input_event(event: simvx.core.events.InputEvent) -> None
:canonical: simvx.core.nodes_2d.canvas.CanvasLayer.input_event

````

````{py:method} input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.nodes_2d.canvas.CanvasLayer.input

````

````{py:method} unhandled_input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.nodes_2d.canvas.CanvasLayer.unhandled_input

````

````{py:method} start_coroutine(gen: simvx.core.descriptors.Coroutine) -> simvx.core.descriptors.CoroutineHandle
:canonical: simvx.core.nodes_2d.canvas.CanvasLayer.start_coroutine

````

````{py:method} stop_coroutine(gen_or_handle)
:canonical: simvx.core.nodes_2d.canvas.CanvasLayer.stop_coroutine

````

````{py:method} clear_children()
:canonical: simvx.core.nodes_2d.canvas.CanvasLayer.clear_children

````

````{py:method} destroy()
:canonical: simvx.core.nodes_2d.canvas.CanvasLayer.destroy

````

````{py:property} app
:canonical: simvx.core.nodes_2d.canvas.CanvasLayer.app

````

````{py:property} tree
:canonical: simvx.core.nodes_2d.canvas.CanvasLayer.tree
:type: simvx.core.scene_tree.SceneTree

````

````{py:method} get_tree() -> simvx.core.scene_tree.SceneTree
:canonical: simvx.core.nodes_2d.canvas.CanvasLayer.get_tree

````

````{py:method} __getitem__(key: str)
:canonical: simvx.core.nodes_2d.canvas.CanvasLayer.__getitem__

````

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

````

````{py:method} __repr__()
:canonical: simvx.core.nodes_2d.canvas.CanvasLayer.__repr__

````

`````

`````{py:class} ParallaxBackground(name: str = '', **kwargs)
:canonical: simvx.core.nodes_2d.canvas.ParallaxBackground

Bases: {py:obj}`simvx.core.nodes_2d.canvas.CanvasLayer`

```{autodoc2-docstring} simvx.core.nodes_2d.canvas.ParallaxBackground
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.nodes_2d.canvas.ParallaxBackground.__init__
```

````{py:attribute} scroll_offset
:canonical: simvx.core.nodes_2d.canvas.ParallaxBackground.scroll_offset
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.nodes_2d.canvas.ParallaxBackground.scroll_offset
```

````

````{py:attribute} scroll_base_offset
:canonical: simvx.core.nodes_2d.canvas.ParallaxBackground.scroll_base_offset
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.nodes_2d.canvas.ParallaxBackground.scroll_base_offset
```

````

````{py:attribute} scroll_base_scale
:canonical: simvx.core.nodes_2d.canvas.ParallaxBackground.scroll_base_scale
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.nodes_2d.canvas.ParallaxBackground.scroll_base_scale
```

````

````{py:attribute} layer
:canonical: simvx.core.nodes_2d.canvas.ParallaxBackground.layer
:value: >
   'Property(...)'

````

````{py:attribute} offset
:canonical: simvx.core.nodes_2d.canvas.ParallaxBackground.offset
:value: >
   'Property(...)'

````

````{py:attribute} rotation
:canonical: simvx.core.nodes_2d.canvas.ParallaxBackground.rotation
:value: >
   'Property(...)'

````

````{py:attribute} scale_val
:canonical: simvx.core.nodes_2d.canvas.ParallaxBackground.scale_val
:value: >
   'Property(...)'

````

````{py:attribute} follow_viewport
:canonical: simvx.core.nodes_2d.canvas.ParallaxBackground.follow_viewport
:value: >
   'Property(...)'

````

````{py:attribute} strict_errors
:canonical: simvx.core.nodes_2d.canvas.ParallaxBackground.strict_errors
:type: typing.ClassVar[bool]
:value: >
   True

````

````{py:attribute} script_error_raised
:canonical: simvx.core.nodes_2d.canvas.ParallaxBackground.script_error_raised
:value: >
   'Signal(...)'

````

````{py:method} __init_subclass__(**kwargs)
:canonical: simvx.core.nodes_2d.canvas.ParallaxBackground.__init_subclass__
:classmethod:

````

````{py:property} name
:canonical: simvx.core.nodes_2d.canvas.ParallaxBackground.name
:type: str

````

````{py:property} process_mode
:canonical: simvx.core.nodes_2d.canvas.ParallaxBackground.process_mode
:type: simvx.core.descriptors.ProcessMode

````

````{py:method} reset_error() -> None
:canonical: simvx.core.nodes_2d.canvas.ParallaxBackground.reset_error

````

````{py:method} add_child(node: simvx.core.node.Node) -> simvx.core.node.Node
:canonical: simvx.core.nodes_2d.canvas.ParallaxBackground.add_child

````

````{py:method} remove_child(node: simvx.core.node.Node)
:canonical: simvx.core.nodes_2d.canvas.ParallaxBackground.remove_child

````

````{py:method} reparent(new_parent: simvx.core.node.Node)
:canonical: simvx.core.nodes_2d.canvas.ParallaxBackground.reparent

````

````{py:method} get_node(path: str) -> simvx.core.node.Node
:canonical: simvx.core.nodes_2d.canvas.ParallaxBackground.get_node

````

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

````

````{py:method} find(node_type: type, recursive: bool = True) -> simvx.core.node.Node | None
:canonical: simvx.core.nodes_2d.canvas.ParallaxBackground.find

````

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

````

````{py:property} path
:canonical: simvx.core.nodes_2d.canvas.ParallaxBackground.path
:type: str

````

````{py:method} add_to_group(group: str)
:canonical: simvx.core.nodes_2d.canvas.ParallaxBackground.add_to_group

````

````{py:method} remove_from_group(group: str)
:canonical: simvx.core.nodes_2d.canvas.ParallaxBackground.remove_from_group

````

````{py:method} is_in_group(group: str) -> bool
:canonical: simvx.core.nodes_2d.canvas.ParallaxBackground.is_in_group

````

````{py:method} ready() -> None
:canonical: simvx.core.nodes_2d.canvas.ParallaxBackground.ready

````

````{py:method} enter_tree() -> None
:canonical: simvx.core.nodes_2d.canvas.ParallaxBackground.enter_tree

````

````{py:method} exit_tree() -> None
:canonical: simvx.core.nodes_2d.canvas.ParallaxBackground.exit_tree

````

````{py:method} process(dt: float) -> None
:canonical: simvx.core.nodes_2d.canvas.ParallaxBackground.process

````

````{py:method} physics_process(dt: float) -> None
:canonical: simvx.core.nodes_2d.canvas.ParallaxBackground.physics_process

````

````{py:method} draw(renderer) -> None
:canonical: simvx.core.nodes_2d.canvas.ParallaxBackground.draw

````

````{py:method} input_event(event: simvx.core.events.InputEvent) -> None
:canonical: simvx.core.nodes_2d.canvas.ParallaxBackground.input_event

````

````{py:method} input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.nodes_2d.canvas.ParallaxBackground.input

````

````{py:method} unhandled_input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.nodes_2d.canvas.ParallaxBackground.unhandled_input

````

````{py:method} start_coroutine(gen: simvx.core.descriptors.Coroutine) -> simvx.core.descriptors.CoroutineHandle
:canonical: simvx.core.nodes_2d.canvas.ParallaxBackground.start_coroutine

````

````{py:method} stop_coroutine(gen_or_handle)
:canonical: simvx.core.nodes_2d.canvas.ParallaxBackground.stop_coroutine

````

````{py:method} clear_children()
:canonical: simvx.core.nodes_2d.canvas.ParallaxBackground.clear_children

````

````{py:method} destroy()
:canonical: simvx.core.nodes_2d.canvas.ParallaxBackground.destroy

````

````{py:property} app
:canonical: simvx.core.nodes_2d.canvas.ParallaxBackground.app

````

````{py:property} tree
:canonical: simvx.core.nodes_2d.canvas.ParallaxBackground.tree
:type: simvx.core.scene_tree.SceneTree

````

````{py:method} get_tree() -> simvx.core.scene_tree.SceneTree
:canonical: simvx.core.nodes_2d.canvas.ParallaxBackground.get_tree

````

````{py:method} __getitem__(key: str)
:canonical: simvx.core.nodes_2d.canvas.ParallaxBackground.__getitem__

````

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

````

````{py:method} __repr__()
:canonical: simvx.core.nodes_2d.canvas.ParallaxBackground.__repr__

````

`````

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

Bases: {py:obj}`simvx.core.nodes_2d.node2d.Node2D`

```{autodoc2-docstring} simvx.core.nodes_2d.canvas.ParallaxLayer
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.nodes_2d.canvas.ParallaxLayer.__init__
```

````{py:attribute} motion_scale
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.motion_scale
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.nodes_2d.canvas.ParallaxLayer.motion_scale
```

````

````{py:attribute} motion_offset
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.motion_offset
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.nodes_2d.canvas.ParallaxLayer.motion_offset
```

````

````{py:attribute} mirroring
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.mirroring
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.nodes_2d.canvas.ParallaxLayer.mirroring
```

````

````{py:property} effective_offset
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.effective_offset
:type: tuple[float, float]

```{autodoc2-docstring} simvx.core.nodes_2d.canvas.ParallaxLayer.effective_offset
```

````

````{py:attribute} z_index
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.z_index
:value: >
   'Property(...)'

````

````{py:attribute} z_as_relative
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.z_as_relative
:value: >
   'Property(...)'

````

````{py:attribute} render_layer
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.render_layer
:value: >
   'Property(...)'

````

````{py:method} set_render_layer(index: int, enabled: bool = True) -> None
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.set_render_layer

````

````{py:method} is_on_render_layer(index: int) -> bool
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.is_on_render_layer

````

````{py:property} absolute_z_index
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.absolute_z_index
:type: int

````

````{py:property} position
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.position
:type: simvx.core.math.types.Vec2

````

````{py:property} rotation
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.rotation
:type: float

````

````{py:property} rotation_degrees
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.rotation_degrees
:type: float

````

````{py:property} scale
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.scale
:type: simvx.core.math.types.Vec2

````

````{py:property} world_position
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.world_position
:type: simvx.core.math.types.Vec2

````

````{py:property} world_rotation
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.world_rotation
:type: float

````

````{py:property} world_scale
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.world_scale
:type: simvx.core.math.types.Vec2

````

````{py:property} forward
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.forward
:type: simvx.core.math.types.Vec2

````

````{py:property} right
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.right
:type: simvx.core.math.types.Vec2

````

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

````

````{py:method} rotate(radians: float)
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.rotate

````

````{py:method} rotate_deg(degrees: float)
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.rotate_deg

````

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

````

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

````

````{py:method} draw_polygon(renderer, points: list[simvx.core.math.types.Vec2], closed=True, colour=None)
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.draw_polygon

````

````{py:method} wrap_screen(margin: float = 20)
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.wrap_screen

````

````{py:attribute} strict_errors
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.strict_errors
:type: typing.ClassVar[bool]
:value: >
   True

````

````{py:attribute} script_error_raised
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.script_error_raised
:value: >
   'Signal(...)'

````

````{py:method} __init_subclass__(**kwargs)
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.__init_subclass__
:classmethod:

````

````{py:property} name
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.name
:type: str

````

````{py:property} process_mode
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.process_mode
:type: simvx.core.descriptors.ProcessMode

````

````{py:method} reset_error() -> None
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.reset_error

````

````{py:method} add_child(node: simvx.core.node.Node) -> simvx.core.node.Node
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.add_child

````

````{py:method} remove_child(node: simvx.core.node.Node)
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.remove_child

````

````{py:method} reparent(new_parent: simvx.core.node.Node)
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.reparent

````

````{py:method} get_node(path: str) -> simvx.core.node.Node
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.get_node

````

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

````

````{py:method} find(node_type: type, recursive: bool = True) -> simvx.core.node.Node | None
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.find

````

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

````

````{py:property} path
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.path
:type: str

````

````{py:method} add_to_group(group: str)
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.add_to_group

````

````{py:method} remove_from_group(group: str)
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.remove_from_group

````

````{py:method} is_in_group(group: str) -> bool
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.is_in_group

````

````{py:method} ready() -> None
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.ready

````

````{py:method} enter_tree() -> None
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.enter_tree

````

````{py:method} exit_tree() -> None
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.exit_tree

````

````{py:method} process(dt: float) -> None
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.process

````

````{py:method} physics_process(dt: float) -> None
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.physics_process

````

````{py:method} draw(renderer) -> None
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.draw

````

````{py:method} input_event(event: simvx.core.events.InputEvent) -> None
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.input_event

````

````{py:method} input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.input

````

````{py:method} unhandled_input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.unhandled_input

````

````{py:method} start_coroutine(gen: simvx.core.descriptors.Coroutine) -> simvx.core.descriptors.CoroutineHandle
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.start_coroutine

````

````{py:method} stop_coroutine(gen_or_handle)
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.stop_coroutine

````

````{py:method} clear_children()
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.clear_children

````

````{py:method} destroy()
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.destroy

````

````{py:property} app
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.app

````

````{py:property} tree
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.tree
:type: simvx.core.scene_tree.SceneTree

````

````{py:method} get_tree() -> simvx.core.scene_tree.SceneTree
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.get_tree

````

````{py:method} __getitem__(key: str)
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.__getitem__

````

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

````

````{py:method} __repr__()
:canonical: simvx.core.nodes_2d.canvas.ParallaxLayer.__repr__

````

`````

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

Bases: {py:obj}`simvx.core.nodes_2d.node2d.Node2D`

```{autodoc2-docstring} simvx.core.nodes_2d.canvas.CanvasModulate
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.nodes_2d.canvas.CanvasModulate.__init__
```

````{py:attribute} colour
:canonical: simvx.core.nodes_2d.canvas.CanvasModulate.colour
:value: >
   'Property(...)'

```{autodoc2-docstring} simvx.core.nodes_2d.canvas.CanvasModulate.colour
```

````

````{py:attribute} z_index
:canonical: simvx.core.nodes_2d.canvas.CanvasModulate.z_index
:value: >
   'Property(...)'

````

````{py:attribute} z_as_relative
:canonical: simvx.core.nodes_2d.canvas.CanvasModulate.z_as_relative
:value: >
   'Property(...)'

````

````{py:attribute} render_layer
:canonical: simvx.core.nodes_2d.canvas.CanvasModulate.render_layer
:value: >
   'Property(...)'

````

````{py:method} set_render_layer(index: int, enabled: bool = True) -> None
:canonical: simvx.core.nodes_2d.canvas.CanvasModulate.set_render_layer

````

````{py:method} is_on_render_layer(index: int) -> bool
:canonical: simvx.core.nodes_2d.canvas.CanvasModulate.is_on_render_layer

````

````{py:property} absolute_z_index
:canonical: simvx.core.nodes_2d.canvas.CanvasModulate.absolute_z_index
:type: int

````

````{py:property} position
:canonical: simvx.core.nodes_2d.canvas.CanvasModulate.position
:type: simvx.core.math.types.Vec2

````

````{py:property} rotation
:canonical: simvx.core.nodes_2d.canvas.CanvasModulate.rotation
:type: float

````

````{py:property} rotation_degrees
:canonical: simvx.core.nodes_2d.canvas.CanvasModulate.rotation_degrees
:type: float

````

````{py:property} scale
:canonical: simvx.core.nodes_2d.canvas.CanvasModulate.scale
:type: simvx.core.math.types.Vec2

````

````{py:property} world_position
:canonical: simvx.core.nodes_2d.canvas.CanvasModulate.world_position
:type: simvx.core.math.types.Vec2

````

````{py:property} world_rotation
:canonical: simvx.core.nodes_2d.canvas.CanvasModulate.world_rotation
:type: float

````

````{py:property} world_scale
:canonical: simvx.core.nodes_2d.canvas.CanvasModulate.world_scale
:type: simvx.core.math.types.Vec2

````

````{py:property} forward
:canonical: simvx.core.nodes_2d.canvas.CanvasModulate.forward
:type: simvx.core.math.types.Vec2

````

````{py:property} right
:canonical: simvx.core.nodes_2d.canvas.CanvasModulate.right
:type: simvx.core.math.types.Vec2

````

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

````

````{py:method} rotate(radians: float)
:canonical: simvx.core.nodes_2d.canvas.CanvasModulate.rotate

````

````{py:method} rotate_deg(degrees: float)
:canonical: simvx.core.nodes_2d.canvas.CanvasModulate.rotate_deg

````

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

````

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

````

````{py:method} draw_polygon(renderer, points: list[simvx.core.math.types.Vec2], closed=True, colour=None)
:canonical: simvx.core.nodes_2d.canvas.CanvasModulate.draw_polygon

````

````{py:method} wrap_screen(margin: float = 20)
:canonical: simvx.core.nodes_2d.canvas.CanvasModulate.wrap_screen

````

````{py:attribute} strict_errors
:canonical: simvx.core.nodes_2d.canvas.CanvasModulate.strict_errors
:type: typing.ClassVar[bool]
:value: >
   True

````

````{py:attribute} script_error_raised
:canonical: simvx.core.nodes_2d.canvas.CanvasModulate.script_error_raised
:value: >
   'Signal(...)'

````

````{py:method} __init_subclass__(**kwargs)
:canonical: simvx.core.nodes_2d.canvas.CanvasModulate.__init_subclass__
:classmethod:

````

````{py:property} name
:canonical: simvx.core.nodes_2d.canvas.CanvasModulate.name
:type: str

````

````{py:property} process_mode
:canonical: simvx.core.nodes_2d.canvas.CanvasModulate.process_mode
:type: simvx.core.descriptors.ProcessMode

````

````{py:method} reset_error() -> None
:canonical: simvx.core.nodes_2d.canvas.CanvasModulate.reset_error

````

````{py:method} add_child(node: simvx.core.node.Node) -> simvx.core.node.Node
:canonical: simvx.core.nodes_2d.canvas.CanvasModulate.add_child

````

````{py:method} remove_child(node: simvx.core.node.Node)
:canonical: simvx.core.nodes_2d.canvas.CanvasModulate.remove_child

````

````{py:method} reparent(new_parent: simvx.core.node.Node)
:canonical: simvx.core.nodes_2d.canvas.CanvasModulate.reparent

````

````{py:method} get_node(path: str) -> simvx.core.node.Node
:canonical: simvx.core.nodes_2d.canvas.CanvasModulate.get_node

````

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

````

````{py:method} find(node_type: type, recursive: bool = True) -> simvx.core.node.Node | None
:canonical: simvx.core.nodes_2d.canvas.CanvasModulate.find

````

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

````

````{py:property} path
:canonical: simvx.core.nodes_2d.canvas.CanvasModulate.path
:type: str

````

````{py:method} add_to_group(group: str)
:canonical: simvx.core.nodes_2d.canvas.CanvasModulate.add_to_group

````

````{py:method} remove_from_group(group: str)
:canonical: simvx.core.nodes_2d.canvas.CanvasModulate.remove_from_group

````

````{py:method} is_in_group(group: str) -> bool
:canonical: simvx.core.nodes_2d.canvas.CanvasModulate.is_in_group

````

````{py:method} ready() -> None
:canonical: simvx.core.nodes_2d.canvas.CanvasModulate.ready

````

````{py:method} enter_tree() -> None
:canonical: simvx.core.nodes_2d.canvas.CanvasModulate.enter_tree

````

````{py:method} exit_tree() -> None
:canonical: simvx.core.nodes_2d.canvas.CanvasModulate.exit_tree

````

````{py:method} process(dt: float) -> None
:canonical: simvx.core.nodes_2d.canvas.CanvasModulate.process

````

````{py:method} physics_process(dt: float) -> None
:canonical: simvx.core.nodes_2d.canvas.CanvasModulate.physics_process

````

````{py:method} draw(renderer) -> None
:canonical: simvx.core.nodes_2d.canvas.CanvasModulate.draw

````

````{py:method} input_event(event: simvx.core.events.InputEvent) -> None
:canonical: simvx.core.nodes_2d.canvas.CanvasModulate.input_event

````

````{py:method} input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.nodes_2d.canvas.CanvasModulate.input

````

````{py:method} unhandled_input(event: simvx.core.events.TreeInputEvent) -> None
:canonical: simvx.core.nodes_2d.canvas.CanvasModulate.unhandled_input

````

````{py:method} start_coroutine(gen: simvx.core.descriptors.Coroutine) -> simvx.core.descriptors.CoroutineHandle
:canonical: simvx.core.nodes_2d.canvas.CanvasModulate.start_coroutine

````

````{py:method} stop_coroutine(gen_or_handle)
:canonical: simvx.core.nodes_2d.canvas.CanvasModulate.stop_coroutine

````

````{py:method} clear_children()
:canonical: simvx.core.nodes_2d.canvas.CanvasModulate.clear_children

````

````{py:method} destroy()
:canonical: simvx.core.nodes_2d.canvas.CanvasModulate.destroy

````

````{py:property} app
:canonical: simvx.core.nodes_2d.canvas.CanvasModulate.app

````

````{py:property} tree
:canonical: simvx.core.nodes_2d.canvas.CanvasModulate.tree
:type: simvx.core.scene_tree.SceneTree

````

````{py:method} get_tree() -> simvx.core.scene_tree.SceneTree
:canonical: simvx.core.nodes_2d.canvas.CanvasModulate.get_tree

````

````{py:method} __getitem__(key: str)
:canonical: simvx.core.nodes_2d.canvas.CanvasModulate.__getitem__

````

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

````

````{py:method} __repr__()
:canonical: simvx.core.nodes_2d.canvas.CanvasModulate.__repr__

````

`````