# ORB-05

rainbow rings travelling through a lattice of lenses

> 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-05" />

## 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-05.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-05.tsx" base="shadercn" title="components/orbs/orb-05.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 { Orb05 } from "@/components/orbs/orb-05";
```

```tsx
<Orb05 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 |
| ------------ | -------------- | ---------------- | -------- | ------- |
| `ring`       | Ring speed     | `0` – `8`        | `0.03`   | `0.9`   |
| `swirl`      | Swirl          | `0` – `3`        | `0.015`  | `0.05`  |
| `slide`      | Lattice slide  | `0` – `4`        | `0.02`   | `0.12`  |
| `radius`     | Radius         | `0.15` – `3`     | `0.015`  | `0.9`   |
| `scale`      | Lattice scale  | `0.3` – `20`     | `0.1`    | `5`     |
| `bulge`      | Dome bulge     | `0` – `4`        | `0.02`   | `0.3`   |
| `lens`       | Lens strength  | `0` – `4`        | `0.02`   | `1`     |
| `poleSoft`   | Wall softness  | `0.0008` – `0.5` | `0.0008` | `0.02`  |
| `freq`       | Ring frequency | `0.05` – `8`     | `0.05`   | `1`     |
| `spread`     | Colour split   | `0` – `4`        | `0.02`   | `1`     |
| `gain`       | Brightness     | `0.05` – `4`     | `0.02`   | `1.1`   |
| `contrast`   | Contrast       | `0.15` – `6`     | `0.05`   | `1`     |
| `saturation` | Saturation     | `0` – `4`        | `0.02`   | `1.15`  |
| `floorLevel` | Body fill      | `0` – `2`        | `0.01`   | `0.12`  |
| `light`      | Key light      | `0` – `3`        | `0.015`  | `0.4`   |
| `rim`        | Rim sheen      | `0` – `3`        | `0.015`  | `0.45`  |

Colours are passed through `colors` as hex strings.

| Colour  | Label | Default   |
| ------- | ----- | --------- |
| `tint`  | Tint  | `#ffffff` |
| `body`  | Body  | `#141a30` |
| `sheen` | Sheen | `#bcd8ff` |

## Credits [#credits]

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