Orbs / ORB-17

ORB-17

a grainy many-coloured storm with band shear and lightning

WebGPU isn't available in this browser

Installation

bash

npx expo install react-native-shader-orbs react-native-webgpu react-native-reanimated react-native-worklets

Usage

typescript

import { ShaderOrb, orb17 } from "react-native-shader-orbs";

typescript

<ShaderOrb orb={orb17} size={280} state="idle" interactive />

Props

Component props

The props you'll use most. The ShaderOrb reference lists all of them.

Prop	Type	Default	Description
`state`	`"idle" \| "thinking" \| "speaking"`	`"idle"`	The mood. Eases the parameters toward that preset.
`size`	`number`	`280`	Width and height in points.
`params`	`Record<string, number>`		Parameter overrides by key, clamped to each range. See the shader params below.
`colors`	`Record<string, string>`		Hex colors by key. See the colors below.
`volumes`	`{ input?: number; output?: number }`		Levels from 0 to 1 that the shader reads as input and output loudness.
`interactive`	`boolean`	`false`	Tap pulses the orb; holding makes it swell.
`quality`	`"auto" \| "low" \| "medium" \| "high" \| number`	`"auto"`	Render scale. Lower is cheaper and softer.
`maxFps`	`number`	`60`	Frame cap.
`paused`	`boolean`	`false`	Stops drawing and keeps the last frame.
`onReady`	`() => void`		Called once the first frame is on screen.
`onError`	`(error: Error) => void`		Called if the orb can't start. Without it the error is logged once.

Shader params

Pass these through params. Values are clamped to the range shown. integrated parameters are phase clocks: the shader accumulates them over time, so the value acts as a rate.

Key	Label	Range	Step	Default
`speed`	Storm speed integrated	0.015 to 10	0.05	0.9
`spin`	Roll integrated	0 to 5	0.03	0.12
`radius`	Radius	0.15 to 3	0.015	0.9
`scale`	Weather scale	0.3 to 12	0.1	2.4
`bands`	Band count	0 to 20	0.1	6
`shear`	Band shear	0 to 5	0.03	1.1
`warp`	Warp	0 to 8	0.05	2.2
`churn`	Churn	0 to 8	0.05	1.4
`gain`	Brightness	0.05 to 5	0.05	1.15
`contrast`	Contrast	0.15 to 10	0.05	1.35
`grain`	Field grain	0 to 2	0.01	0.4
`filmGrain`	Film grain	0 to 2	0.01	0.35
`grainSize`	Grain size	1 to 8	1	2
`rainbow`	Iridescence	0 to 2	0.01	0.65
`flashRate`	Flash rate	0 to 10	0.05	1.6
`flash`	Flash power	0 to 5	0.03	1.2
`light`	Key light	0 to 3	0.015	0.85
`rim`	Rim light	0 to 3	0.015	0.5

Colors

Pass these through colors as hex strings.

Key	Label	Default
`deep`	Deep	`#2a0f4e`
`low`	Low pressure	`#0fd0c3`
`mid`	Mid pressure	`#ff5e9d`
`hot`	High pressure	`#ffd166`
`flash`	Lightning	`#eaf4ff`

Moods

This orb ships presets for idle, speaking, thinking. Choosing a state eases the parameters toward that preset; anything you pass in params still wins.

Credits

Based on original work by XorDev, via shadercn. The shader is licensed for non-commercial use with attribution; see Licensing and credits.

Ported to React Native by @msobkyy.

Want to change something? Open ORB-17 in the playground.