glsl-view module reference

glsl-view module reference

glsl-view integration via OSC.

index

• draw (opdef):  – draw a GLSL shader via OSC.
• freeze (opdef):  – freeze a texture source.
• shader (opdef):  – compile a GLSL shader with uniforms.
• step! (opdef):  – step a frozen texture source.
• stream-source (opdef):  – alias of stream
• tsv-source (opdef):  – load a texture-share-vk texture source.
• uniform (opdef):  – override uniform binding type.
• video-source (opdef):  – alias of video

details

• draw (opdef):  – draw a GLSL shader via OSC.

  (draw [socket] shader)

  Syncs code and parameters with glsl-view via OSC.

  • socket must be an osc/out~ or read from *oscout*
  • shader is a struct~ with
    • shader (str): GLSL source
    • uniforms: struct mapping uniform names to values
• freeze (opdef):  – freeze a texture source.

  (freeze [socket] source freeze?)

• shader (opdef):  – compile a GLSL shader with uniforms.

  $shader"code…"

  A template string formatter for glsl-view/draw that returns a shader struct~.

  • code… is a template string that can contain ~-stream template substitutions that are used as follows:
    • str: substituted directly as GLSL
    • another shader struct~: substituted as GLSL, with uniforms lifted
    • {type: str val: …}: reference to uniform of GLSL-type type (instead of inferred as follows)
    • num, bool: reference to uniform float/bool
    • num[I], bool[I]: reference to uniform vecI/bvecI
    • num[I][J]: reference to uniform matIxJ
• step! (opdef):  – step a frozen texture source.

  (step! [socket] source [trig!])

• tsv-source (opdef):  – load a texture-share-vk texture source.

  (tsv-source [socket] name [type])

  Creates a texture source from a texture-share-vk texture.

  • name is a unique name for this texture source.
  • type defaults to 2D.
• uniform (opdef):  – override uniform binding type.

  (uniform glsl-type value)

  Generates a uniform struct as received by glsl-view/shader:

  (uniform 'sampler2D' 'sampler-name') is equivalent to {'type' 'sampler2D' 'val' 'sampler-name'}.