glsl-view module reference

glsl-view module reference

glsl-view integration via OSC.

index

• buffered-stream-source (opdef):  – load a stream as a 3d texture source.
• draw (opdef):  – draw a GLSL shader via OSC.
• freeze (opdef):  – freeze a texture source.
• offset (opdef):  – get the playback offset of a buffered-stream-source.
• shader (opdef):  – compile a GLSL shader with uniforms.
• step! (opdef):  – step a frozen texture source.
• stream-source (opdef):  – load a stream texture source.
• tsv-source (opdef):  – load a texture-share-vk texture source.
• uniform (opdef):  – override uniform binding type.
• video-source (opdef):  – load a video texture source.

details

• buffered-stream-source (opdef):  – load a stream as a 3d texture source.

  (stream-source [socket] type depth uri [format] [args])

  Creates a circular buffer 3d texture from a capture source.

  • type must be 3D or 2D_ARRAY.

  • depth is the number of frames to keep in the buffer.

  • uri is the ffmpeg URI to load. If it starts with ./ it will be resolved relative to the current alv module.

  • format optionally specifies the ffmpeg/avformat input format to use.

  • args is a struct of optional arguments for the ffmpeg/avformat input format.

    (stream-source 'webcam' '3D' 64 '/dev/video0')

• 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?)

• offset (opdef):  – get the playback offset of a buffered-stream-source.

  (offset [glsl-type] source)

  GLSL type: float/double/int/uint

• 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
    • other values are implicitly converted as by glsl-view/uniform
• step! (opdef):  – step a frozen texture source.

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

• stream-source (opdef):  – load a stream texture source.

  (stream-source [socket] type uri [format] [args])

  Creates a realtime stream from a capture source.

  • type must be 2D.

  • uri is the ffmpeg URI to load. If it starts with ./ it will be resolved relative to the current alv module.

  • format optionally specifies the ffmpeg/avformat input format to use.

  • args is a struct of optional arguments for the ffmpeg/avformat input format.

    (stream-source 'webcam' '2D' '/dev/video0') (stream-source 'testpt' '2D' 'testsrc=size=1280x720:rate=30' 'lavfi')

• 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 the tsv name of this texture source.
  • type defaults to 2D.
• uniform (opdef):  – override uniform binding type.

  (uniform [glsl-type] value)

  Label an alive value with a GLSL type: (uniform 'sampler2D' 'sampler-name') is equivalent to {'type' 'sampler2D' 'val' 'sampler-name'}.

  When absent, glsl-type is inferred based on the type of value:

  • num, bool: uniform float/bool
  • num[I], bool[I]: uniform vecI/bvecI
  • num[I][J]: uniform matIxJ
• video-source (opdef):  – load a video texture source.

  (video-source [socket] type filename [format] [args])

  Creates a texture source from a video or image file.

  • type can be one of:
    • 2D: sampler2D (loads first frame only)
    • 3D or 2D_ARRAY: sampler3D/sampler2DArray (loads whole video)
  • filename is the video file to load. If it starts with ./ it will be resolved relative to the current alv module.
  • format optionally specifies the ffmpeg/avformat input format to use.
  • args is a struct of optional arguments for the ffmpeg/avformat input format.