# {py:mod}`simvx.graphics.renderer.shadow_data`

```{py:module} simvx.graphics.renderer.shadow_data
```

```{autodoc2-docstring} simvx.graphics.renderer.shadow_data
:allowtitles:
```

## Module Contents

### Functions

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

* - {py:obj}`field_offset <simvx.graphics.renderer.shadow_data.field_offset>`
  - ```{autodoc2-docstring} simvx.graphics.renderer.shadow_data.field_offset
    :summary:
    ```
* - {py:obj}`caster_field <simvx.graphics.renderer.shadow_data.caster_field>`
  - ```{autodoc2-docstring} simvx.graphics.renderer.shadow_data.caster_field
    :summary:
    ```
* - {py:obj}`write_uint <simvx.graphics.renderer.shadow_data.write_uint>`
  - ```{autodoc2-docstring} simvx.graphics.renderer.shadow_data.write_uint
    :summary:
    ```
* - {py:obj}`write_vec4 <simvx.graphics.renderer.shadow_data.write_vec4>`
  - ```{autodoc2-docstring} simvx.graphics.renderer.shadow_data.write_vec4
    :summary:
    ```
* - {py:obj}`write_mat4 <simvx.graphics.renderer.shadow_data.write_mat4>`
  - ```{autodoc2-docstring} simvx.graphics.renderer.shadow_data.write_mat4
    :summary:
    ```
* - {py:obj}`zeroed <simvx.graphics.renderer.shadow_data.zeroed>`
  - ```{autodoc2-docstring} simvx.graphics.renderer.shadow_data.zeroed
    :summary:
    ```
* - {py:obj}`write_ambient <simvx.graphics.renderer.shadow_data.write_ambient>`
  - ```{autodoc2-docstring} simvx.graphics.renderer.shadow_data.write_ambient
    :summary:
    ```
* - {py:obj}`defaults <simvx.graphics.renderer.shadow_data.defaults>`
  - ```{autodoc2-docstring} simvx.graphics.renderer.shadow_data.defaults
    :summary:
    ```
````

### Data

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

* - {py:obj}`__all__ <simvx.graphics.renderer.shadow_data.__all__>`
  - ```{autodoc2-docstring} simvx.graphics.renderer.shadow_data.__all__
    :summary:
    ```
* - {py:obj}`SHADOW_DATA_BINDING <simvx.graphics.renderer.shadow_data.SHADOW_DATA_BINDING>`
  - ```{autodoc2-docstring} simvx.graphics.renderer.shadow_data.SHADOW_DATA_BINDING
    :summary:
    ```
* - {py:obj}`CASCADE_COUNT <simvx.graphics.renderer.shadow_data.CASCADE_COUNT>`
  - ```{autodoc2-docstring} simvx.graphics.renderer.shadow_data.CASCADE_COUNT
    :summary:
    ```
* - {py:obj}`MAX_SHADOW_CASTERS <simvx.graphics.renderer.shadow_data.MAX_SHADOW_CASTERS>`
  - ```{autodoc2-docstring} simvx.graphics.renderer.shadow_data.MAX_SHADOW_CASTERS
    :summary:
    ```
* - {py:obj}`DEFAULT_SHADOW_CASTER_COUNT <simvx.graphics.renderer.shadow_data.DEFAULT_SHADOW_CASTER_COUNT>`
  - ```{autodoc2-docstring} simvx.graphics.renderer.shadow_data.DEFAULT_SHADOW_CASTER_COUNT
    :summary:
    ```
* - {py:obj}`NO_SHADOW_TEXTURE <simvx.graphics.renderer.shadow_data.NO_SHADOW_TEXTURE>`
  - ```{autodoc2-docstring} simvx.graphics.renderer.shadow_data.NO_SHADOW_TEXTURE
    :summary:
    ```
* - {py:obj}`DEFAULT_AMBIENT_COLOUR <simvx.graphics.renderer.shadow_data.DEFAULT_AMBIENT_COLOUR>`
  - ```{autodoc2-docstring} simvx.graphics.renderer.shadow_data.DEFAULT_AMBIENT_COLOUR
    :summary:
    ```
* - {py:obj}`SHADOW_DATA_GLSL <simvx.graphics.renderer.shadow_data.SHADOW_DATA_GLSL>`
  - ```{autodoc2-docstring} simvx.graphics.renderer.shadow_data.SHADOW_DATA_GLSL
    :summary:
    ```
* - {py:obj}`SHADOW_DATA_FIELD_OFFSETS <simvx.graphics.renderer.shadow_data.SHADOW_DATA_FIELD_OFFSETS>`
  - ```{autodoc2-docstring} simvx.graphics.renderer.shadow_data.SHADOW_DATA_FIELD_OFFSETS
    :summary:
    ```
````

### API

````{py:data} __all__
:canonical: simvx.graphics.renderer.shadow_data.__all__
:value: >
   ['CASCADE_COUNT', 'DEFAULT_AMBIENT_COLOUR', 'DEFAULT_SHADOW_CASTER_COUNT', 'MAX_SHADOW_CASTERS', 'NO...

```{autodoc2-docstring} simvx.graphics.renderer.shadow_data.__all__
```

````

````{py:data} SHADOW_DATA_BINDING
:canonical: simvx.graphics.renderer.shadow_data.SHADOW_DATA_BINDING
:value: >
   3

```{autodoc2-docstring} simvx.graphics.renderer.shadow_data.SHADOW_DATA_BINDING
```

````

````{py:data} CASCADE_COUNT
:canonical: simvx.graphics.renderer.shadow_data.CASCADE_COUNT
:value: >
   None

```{autodoc2-docstring} simvx.graphics.renderer.shadow_data.CASCADE_COUNT
```

````

````{py:data} MAX_SHADOW_CASTERS
:canonical: simvx.graphics.renderer.shadow_data.MAX_SHADOW_CASTERS
:value: >
   8

```{autodoc2-docstring} simvx.graphics.renderer.shadow_data.MAX_SHADOW_CASTERS
```

````

````{py:data} DEFAULT_SHADOW_CASTER_COUNT
:canonical: simvx.graphics.renderer.shadow_data.DEFAULT_SHADOW_CASTER_COUNT
:value: >
   1

```{autodoc2-docstring} simvx.graphics.renderer.shadow_data.DEFAULT_SHADOW_CASTER_COUNT
```

````

````{py:data} NO_SHADOW_TEXTURE
:canonical: simvx.graphics.renderer.shadow_data.NO_SHADOW_TEXTURE
:value: >
   4294967295

```{autodoc2-docstring} simvx.graphics.renderer.shadow_data.NO_SHADOW_TEXTURE
```

````

````{py:data} DEFAULT_AMBIENT_COLOUR
:canonical: simvx.graphics.renderer.shadow_data.DEFAULT_AMBIENT_COLOUR
:value: >
   (0.15, 0.15, 0.2, 1.0)

```{autodoc2-docstring} simvx.graphics.renderer.shadow_data.DEFAULT_AMBIENT_COLOUR
```

````

````{py:data} SHADOW_DATA_GLSL
:canonical: simvx.graphics.renderer.shadow_data.SHADOW_DATA_GLSL
:value: >
   None

```{autodoc2-docstring} simvx.graphics.renderer.shadow_data.SHADOW_DATA_GLSL
```

````

````{py:data} SHADOW_DATA_FIELD_OFFSETS
:canonical: simvx.graphics.renderer.shadow_data.SHADOW_DATA_FIELD_OFFSETS
:type: dict[str, int]
:value: >
   None

```{autodoc2-docstring} simvx.graphics.renderer.shadow_data.SHADOW_DATA_FIELD_OFFSETS
```

````

````{py:function} field_offset(field: str, index: int = 0) -> int
:canonical: simvx.graphics.renderer.shadow_data.field_offset

```{autodoc2-docstring} simvx.graphics.renderer.shadow_data.field_offset
```
````

````{py:function} caster_field(base: str, slot: int) -> tuple[str, int]
:canonical: simvx.graphics.renderer.shadow_data.caster_field

```{autodoc2-docstring} simvx.graphics.renderer.shadow_data.caster_field
```
````

````{py:function} write_uint(block: numpy.ndarray, field: str, value: int, index: int = 0) -> None
:canonical: simvx.graphics.renderer.shadow_data.write_uint

```{autodoc2-docstring} simvx.graphics.renderer.shadow_data.write_uint
```
````

````{py:function} write_vec4(block: numpy.ndarray, field: str, values: object, index: int = 0) -> None
:canonical: simvx.graphics.renderer.shadow_data.write_vec4

```{autodoc2-docstring} simvx.graphics.renderer.shadow_data.write_vec4
```
````

````{py:function} write_mat4(block: numpy.ndarray, field: str, matrix: object, index: int = 0) -> None
:canonical: simvx.graphics.renderer.shadow_data.write_mat4

```{autodoc2-docstring} simvx.graphics.renderer.shadow_data.write_mat4
```
````

````{py:function} zeroed() -> numpy.ndarray
:canonical: simvx.graphics.renderer.shadow_data.zeroed

```{autodoc2-docstring} simvx.graphics.renderer.shadow_data.zeroed
```
````

````{py:function} write_ambient(block: numpy.ndarray, colour: tuple[float, float, float], energy: float) -> None
:canonical: simvx.graphics.renderer.shadow_data.write_ambient

```{autodoc2-docstring} simvx.graphics.renderer.shadow_data.write_ambient
```
````

````{py:function} defaults() -> numpy.ndarray
:canonical: simvx.graphics.renderer.shadow_data.defaults

```{autodoc2-docstring} simvx.graphics.renderer.shadow_data.defaults
```
````