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

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

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

## Module Contents

### Classes

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

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

### Functions

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

* - {py:obj}`pack <simvx.graphics.frame_globals.pack>`
  - ```{autodoc2-docstring} simvx.graphics.frame_globals.pack
    :summary:
    ```
* - {py:obj}`zeroed <simvx.graphics.frame_globals.zeroed>`
  - ```{autodoc2-docstring} simvx.graphics.frame_globals.zeroed
    :summary:
    ```
* - {py:obj}`glsl_block <simvx.graphics.frame_globals.glsl_block>`
  - ```{autodoc2-docstring} simvx.graphics.frame_globals.glsl_block
    :summary:
    ```
````

### Data

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

* - {py:obj}`__all__ <simvx.graphics.frame_globals.__all__>`
  - ```{autodoc2-docstring} simvx.graphics.frame_globals.__all__
    :summary:
    ```
* - {py:obj}`FRAME_GLOBALS_SIZE <simvx.graphics.frame_globals.FRAME_GLOBALS_SIZE>`
  - ```{autodoc2-docstring} simvx.graphics.frame_globals.FRAME_GLOBALS_SIZE
    :summary:
    ```
* - {py:obj}`FRAME_GLOBALS_BINDING <simvx.graphics.frame_globals.FRAME_GLOBALS_BINDING>`
  - ```{autodoc2-docstring} simvx.graphics.frame_globals.FRAME_GLOBALS_BINDING
    :summary:
    ```
* - {py:obj}`FRAME_GLOBALS_FIELD_OFFSETS <simvx.graphics.frame_globals.FRAME_GLOBALS_FIELD_OFFSETS>`
  - ```{autodoc2-docstring} simvx.graphics.frame_globals.FRAME_GLOBALS_FIELD_OFFSETS
    :summary:
    ```
* - {py:obj}`FRAME_GLOBALS_GLSL <simvx.graphics.frame_globals.FRAME_GLOBALS_GLSL>`
  - ```{autodoc2-docstring} simvx.graphics.frame_globals.FRAME_GLOBALS_GLSL
    :summary:
    ```
* - {py:obj}`FRAME_GLOBALS_WGSL <simvx.graphics.frame_globals.FRAME_GLOBALS_WGSL>`
  - ```{autodoc2-docstring} simvx.graphics.frame_globals.FRAME_GLOBALS_WGSL
    :summary:
    ```
````

### API

````{py:data} __all__
:canonical: simvx.graphics.frame_globals.__all__
:value: >
   ['FRAME_GLOBALS_SIZE', 'FRAME_GLOBALS_BINDING', 'FRAME_GLOBALS_FIELD_OFFSETS', 'FRAME_GLOBALS_GLSL',...

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

````

````{py:data} FRAME_GLOBALS_SIZE
:canonical: simvx.graphics.frame_globals.FRAME_GLOBALS_SIZE
:value: >
   256

```{autodoc2-docstring} simvx.graphics.frame_globals.FRAME_GLOBALS_SIZE
```

````

````{py:data} FRAME_GLOBALS_BINDING
:canonical: simvx.graphics.frame_globals.FRAME_GLOBALS_BINDING
:value: >
   13

```{autodoc2-docstring} simvx.graphics.frame_globals.FRAME_GLOBALS_BINDING
```

````

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

```{autodoc2-docstring} simvx.graphics.frame_globals.FRAME_GLOBALS_FIELD_OFFSETS
```

````

`````{py:class} FrameGlobalsEnv
:canonical: simvx.graphics.frame_globals.FrameGlobalsEnv

```{autodoc2-docstring} simvx.graphics.frame_globals.FrameGlobalsEnv
```

````{py:attribute} wind_direction
:canonical: simvx.graphics.frame_globals.FrameGlobalsEnv.wind_direction
:type: tuple[float, float]
:value: >
   (1.0, 0.0)

```{autodoc2-docstring} simvx.graphics.frame_globals.FrameGlobalsEnv.wind_direction
```

````

````{py:attribute} wind_strength
:canonical: simvx.graphics.frame_globals.FrameGlobalsEnv.wind_strength
:type: float
:value: >
   0.0

```{autodoc2-docstring} simvx.graphics.frame_globals.FrameGlobalsEnv.wind_strength
```

````

````{py:attribute} wind_gustiness
:canonical: simvx.graphics.frame_globals.FrameGlobalsEnv.wind_gustiness
:type: float
:value: >
   0.0

```{autodoc2-docstring} simvx.graphics.frame_globals.FrameGlobalsEnv.wind_gustiness
```

````

````{py:attribute} wetness
:canonical: simvx.graphics.frame_globals.FrameGlobalsEnv.wetness
:type: float
:value: >
   0.0

```{autodoc2-docstring} simvx.graphics.frame_globals.FrameGlobalsEnv.wetness
```

````

````{py:attribute} rain_intensity
:canonical: simvx.graphics.frame_globals.FrameGlobalsEnv.rain_intensity
:type: float
:value: >
   0.0

```{autodoc2-docstring} simvx.graphics.frame_globals.FrameGlobalsEnv.rain_intensity
```

````

````{py:attribute} ripple_strength
:canonical: simvx.graphics.frame_globals.FrameGlobalsEnv.ripple_strength
:type: float
:value: >
   0.0

```{autodoc2-docstring} simvx.graphics.frame_globals.FrameGlobalsEnv.ripple_strength
```

````

`````

````{py:function} pack(*, time: float, delta: float, frame_index: int, wind_direction: tuple[float, float] = (1.0, 0.0), wind_strength: float = 0.0, wind_gustiness: float = 0.0, wetness: float = 0.0, rain_intensity: float = 0.0, ripple_strength: float = 0.0, internal_w: float = 0.0, internal_h: float = 0.0, render_scale: float = 1.0, output_w: float = 0.0, output_h: float = 0.0) -> numpy.ndarray
:canonical: simvx.graphics.frame_globals.pack

```{autodoc2-docstring} simvx.graphics.frame_globals.pack
```
````

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

```{autodoc2-docstring} simvx.graphics.frame_globals.zeroed
```
````

````{py:function} glsl_block(set_index: int, binding: int, instance: str = 'fg') -> str
:canonical: simvx.graphics.frame_globals.glsl_block

```{autodoc2-docstring} simvx.graphics.frame_globals.glsl_block
```
````

````{py:data} FRAME_GLOBALS_GLSL
:canonical: simvx.graphics.frame_globals.FRAME_GLOBALS_GLSL
:value: >
   'glsl_block(...)'

```{autodoc2-docstring} simvx.graphics.frame_globals.FRAME_GLOBALS_GLSL
```

````

````{py:data} FRAME_GLOBALS_WGSL
:canonical: simvx.graphics.frame_globals.FRAME_GLOBALS_WGSL
:value: >
   None

```{autodoc2-docstring} simvx.graphics.frame_globals.FRAME_GLOBALS_WGSL
```

````