Matrix Engine Api Documentation - v2.0.0
    Preparing search index...

    Class AudioSplatFieldEffect

    Index

    Constructors

    Properties

    _attachedLayer: any
    _basePos: Float32Array<any>
    _colorCPU: Float32Array<ArrayBuffer>
    _delay: Float32Array<ArrayBuffer>
    _dir: Float32Array<ArrayBuffer>
    _frameCount: number
    _frameSkip: number
    _histHigh: Float32Array<ArrayBuffer>
    _histLen: number
    _histLow: Float32Array<ArrayBuffer>
    _histMid: Float32Array<ArrayBuffer>
    _histWrite: number
    _phase: Float32Array<ArrayBuffer>
    _posCPU: Float32Array<ArrayBuffer>
    _ribbonHistSlot: Float32Array<ArrayBuffer>
    _scatterEnergy: Float32Array<ArrayBuffer>
    _shell: Uint8Array<ArrayBuffer>
    bindGroup: any
    bindGroupLayout: any
    cameraBuffer: any
    colorBuffer: any
    device: any
    format: any
    mode: any
    modelBuffer: any
    pipeline: any
    pipelineLayout: any
    pointCount: number
    posBuffer: any
    reactiveAudio: any
    scale: number
    shaderModule: any
    speed: number
    _pipelineCache: WeakMap<WeakKey, any> = ...

    optional external xyz array (pointCount*3). If omitted, a procedural point set is generated (sphere shells for spectrumShell/beatScatter, resampled into a ribbon for waveformRibbon).

    color target format, required only for standalone render()

    required only for standalone render()

    Methods

    • Tight core at rest; beat launches a wave of points outward, decaying back in.

      Parameters

      • low: any
      • mid: any
      • high: any
      • energy: any
      • beat: any
      • dt: any
      • t: any

      Returns void

    • Three shells breathe independently on their own band. Calm idle default.

      Parameters

      • low: any
      • mid: any
      • high: any
      • t: any

      Returns void

    • Scrolling oscilloscope trace: y = rolling low/mid/high history, x fixed across the ribbon.

      Parameters

      • low: any
      • mid: any
      • high: any
      • t: any

      Returns void

    • Attach to an existing GaussianSplatLayer — writes into its buffers instead of drawing standalone.

      Parameters

      • splatLayer: any

      Returns void

    • Only meaningful if constructed with {format, cameraBuffer} and NOT attached to a splat layer.

      Parameters

      • pass: any
      • mesh: any
      • viewProjMatrix: any

      Returns void

    • Call once per frame with the tuple your Audio Reactive Node already produces.

      Parameters

      • low: number
      • mid: number
      • high: number
      • energy: number
      • beat: boolean
      • dt: number

        seconds since last frame

      • elapsed: number

        total seconds elapsed

      Returns void