# ORB-08

mother-of-pearl contour bands, each layer its own hue

> For the complete documentation index, see [llms.txt](/llms.txt). Markdown variants are available by appending `.md` to any URL or sending an `Accept: text/markdown` header. An agent skill is available at [/.well-known/agent-skills/site-skill.md](/.well-known/agent-skills/site-skill.md).



<OrbPreview slug="orb-08" />

## Installation [#installation]

<CodeTabs>
  <TabsList>
    <TabsTrigger value="cli">
      Command
    </TabsTrigger>

    <TabsTrigger value="manual">
      Manual
    </TabsTrigger>
  </TabsList>

  <TabsContent value="cli">
    ```bash
    npx shadcn@latest add https://shadercn.vercel.app/r/orb-08.json
    ```
  </TabsContent>

  <TabsContent value="manual">
    <Steps>
      <Step>
        Install the following dependencies:
      </Step>

      ```bash
      pnpm add vgpu
      ```

      <Step>
        Copy and paste the following code into your project.
      </Step>

      <ComponentSource src="components/orbs/orb-08.tsx" base="shadercn" title="components/orbs/orb-08.tsx" />

      <ComponentSource src="components/orbs/orbkit-core-wgpu.tsx" base="shadercn" title="components/orbs/orbkit-core-wgpu.tsx" />

      <ComponentSource src="components/orbs/orbkit-renderer.ts" base="shadercn" title="components/orbs/orbkit-renderer.ts" />

      <Step>
        Update the import paths to match your project setup.
      </Step>
    </Steps>
  </TabsContent>
</CodeTabs>

## Usage [#usage]

```tsx
import { Orb08 } from "@/components/orbs/orb-08";
```

```tsx
<Orb08 size={280} state="idle" />
```

## Props [#props]

### Component Props [#component-props]

| Prop             | Type                                                             | Default  | Description                                  |
| ---------------- | ---------------------------------------------------------------- | -------- | -------------------------------------------- |
| `state`          | `"idle" \| "thinking" \| "speaking"`                             | `"idle"` | Drive preset the orb eases toward            |
| `size`           | `number`                                                         | `280`    | Rendered size in CSS pixels                  |
| `params`         | `Partial<Record<string, number>>`                                | -        | Shader param overrides, see Shader Props     |
| `colors`         | `Partial<Record<string, string>>`                                | -        | Shader colour overrides as hex strings       |
| `statePresets`   | `Partial<Record<OrbState, Record<string, number>>>`              | -        | Replace the built-in per-state param presets |
| `stateColors`    | `Partial<Record<OrbState, Record<string, string>>>`              | -        | Replace the built-in per-state colours       |
| `stateVolumes`   | `Partial<Record<OrbState, { input?: number; output?: number }>>` | -        | Pin the drive volumes a state settles on     |
| `volumes`        | `{ input?: number; output?: number }`                            | -        | Drive the orb directly, bypassing synthesis  |
| `paused`         | `boolean`                                                        | `false`  | Freeze the frame loop                        |
| `pauseOffscreen` | `boolean`                                                        | `true`   | Stop rendering while scrolled out of view    |
| `maxDpr`         | `number`                                                         | `2`      | Upper bound on the device pixel ratio        |
| `className`      | `string`                                                         | -        | Class on the wrapper element                 |
| `style`          | `CSSProperties`                                                  | -        | Inline style on the wrapper element          |
| `ariaLabel`      | `string`                                                         | -        | Accessible name for the canvas               |

### Shader Props [#shader-props]

Pass any of these through `params`; each is a single `f32` uniform read by the shader.

| Param       | Label             | Range          | Step    | Default |
| ----------- | ----------------- | -------------- | ------- | ------- |
| `speed`     | Boil              | `0.015` – `10` | `0.05`  | `0.35`  |
| `flow`      | Band drift        | `0` – `5`      | `0.03`  | `0.25`  |
| `swirl`     | Swirl             | `0` – `3`      | `0.015` | `0.06`  |
| `radius`    | Radius            | `0.15` – `3`   | `0.015` | `0.9`   |
| `scale`     | Pattern scale     | `0.3` – `20`   | `0.1`   | `5.5`   |
| `bulge`     | Dome bulge        | `0` – `4`      | `0.02`  | `0.3`   |
| `warp`      | Warp              | `0` – `3`      | `0.02`  | `1`     |
| `beat`      | Warp beat         | `0` – `1`      | `0.01`  | `0`     |
| `thick`     | Band width        | `0.02` – `2`   | `0.01`  | `0.2`   |
| `split`     | Chromatic split   | `0` – `1`      | `0.005` | `0.1`   |
| `iris`      | Iridescence       | `0` – `2`      | `0.01`  | `0.7`   |
| `irisScale` | Iridescence scale | `0` – `2`      | `0.005` | `0.315` |
| `view`      | Angle shift       | `0` – `3`      | `0.01`  | `1.34`  |
| `floor`     | Body fill         | `0` – `3`      | `0.01`  | `0.8`   |
| `gain`      | Brightness        | `0.05` – `5`   | `0.05`  | `1.1`   |
| `contrast`  | Contrast          | `0.15` – `10`  | `0.05`  | `1.15`  |
| `light`     | Key light         | `0` – `3`      | `0.015` | `0.75`  |
| `rim`       | Rim sheen         | `0` – `3`      | `0.015` | `0.5`   |

Colours are passed through `colors` as hex strings.

| Colour  | Label        | Default   |
| ------- | ------------ | --------- |
| `deep`  | Shell body   | `#0d1430` |
| `low`   | Dim layer    | `#2fb8c6` |
| `crest` | Bright layer | `#fff1de` |
| `sheen` | Sheen        | `#bfe4ff` |

## Credits [#credits]

Shader by [XorDev](https://x.com/XorDev), ported from [orbkit](https://github.com/zzzzshawn/orbkit) (WebGL/GLSL) to WebGPU/WGSL.