Sphera — Documentation

[{"_1":2,"_3":-5,"_4":-5},"loaderData",{"_5":6,"_7":8,"_9":10},"actionData","errors","root",{"_165":166,"_167":168},"routes/_app.x.$handle.$name",{"_95":94,"_33":46,"_103":85,"_28":37,"_13":14,"_104":-5,"_11":105,"_106":107,"_108":109,"_110":111,"_112":113,"_20":-5,"_114":-5,"_115":-5,"_116":27,"_117":118,"_119":25,"_120":-5,"_121":-5,"_122":123},"routes/_app.x.$handle.$name.branch.$branch.version.$version.diff",{"_11":12,"_13":14,"_15":16,"_17":-5,"_18":-5},"project",{"_44":45,"_33":46,"_39":47,"_48":-5,"_49":27,"_50":51,"_52":51,"_53":-5,"_54":-5,"_18":55,"_56":-5,"_57":27,"_58":-5,"_59":-5,"_60":61,"_62":63,"_64":-5,"_65":-5,"_66":-5,"_67":-5,"_68":69,"_70":69,"_71":72,"_73":72,"_74":72,"_75":69,"_76":69,"_77":78,"_79":80,"_81":82,"_83":27},"version",25,"changes",[19],"aiChatInfo","userId",{"_20":21,"_22":23,"_24":25,"_26":27,"_28":29,"_30":29},"file",{"_31":32,"_33":29,"_34":35,"_36":38,"_39":40,"_41":14,"_42":43,"_24":27},"previous",{"_31":32,"_33":29,"_34":35,"_36":37},"deleted",true,"deletedHere",false,"path","new-file-5032.ts","latestPath","fileId","421521da-2ec2-11f1-b00b-42dde27851f2","name","fileType","http","content","","export default async function handler(req: Request): Promise {\n const html = `\n\n\n\n\nSphera — Documentation\n\n\n\n\n\n\n\n\n

navigate mode — drag to rotate · press B to draw

\n\n \n

\n \n brush\n

\n\n \n

\n \n\n

colour

\n custom\n \n

\n\n

thickness

\n thin\n 3px\n thick\n

\n \n

\n\n

\n scroll for docs\n

\n \n

\n\n

\n start\n \n \n \n features\n \n \n \n api\n \n \n \n more\n \n \n

\n\n

Draw anywhere on a sphere

Sphera is an interactive 3D canvas. Rotate freely, zoom in, and paint directly on the sphere surface — strokes follow the curvature in real time.

Drag to rotate — two-finger swipe to rotate on trackpad — pinch to zoom — press B to toggle draw mode.

\n\n

Quickstart

import { Sphere } from 'sphera';\nconst sphere = new Sphere(canvas, {\n  radius: 1.0, showGrid: true,\n});\nsphere.mount();\nsphere.useTool('brush', { color: '#ff9057', size: 4 });

Install via npm install sphera or drop the CDN script. Mount on any <canvas> element.

\n\n

Core concepts

Every point on the surface is described by θ (longitude, −180°…180°) and φ (latitude, −90°…90°). Clicks cast a ray from the camera and intersect the sphere — strokes are sequences of geodesic segments, the shortest paths between sample points on the surface.

All drawing composites into a 4096×2048 equirectangular texture atlas; only dirty regions are re-uploaded to the GPU.

\n\n \n\n

Drawing tools

Brush BFreehand, anti-aliased, pressure-sensitive with stylus

Eraser EMasks strokes at composite level; non-destructive

Fill FFlood-fill closed regions on the sphere surface

Stamp SCircles, rects, arrows — warped to sphere surface

Text TRaster labels, editable by double-click — new in v1.4

\n\n

Layers

const layer = sphere.layers.add({\n  name: 'annotations', opacity: 0.8,\n  blendMode: 'multiply',\n});\nsphere.layers.setActive(layer.id);

Blend modes: normal multiply screen overlay darken lighten. Flatten layers with sphere.layers.flatten([id1, id2]) for performance.

\n\n

Sphere — constructor options

radiusnumberWorld-unit radius. Default 1.0

backgroundstringCanvas background colour

showGridbooleanLat/lon overlay. Default false

zoomMaxnumberMax zoom multiplier. Default 50

textureSizenumberAtlas width px, power of two. Default 4096

antialiasbooleanMSAA. Default true

\n\n

Brush — properties

colorstringCSS colour. Read/write.

sizenumberWidth in equator px at 1× zoom. Range 0.5–200.

opacitynumber0–1. Composited with layer opacity.

smoothingnumber0–1. Higher = smoother but laggier.

isDrawingbooleanRead-only. True while stroke is in progress.

\n\n

Events

readyWebGL context initialised

stroke:start{ point, layerId }

stroke:endFull Stroke object — id, points, style, bounds, timestamp

rotate{ theta, phi } — throttled to 60 fps

zoom{ level }

errorInternal error — always handle this

\n\n

Export & share

PNGsphere.toDataURL('png') — equirectangular atlas

OBJsphere.exportOBJ({ segments: 128 }) — mesh + texture

JSONsphere.toJSON() / sphere.fromJSON(data) — full vector state

Use JSON for save/load, PNG for sharing with external tools like Blender or Photoshop.

\n\n

Keyboard shortcuts

Brush / Eraser / Fill / Stamp / TextB E F S T

Brush size up / down] [

Undo / RedoCtrl+Z Ctrl+Shift+Z

Reset viewHome

Toggle gridG

Temp navigate while drawingAlt hold

Straight line snapShift hold

\n\n

\n\n\n\n`;\n\n return new Response(html, {\n headers: { \"Content-Type\": \"text/html; charset=utf-8\" },\n });\n}","createdAt",["D",1775154733970],"branchVersion","branchId","44dfdd40-2523-11f1-8829-42dde27851f2","id","44de8468-2523-11f1-8829-42dde27851f2","sphera-project",["D",1774096883470],"deletedAt","legacyEnvVars","privacy","public","httpPrivacy","description","imageUrl","019c1c74-7b88-71cc-8562-fbd34a3494d5","pinnedFileId","pinPreview","pinMigrated","screenshotVersion","likeCount",0,"orgId","019c1c74-7b88-71cc-8562-fcd1274ee4eb","tursoName","tursoHostname","tursoMeasuredAt","pinned","userPerm","r","valPerm","blobPerm","rw","emailPerm","sqlitePerm","projectPerm","telemetryPerm","user",{"_95":94,"_102":98},"org",{"_95":94,"_96":-5,"_97":98,"_18":55,"_99":100,"_101":27},"branch",{"_13":84,"_33":85,"_44":43,"_86":45,"_87":-5,"_88":-5,"_89":-5,"_90":-5,"_91":-5,"_92":46,"_93":94},"isOwned",32,"main","projectId","forkedBranchId","forkedBranchVersion","forkedProjectPrivacy","forkedProjectId","forkedProjectOrgId","projectName","userHandle","williamjaesunkang","handle","displayName","avatar","https://imagedelivery.net/iHX6Ovru0O7AjmyT5yZRoA/3b63dd6d-c869-4d45-4ab3-174597d14500/square512?exp=1789592399&sig=4806e7a12551e8f02fe086ca3dd0f0753db0787e01967c54d45aa22c07a4fa45","tier","free","canRestrictVals","profileImageUrl","branchName","adoptOrgId",{"_44":45,"_33":46,"_39":161,"_48":-5,"_49":27,"_50":51,"_52":51,"_53":-5,"_54":-5,"_18":55,"_56":-5,"_57":27,"_58":-5,"_59":-5,"_60":61,"_62":63,"_64":-5,"_65":-5,"_66":-5,"_67":-5,"_68":69,"_70":69,"_71":72,"_73":72,"_74":72,"_75":69,"_76":69,"_77":162,"_79":163,"_81":164,"_83":27},"tree",[152,153],"files",[152,153],"counts",{"_141":61,"_142":143,"_144":61,"_145":146,"_147":148},"contents",[124,125],"upstreamProject","upstreamBranch","emptyEnvVars","flags",[],"hasHttpFiles","grants","orgs","customDomains",{},{"_44":137,"_33":29,"_31":32,"_129":-5,"_42":43,"_41":14,"_131":27,"_39":138,"_13":139,"_34":35,"_36":38,"_24":27,"_135":-5,"_28":140},{"_44":126,"_33":127,"_31":128,"_129":-5,"_42":43,"_41":130,"_131":27,"_39":132,"_13":133,"_34":35,"_36":134,"_24":27,"_135":-5,"_28":136},"de8f2440-2e16-11f1-83a2-42dde27851f2","sphera.ts","46bebfbe-2e0b-11f1-8474-42dde27851f2","parentId",22,"latest",["D",1775081118303],13,"export default async function handler(req: Request): Promise {\n const html = `\n \n\n\n\n\n\n\nSphera — Documentation\n\n\n\n\n\n\n\n\n

navigate mode — drag to rotate · press B to draw

\n\n \n

\n \n brush\n

\n\n \n

\n \n\n

colour

\n custom\n \n

\n\n

thickness

\n thin\n 3px\n thick\n

\n \n

\n\n

\n scroll for docs\n

\n \n

\n\n

\n start\n \n \n \n features\n \n \n \n api\n \n \n \n more\n \n \n

\n\n

Draw anywhere on a sphere

Sphera is an interactive 3D canvas. Rotate freely, zoom in, and paint directly on the sphere surface — strokes follow the curvature in real time.

Drag to rotate — two-finger swipe to rotate on trackpad — pinch to zoom — press B to toggle draw mode.

\n\n

Quickstart

import { Sphere } from 'sphera';\nconst sphere = new Sphere(canvas, {\n  radius: 1.0, showGrid: true,\n});\nsphere.mount();\nsphere.useTool('brush', { color: '#ff9057', size: 4 });

Install via npm install sphera or drop the CDN script. Mount on any <canvas> element.

\n\n

Core concepts

All drawing composites into a 4096×2048 equirectangular texture atlas; only dirty regions are re-uploaded to the GPU.

\n\n \n\n

Drawing tools

Brush BFreehand, anti-aliased, pressure-sensitive with stylus

Eraser EMasks strokes at composite level; non-destructive

Fill FFlood-fill closed regions on the sphere surface

Stamp SCircles, rects, arrows — warped to sphere surface

Text TRaster labels, editable by double-click — new in v1.4

\n\n

Layers

const layer = sphere.layers.add({\n  name: 'annotations', opacity: 0.8,\n  blendMode: 'multiply',\n});\nsphere.layers.setActive(layer.id);

Blend modes: normal multiply screen overlay darken lighten. Flatten layers with sphere.layers.flatten([id1, id2]) for performance.

\n\n

Sphere — constructor options

radiusnumberWorld-unit radius. Default 1.0

backgroundstringCanvas background colour

showGridbooleanLat/lon overlay. Default false

zoomMaxnumberMax zoom multiplier. Default 50

textureSizenumberAtlas width px, power of two. Default 4096

antialiasbooleanMSAA. Default true

\n\n

Brush — properties

colorstringCSS colour. Read/write.

sizenumberWidth in equator px at 1× zoom. Range 0.5–200.

opacitynumber0–1. Composited with layer opacity.

smoothingnumber0–1. Higher = smoother but laggier.

isDrawingbooleanRead-only. True while stroke is in progress.

\n\n

Events

readyWebGL context initialised

stroke:start{ point, layerId }

stroke:endFull Stroke object — id, points, style, bounds, timestamp

rotate{ theta, phi } — throttled to 60 fps

zoom{ level }

errorInternal error — always handle this

\n\n

Export & share

PNGsphere.toDataURL('png') — equirectangular atlas

OBJsphere.exportOBJ({ segments: 128 }) — mesh + texture

JSONsphere.toJSON() / sphere.fromJSON(data) — full vector state

Use JSON for save/load, PNG for sharing with external tools like Blender or Photoshop.

\n\n

Keyboard shortcuts

Brush / Eraser / Fill / Stamp / TextB E F S T

Brush size up / down] [

Undo / RedoCtrl+Z Ctrl+Shift+Z

Reset viewHome

Toggle gridG

Temp navigate while drawingAlt hold

Straight line snapShift hold

\n\n

\n\n\n\n`;\n\n return new Response(html, {\n headers: { \"Content-Type\": \"text/html; charset=utf-8\" },\n });\n}","label",[127],"44e8c376-2ec2-11f1-bf4e-42dde27851f2",["D",1775154733970],2,[29],"pulls","branches",1,"forks","envVars",{"_149":61,"_151":61},"connections",{"_149":61,"_150":61},"count","unfilledCount","emptyCount",{"_44":137,"_33":29,"_31":32,"_129":-5,"_42":43,"_41":14,"_131":27,"_39":158,"_13":139,"_34":35,"_36":38,"_24":27,"_135":-5,"_155":159,"_28":160},{"_44":126,"_33":127,"_31":128,"_129":-5,"_42":43,"_41":130,"_131":27,"_39":154,"_13":133,"_34":35,"_36":134,"_24":27,"_135":-5,"_155":156,"_28":157},["D",1775081118303],"children",[],[127],["D",1775154733970],[],[29],["D",1774096883470],{"_95":94,"_102":98},{"_95":94,"_96":-5,"_97":98,"_18":55,"_99":100,"_101":27},{"_13":84,"_33":85,"_44":43,"_86":45,"_87":-5,"_88":-5,"_89":-5,"_90":-5,"_91":-5,"_92":46,"_93":94},"ctx",{"_77":-5,"_121":198,"_199":200,"_201":202,"_203":27,"_204":27,"_205":27,"_206":25,"_207":-5,"_208":-7,"_209":-7,"_210":61,"_211":27,"_212":27,"_213":-5,"_214":27,"_215":27,"_216":27,"_217":-5},"ENV",{"_169":170,"_171":172,"_173":85,"_174":175,"_176":177,"_178":179,"_180":181,"_182":183,"_184":185,"_186":187,"_188":189,"_190":191,"_192":193,"_194":195,"_196":197},"REACT_APP_SENTRY_DSN","https://586020d86f05489db63a554690acf1e9@o1398359.ingest.sentry.io/6724499","RENDER_GIT_COMMIT","5015b8df46402d8bba4f485ecc37aec202b0e06b","RENDER_GIT_BRANCH","POSTHOG_API_TOKEN","phc_nmoyuAkStEZuUp69rYlg1DZgrIt19Gx0Y4Hwf8tGgJP","POSTHOG_API_HOST","https://wart.val.town","WEB_API_TEMPLATE","https://{val}.web.val.run","APP_URL","https://www.val.town","MODULE_URL","https://esm.town","VANITY_WEB_API_TEMPLATE","https://{label}.val.run/","DENOLS_URL","https://lsp.val.town","NODE_ENV","production","CLOUDFLARE_TURNSTILE_SITE_KEY","0x4AAAAAACtaIZJH7s9rBMZ6","GOOGLE_CLIENT_ID","875989696899-jtsqkhlbdv5jrlsk8631p7ipjg3c6o62.apps.googleusercontent.com","STRIPE_PUBLISHABLE_KEY","pk_live_51N2zvWEpZTTLipIkVEwXrUG9AT0yeOOEYxszarZT1jpsZV58Ly6wlg3SltZpHN26CUalOBmUSY7adQRQiSkCZz2500qSXNkf8Y","API_URL","https://api.val.town",[],"preferencesKeybindings","default","preferencesTheme","light","preferencesFixers","preferencesCopilot","preferencesSelectionAi","preferencesCloseBrackets","preferencesChatPanelState","preferencesDprint","preferencesDenofmt","notificationCount","flagDenols","isBusinessOrgMember","businessOrgHandle","isBusinessOrgAdmin","isHigherTownieTier","navCollapsed","currentOrgId"]

Diff · v25