Orbs / ORB-25

ORB-25

the folds of a warped field, drawn by their own steepness

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, orb25 } from "react-native-shader-orbs";
typescript
<ShaderOrb orb={orb25} size={280} state="idle" interactive />

Props

Component props

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

PropTypeDefaultDescription
state"idle" | "thinking" | "speaking""idle"The mood. Eases the parameters toward that preset.
sizenumber280Width and height in points.
paramsRecord<string, number>Parameter overrides by key, clamped to each range. See the shader params below.
colorsRecord<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.
interactivebooleanfalseTap pulses the orb; holding makes it swell.
quality"auto" | "low" | "medium" | "high" | number"auto"Render scale. Lower is cheaper and softer.
maxFpsnumber60Frame cap.
pausedbooleanfalseStops drawing and keeps the last frame.
onReady() => voidCalled once the first frame is on screen.
onError(error: Error) => voidCalled 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.

KeyLabelRangeStepDefault
speedBoil integrated0.015 to 200.053
driftDrift integrated0 to 80.020.6
swirlSwirl integrated0 to 30.0150.05
radiusRadius 0.15 to 30.0150.9
scaleCell scale 0.3 to 600.17.5
bulgeDome bulge 0 to 40.020.3
warpFold 0 to 20.010.4
zoomOctave zoom 0.6 to 20.0051.111
rippleRipple 0.02 to 30.010.3
edgeGainEdge gain 0.5 to 600.510
blurRim width 0.5 to 120.252.5
fringeChromatic fringe 0 to 1.50.0050.09
exposureExposure 0.05 to 400.050.8
contrastContrast 0.15 to 80.051.15
saturationSaturation 0 to 40.021.5
floorLevelBody fill 0 to 20.010.16
lightKey light 0 to 30.0150.35
rimRim sheen 0 to 30.0150.45

Colors

Pass these through colors as hex strings.

KeyLabelDefault
tintRim #dbe8f7
bodyBody #0d1118
sheenSheen #a8c8f0

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-25 in the playground.