# {py:mod}`simvx.graphics.cook`

```{py:module} simvx.graphics.cook
```

```{autodoc2-docstring} simvx.graphics.cook
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`CookReport <simvx.graphics.cook.CookReport>`
  - ```{autodoc2-docstring} simvx.graphics.cook.CookReport
    :summary:
    ```
````

### Functions

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

* - {py:obj}`full_mip_count <simvx.graphics.cook.full_mip_count>`
  - ```{autodoc2-docstring} simvx.graphics.cook.full_mip_count
    :summary:
    ```
* - {py:obj}`write_ktx2 <simvx.graphics.cook.write_ktx2>`
  - ```{autodoc2-docstring} simvx.graphics.cook.write_ktx2
    :summary:
    ```
* - {py:obj}`cook_ktx2_bytes <simvx.graphics.cook.cook_ktx2_bytes>`
  - ```{autodoc2-docstring} simvx.graphics.cook.cook_ktx2_bytes
    :summary:
    ```
* - {py:obj}`cook_file <simvx.graphics.cook.cook_file>`
  - ```{autodoc2-docstring} simvx.graphics.cook.cook_file
    :summary:
    ```
````

### Data

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

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

### API

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

```{autodoc2-docstring} simvx.graphics.cook.log
```

````

````{py:data} __all__
:canonical: simvx.graphics.cook.__all__
:value: >
   ['CookError', 'CookReport', 'cook_file', 'cook_ktx2_bytes', 'full_mip_count', 'write_ktx2']

```{autodoc2-docstring} simvx.graphics.cook.__all__
```

````

`````{py:exception} CookError()
:canonical: simvx.graphics.cook.CookError

Bases: {py:obj}`RuntimeError`

```{autodoc2-docstring} simvx.graphics.cook.CookError
```

```{rubric} Initialization
```

```{autodoc2-docstring} simvx.graphics.cook.CookError.__init__
```

```{py:class} __cause__
:canonical: simvx.graphics.cook.CookError.__cause__

```

```{py:class} __context__
:canonical: simvx.graphics.cook.CookError.__context__

```

````{py:method} __delattr__()
:canonical: simvx.graphics.cook.CookError.__delattr__

````

````{py:method} __dir__()
:canonical: simvx.graphics.cook.CookError.__dir__

````

````{py:method} __eq__()
:canonical: simvx.graphics.cook.CookError.__eq__

````

````{py:method} __format__()
:canonical: simvx.graphics.cook.CookError.__format__

````

````{py:method} __ge__()
:canonical: simvx.graphics.cook.CookError.__ge__

````

````{py:method} __getattribute__()
:canonical: simvx.graphics.cook.CookError.__getattribute__

````

````{py:method} __getstate__()
:canonical: simvx.graphics.cook.CookError.__getstate__

````

````{py:method} __gt__()
:canonical: simvx.graphics.cook.CookError.__gt__

````

````{py:method} __hash__()
:canonical: simvx.graphics.cook.CookError.__hash__

````

````{py:method} __le__()
:canonical: simvx.graphics.cook.CookError.__le__

````

````{py:method} __lt__()
:canonical: simvx.graphics.cook.CookError.__lt__

````

````{py:method} __ne__()
:canonical: simvx.graphics.cook.CookError.__ne__

````

````{py:method} __new__()
:canonical: simvx.graphics.cook.CookError.__new__

````

````{py:method} __reduce__()
:canonical: simvx.graphics.cook.CookError.__reduce__

````

````{py:method} __reduce_ex__()
:canonical: simvx.graphics.cook.CookError.__reduce_ex__

````

````{py:method} __repr__()
:canonical: simvx.graphics.cook.CookError.__repr__

````

````{py:method} __setattr__()
:canonical: simvx.graphics.cook.CookError.__setattr__

````

````{py:method} __setstate__()
:canonical: simvx.graphics.cook.CookError.__setstate__

````

````{py:method} __sizeof__()
:canonical: simvx.graphics.cook.CookError.__sizeof__

````

````{py:method} __str__()
:canonical: simvx.graphics.cook.CookError.__str__

````

````{py:method} __subclasshook__()
:canonical: simvx.graphics.cook.CookError.__subclasshook__

````

```{py:class} __suppress_context__
:canonical: simvx.graphics.cook.CookError.__suppress_context__

```

```{py:class} __traceback__
:canonical: simvx.graphics.cook.CookError.__traceback__

```

````{py:method} add_note()
:canonical: simvx.graphics.cook.CookError.add_note

````

```{py:class} args
:canonical: simvx.graphics.cook.CookError.args

```

````{py:method} with_traceback()
:canonical: simvx.graphics.cook.CookError.with_traceback

````

`````

`````{py:class} CookReport
:canonical: simvx.graphics.cook.CookReport

```{autodoc2-docstring} simvx.graphics.cook.CookReport
```

````{py:attribute} source
:canonical: simvx.graphics.cook.CookReport.source
:type: pathlib.Path
:value: >
   None

```{autodoc2-docstring} simvx.graphics.cook.CookReport.source
```

````

````{py:attribute} output
:canonical: simvx.graphics.cook.CookReport.output
:type: pathlib.Path | None
:value: >
   None

```{autodoc2-docstring} simvx.graphics.cook.CookReport.output
```

````

````{py:attribute} action
:canonical: simvx.graphics.cook.CookReport.action
:type: str
:value: >
   None

```{autodoc2-docstring} simvx.graphics.cook.CookReport.action
```

````

````{py:attribute} detail
:canonical: simvx.graphics.cook.CookReport.detail
:type: str
:value: >
   None

```{autodoc2-docstring} simvx.graphics.cook.CookReport.detail
```

````

`````

````{py:function} full_mip_count(width: int, height: int) -> int
:canonical: simvx.graphics.cook.full_mip_count

```{autodoc2-docstring} simvx.graphics.cook.full_mip_count
```
````

````{py:function} write_ktx2(vk_format: int, width: int, height: int, mips: list[bytes], *, block_size: int = 16) -> bytes
:canonical: simvx.graphics.cook.write_ktx2

```{autodoc2-docstring} simvx.graphics.cook.write_ktx2
```
````

````{py:function} cook_ktx2_bytes(data: bytes, *, target: str = 'bc7') -> tuple[bytes, str, str]
:canonical: simvx.graphics.cook.cook_ktx2_bytes

```{autodoc2-docstring} simvx.graphics.cook.cook_ktx2_bytes
```
````

````{py:function} cook_file(src: pathlib.Path, out_dir: pathlib.Path, *, target: str = 'bc7', transcode: bool = True) -> list[simvx.graphics.cook.CookReport]
:canonical: simvx.graphics.cook.cook_file

```{autodoc2-docstring} simvx.graphics.cook.cook_file
```
````