# {py:mod}`simvx.core.ui.overlay`

```{py:module} simvx.core.ui.overlay
```

```{autodoc2-docstring} simvx.core.ui.overlay
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`OverlayEntry <simvx.core.ui.overlay.OverlayEntry>`
  - ```{autodoc2-docstring} simvx.core.ui.overlay.OverlayEntry
    :summary:
    ```
* - {py:obj}`OverlayLayer <simvx.core.ui.overlay.OverlayLayer>`
  - ```{autodoc2-docstring} simvx.core.ui.overlay.OverlayLayer
    :summary:
    ```
````

### Functions

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

* - {py:obj}`iter_overlay_draws <simvx.core.ui.overlay.iter_overlay_draws>`
  - ```{autodoc2-docstring} simvx.core.ui.overlay.iter_overlay_draws
    :summary:
    ```
````

### Data

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

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

### API

````{py:data} __all__
:canonical: simvx.core.ui.overlay.__all__
:value: >
   ['OverlayEntry', 'OverlayLayer', 'iter_overlay_draws', 'DEFAULT_SCRIM_COLOUR']

```{autodoc2-docstring} simvx.core.ui.overlay.__all__
```

````

````{py:data} DEFAULT_SCRIM_COLOUR
:canonical: simvx.core.ui.overlay.DEFAULT_SCRIM_COLOUR
:type: tuple[float, float, float, float]
:value: >
   (0.0, 0.0, 0.0, 0.5)

```{autodoc2-docstring} simvx.core.ui.overlay.DEFAULT_SCRIM_COLOUR
```

````

`````{py:class} OverlayEntry
:canonical: simvx.core.ui.overlay.OverlayEntry

```{autodoc2-docstring} simvx.core.ui.overlay.OverlayEntry
```

````{py:attribute} control
:canonical: simvx.core.ui.overlay.OverlayEntry.control
:type: typing.Any
:value: >
   None

```{autodoc2-docstring} simvx.core.ui.overlay.OverlayEntry.control
```

````

````{py:attribute} modality
:canonical: simvx.core.ui.overlay.OverlayEntry.modality
:type: str
:value: >
   None

```{autodoc2-docstring} simvx.core.ui.overlay.OverlayEntry.modality
```

````

````{py:attribute} capture_input
:canonical: simvx.core.ui.overlay.OverlayEntry.capture_input
:type: bool
:value: >
   None

```{autodoc2-docstring} simvx.core.ui.overlay.OverlayEntry.capture_input
```

````

````{py:attribute} dim
:canonical: simvx.core.ui.overlay.OverlayEntry.dim
:type: bool
:value: >
   None

```{autodoc2-docstring} simvx.core.ui.overlay.OverlayEntry.dim
```

````

````{py:attribute} inert
:canonical: simvx.core.ui.overlay.OverlayEntry.inert
:type: bool
:value: >
   None

```{autodoc2-docstring} simvx.core.ui.overlay.OverlayEntry.inert
```

````

````{py:attribute} dismiss_on_outside_click
:canonical: simvx.core.ui.overlay.OverlayEntry.dismiss_on_outside_click
:type: bool
:value: >
   None

```{autodoc2-docstring} simvx.core.ui.overlay.OverlayEntry.dismiss_on_outside_click
```

````

````{py:attribute} dim_colour
:canonical: simvx.core.ui.overlay.OverlayEntry.dim_colour
:type: tuple[float, float, float, float]
:value: >
   None

```{autodoc2-docstring} simvx.core.ui.overlay.OverlayEntry.dim_colour
```

````

````{py:attribute} owner
:canonical: simvx.core.ui.overlay.OverlayEntry.owner
:type: typing.Any
:value: >
   None

```{autodoc2-docstring} simvx.core.ui.overlay.OverlayEntry.owner
```

````

````{py:attribute} viewport
:canonical: simvx.core.ui.overlay.OverlayEntry.viewport
:type: typing.Any
:value: >
   None

```{autodoc2-docstring} simvx.core.ui.overlay.OverlayEntry.viewport
```

````

````{py:attribute} prev_focus
:canonical: simvx.core.ui.overlay.OverlayEntry.prev_focus
:type: typing.Any
:value: >
   None

```{autodoc2-docstring} simvx.core.ui.overlay.OverlayEntry.prev_focus
```

````

````{py:method} expand_preset(modality: str, *, dim: bool | None = None, dismiss: bool | None = None, inert: bool | None = None) -> tuple[bool, bool, bool, bool]
:canonical: simvx.core.ui.overlay.OverlayEntry.expand_preset
:staticmethod:

```{autodoc2-docstring} simvx.core.ui.overlay.OverlayEntry.expand_preset
```

````

`````

`````{py:class} OverlayLayer(tree: typing.Any)
:canonical: simvx.core.ui.overlay.OverlayLayer

```{autodoc2-docstring} simvx.core.ui.overlay.OverlayLayer
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.core.ui.overlay.OverlayLayer.__init__
```

````{py:attribute} __slots__
:canonical: simvx.core.ui.overlay.OverlayLayer.__slots__
:value: >
   ('_tree', '_entries')

```{autodoc2-docstring} simvx.core.ui.overlay.OverlayLayer.__slots__
```

````

````{py:method} __bool__() -> bool
:canonical: simvx.core.ui.overlay.OverlayLayer.__bool__

```{autodoc2-docstring} simvx.core.ui.overlay.OverlayLayer.__bool__
```

````

````{py:method} __len__() -> int
:canonical: simvx.core.ui.overlay.OverlayLayer.__len__

```{autodoc2-docstring} simvx.core.ui.overlay.OverlayLayer.__len__
```

````

````{py:method} open(control: typing.Any, entry: simvx.core.ui.overlay.OverlayEntry) -> None
:canonical: simvx.core.ui.overlay.OverlayLayer.open

```{autodoc2-docstring} simvx.core.ui.overlay.OverlayLayer.open
```

````

````{py:method} close(control: typing.Any) -> None
:canonical: simvx.core.ui.overlay.OverlayLayer.close

```{autodoc2-docstring} simvx.core.ui.overlay.OverlayLayer.close
```

````

````{py:method} chain_base(owner: typing.Any) -> typing.Any | None
:canonical: simvx.core.ui.overlay.OverlayLayer.chain_base

```{autodoc2-docstring} simvx.core.ui.overlay.OverlayLayer.chain_base
```

````

````{py:method} close_all() -> None
:canonical: simvx.core.ui.overlay.OverlayLayer.close_all

```{autodoc2-docstring} simvx.core.ui.overlay.OverlayLayer.close_all
```

````

````{py:method} draw_set() -> tuple[typing.Any, ...]
:canonical: simvx.core.ui.overlay.OverlayLayer.draw_set

```{autodoc2-docstring} simvx.core.ui.overlay.OverlayLayer.draw_set
```

````

````{py:method} topmost_capturing() -> typing.Any | None
:canonical: simvx.core.ui.overlay.OverlayLayer.topmost_capturing

```{autodoc2-docstring} simvx.core.ui.overlay.OverlayLayer.topmost_capturing
```

````

````{py:method} any_inert() -> bool
:canonical: simvx.core.ui.overlay.OverlayLayer.any_inert

```{autodoc2-docstring} simvx.core.ui.overlay.OverlayLayer.any_inert
```

````

````{py:method} entry_of(control: typing.Any) -> simvx.core.ui.overlay.OverlayEntry | None
:canonical: simvx.core.ui.overlay.OverlayLayer.entry_of

```{autodoc2-docstring} simvx.core.ui.overlay.OverlayLayer.entry_of
```

````

````{py:method} scope_root_of(control: typing.Any) -> typing.Any
:canonical: simvx.core.ui.overlay.OverlayLayer.scope_root_of

```{autodoc2-docstring} simvx.core.ui.overlay.OverlayLayer.scope_root_of
```

````

`````

````{py:function} iter_overlay_draws(tree: typing.Any, *, viewport: typing.Any = None) -> collections.abc.Iterator[tuple[str, typing.Any, simvx.core.ui.overlay.OverlayEntry]]
:canonical: simvx.core.ui.overlay.iter_overlay_draws

```{autodoc2-docstring} simvx.core.ui.overlay.iter_overlay_draws
```
````