API Reference (Generated)

This file is generated by npm run docs:generate from source-of-truth APIs in:

• src/index.d.ts
• src/glsl/glsl-functions.js
• module export files in src/three/*.js, src/gui.js, and src/el.js

Do not edit this file manually.

Surface Summary

• Constructor options: 16
• HydraRenderer members: 10
• HydraSynthApi members: 44
• HydraSceneApi members: 20
• Transform chain members: 8
• Module namespaces: 10
• GLSL transforms: 67

Constructor Options

• pb
• width
• height
• numSources
• numOutputs
• makeGlobal
• autoLoop
• detectAudio
• enableStreamCapture
• webgl
• canvas
• css2DElement
• css3DElement
• precision
• onError
• extendTransforms

HydraRenderer Members

• constructor
• eval
• getScreenImage
• hush
• loadScript
• setResolution
• tick
• shadowMap
• scene
• dispose

HydraSynthApi Members

• time
• bpm
• canvas
• width
• height
• fps
• stats
• speed
• mouse
• update
• afterUpdate
• click
• mousedown
• mouseup
• mousemove
• keydown
• keyup
• onError
• render
• setResolution
• hush
• tick
• shadowMap
• scene
• ortho
• perspective
• screenCoords
• normalizedCoords
• cartesianCoords
• setFunction
• osc
• noise
• solid
• src
• tx
• gm
• mt
• cmp
• rnd
• nse
• gui
• arr
• el
• math

HydraSceneApi Members

• add
• mesh
• quad
• points
• lines
• linestrip
• lineloop
• line
• circle
• ellipse
• triangle
• lights
• world
• group
• layer
• lookAt
• out
• at
• find
• empty

Transform Chain Members

• out
• basic
• phong
• lambert
• material
• st
• tex
• texMat

Module Namespaces

| Namespace | Export Count | Exports | | --------- | -----------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | arr | 17 | create, uint8, float32, noise, random, mirror, mirror1, image, grid, sum, mul, concat, padTo, map, normalize, avg, transpose | | cmp | 7 | size, line, stack, circle, random, noise, lookAt | | el | 2 | create, setAttributes | | gm | 32 | box, capsule, circle, cone, cylinder, dodecahedron, edges, extrude, icosahedron, lathe, octahedron, plane, polyhedron, ring, sphere, tetrahedron, torus, torusKnot, tube, wireframe, points, shape, drawShape, line, rect, ellipse, triangle, grid, text, GridGeometry, posFromEleAzi, signedArea | | gui | 6 | init, create, addFolder, lights, world, hideSaveRow | | math | 6 | lerp, map, constrain, nextPow2, rad, deg | | mt | 19 | basicProps, phongProps, lambertProps, meshBasic, meshPhong, meshLambert, meshStandard, lineBasic, points, worldPosGradientY, hydra, dots, squares, lines, linestrip, lineloop, text, mesh, getBlend | | nse | 14 | types, options, pink, brown, yellow, improved, init, fbm, get2, get3, get4, PINK, BROWN, YELLOW | | rnd | 15 | setfn, num, int, bool, choice, exp, gauss, gaussMinMax, cache, cacheNum, cacheGauss, cacheGaussMinMax, cacheBool, arr, color | | tx | 15 | get, set, data, dataArray, load, save, wrap, repeat, mirror, mirror1, pointsym, atlas, createSceneTexture, createQuadScene, fbo |

Transform Catalog

color

• a
• b
• brightness
• color
• colorama
• contrast
• g
• hue
• invert
• luma
• posterize
• r
• saturate
• shift
• sum
• thresh

combine

• add
• blend
• diff
• layer
• mask
• mult
• sub

combineCoord

• modulate
• modulateHue
• modulateKaleid
• modulatePixelate
• modulateRepeat
• modulateRepeatX
• modulateRepeatY
• modulateRotate
• modulateScale
• modulateScrollX
• modulateScrollY

coord

• kaleid
• pixelate
• repeat
• repeatX
• repeatY
• rotate
• scale
• scroll
• scrollX
• scrollY

genType

• atan
• cos
• map
• pow
• sin
• tan

glsl

• glsl

src

• cnoise
• fbm
• gradient
• hex
• noise
• osc
• pnoise
• prev
• shape
• snoise
• solid
• solid2
• solid3
• src
• voronoi
• wnoise