# Globe

A spinning, lit globe dithered from a land mask.

## Installation

```sh
pnpm add astro-dither
```

Or copy the source into your project:

```sh
npx astro-dither add effect
```

## Usage

```astro
---
import { DitherGlobe } from "astro-dither";
---

<DitherGlobe />
```

The bundled land mask sampled onto a lit sphere that turns west to east. `lat` and `lon` set where the view starts, `sea` sets how much of the ocean shows, and `speed: 0` holds it still.

The props group like this:

Placement: `lat`, `lon`. Look: `sea`.

## Examples

### Pacific

Rotate the view to centre the ocean.

```astro
<DitherEffect effect="globe" params={{"lat":0,"lon":-140}} />
```

### Brand blue

Swap the palette for inked land on transparent water.

```astro
<DitherEffect effect="globe" palette={["transparent","#00b2ff","#d6efff"]} />
```

## Props

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `lat` | `number` | 20 | Latitude facing the viewer, degrees. -90 to 90. |
| `lon` | `number` | 48 | Longitude facing the viewer when the spin starts, degrees. -180 to 180. |
| `sea` | `number` | 0.12 | Tone of the sea. 0 leaves it clear so only land shows. 0 to 0.5. |
| `palette` | `string[]` | the effect's | 2 to 8 colours, paper first, brightest last. `transparent` works. |
| `cell` | `number` | 2 | Size of one dither cell in CSS pixels. Rounded to whole device pixels so cells stay even. |
| `matrix` | `2 | 4 | 8 | "noise"` | 8 | The Bayer threshold size, or noise for a random look. |
| `speed` | `number` | 1 | Playback speed. 0 draws one still frame. |
| `stillTime` | `number` | the effect's | The moment drawn when motion is off or reduced, in seconds. |
| `levels` | `number` | 0 (all) | Tones the field snaps to before dithering. Low values give hard, posterised steps. |
| `bloom` | `number` | 0 | Bloom around lit cells, 0 to 1. Set a positive prop to create the overlay before overriding it with CSS `--dither-bloom`. |
| `bloomRadius` | `number` | 10 | Bloom blur in CSS pixels. CSS `--dither-bloom-radius` overrides it. |
| `class` | `string` | undefined | Classes on the surface element, for size and position. |

## Notes

* Decorative and `aria-hidden`. Put real text on top, not inside it.
* With reduced motion it draws one still frame (at 0s) and stops.
* It pauses when scrolled out of view or when the tab is hidden.
* Shares one WebGL context with every other ordered effect on the page.