# {py:mod}`simvx.graphics.gpu.retire`

```{py:module} simvx.graphics.gpu.retire
```

```{autodoc2-docstring} simvx.graphics.gpu.retire
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`RetireQueue <simvx.graphics.gpu.retire.RetireQueue>`
  - ```{autodoc2-docstring} simvx.graphics.gpu.retire.RetireQueue
    :summary:
    ```
````

### Data

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

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

### API

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

```{autodoc2-docstring} simvx.graphics.gpu.retire.log
```

````

````{py:data} __all__
:canonical: simvx.graphics.gpu.retire.__all__
:value: >
   ['RetireQueue']

```{autodoc2-docstring} simvx.graphics.gpu.retire.__all__
```

````

`````{py:class} RetireQueue(depth: int = FRAMES_IN_FLIGHT)
:canonical: simvx.graphics.gpu.retire.RetireQueue

```{autodoc2-docstring} simvx.graphics.gpu.retire.RetireQueue
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.graphics.gpu.retire.RetireQueue.__init__
```

````{py:property} depth
:canonical: simvx.graphics.gpu.retire.RetireQueue.depth
:type: int

```{autodoc2-docstring} simvx.graphics.gpu.retire.RetireQueue.depth
```

````

````{py:property} pending
:canonical: simvx.graphics.gpu.retire.RetireQueue.pending
:type: int

```{autodoc2-docstring} simvx.graphics.gpu.retire.RetireQueue.pending
```

````

````{py:property} closed
:canonical: simvx.graphics.gpu.retire.RetireQueue.closed
:type: bool

```{autodoc2-docstring} simvx.graphics.gpu.retire.RetireQueue.closed
```

````

````{py:method} retire(free: collections.abc.Callable[[], None]) -> None
:canonical: simvx.graphics.gpu.retire.RetireQueue.retire

```{autodoc2-docstring} simvx.graphics.gpu.retire.RetireQueue.retire
```

````

````{py:method} retire_handles(device: typing.Any, **handles: typing.Any) -> None
:canonical: simvx.graphics.gpu.retire.RetireQueue.retire_handles

```{autodoc2-docstring} simvx.graphics.gpu.retire.RetireQueue.retire_handles
```

````

````{py:method} frame_completed() -> None
:canonical: simvx.graphics.gpu.retire.RetireQueue.frame_completed

```{autodoc2-docstring} simvx.graphics.gpu.retire.RetireQueue.frame_completed
```

````

````{py:method} drain(*, close: bool = True) -> None
:canonical: simvx.graphics.gpu.retire.RetireQueue.drain

```{autodoc2-docstring} simvx.graphics.gpu.retire.RetireQueue.drain
```

````

````{py:method} abandon() -> None
:canonical: simvx.graphics.gpu.retire.RetireQueue.abandon

```{autodoc2-docstring} simvx.graphics.gpu.retire.RetireQueue.abandon
```

````

`````