kiteplayer-audioviz/io.github.yuroyami.kiteplayer.audioviz.viz.shader/LiveShader

LiveShader

class LiveShader(val name: String, source: String) : Visualization

A shader drawing whose program can be swapped while it runs. Made for writing new ones.

Hand replace new source whenever the file it came from is saved. If it compiles, the drawing switches to it on the next frame. If it does not, the old program keeps running and the compiler's message is kept in error, so a typo shows up as a message rather than as a black screen. The source is only the body: the shared library, with the spectrum, the palette and the rest, is put in front of it the same way it is for every built-in shader.

Constructors

LiveShader

constructor(name: String, source: String)

Properties

anchors

open val anchors: List<Anchor>

Where this drawing's actors are on screen, as shares. The first is the main one.

bloom

open val bloom: Int

Extra copies of the surviving frame at slightly different sizes, which reads as light bleed.

bucket

open override val bucket: VizEnergy

How busy this drawing is, so something choosing for the listener can match it to the music.

detail

open val detail: Detail?

A fine moving texture added over everything, the smallest of the three scales. Null for none.

echoBlend

open val echoBlend: EchoBlend

How the echo layer is laid over the ground.

error

var error: String?

What the compiler said about the last source tried, or null when it compiled.

feedbackSpin

open val feedbackSpin: Float

Radians per second the surviving frame turns by. Echoes spiral instead of expanding straight.

feedbackZoom

open val feedbackZoom: Float

How much the surviving frame grows before the new one is drawn on top. 1 leaves it alone.

forms

open val forms: FormReadout?

The form on screen and the count of its changes, or null for a drawing with no named forms.

genes

open val genes: Genes?

The parts of the recipe the song changes. Null for a drawing with none.

ground

open val ground: Ground?

A live field drawn under everything else. Null keeps the plain background colour.

mapping

open val mapping: VizMapping?

What this drawing does with the audio, in a form a test and a menu can read.

moodSpec

open val moodSpec: MoodSpec?

Different settings for calm and lively music. Overrides trail, feedbackZoom, feedbackSpin.

name

open override val name: String

paintsWholeScreen

open val paintsWholeScreen: Boolean

True for drawings that paint every pixel themselves, such as the full-screen shaders.

params

open val params: List<VizParam>

Settings a person may change while it runs. Most drawings have none.

post

open override val post: PostSpec

The finishing pass over this drawing: glow around bright parts, darker corners, a little grain. Drawings that already glow through the feedback loop get a gentler version, so the two do not stack up into a haze.

trail

open val trail: Float

How much of the previous frame survives, 0 to just under 1.

transitions

open val transitions: List<VizTransition>

The ways this drawing can arrive. The director picks among these and what suits the music. A drawing with no trail has no echoes to inherit, so the hand-off is only on offer to drawings that feed their frames back.

warp

open val warp: WarpSpec?

How the previous frame is bent on its way back, per pixel.

Functions

bloomShareAt

open fun bloomShareAt(mood: Float): Float

How much of the trail's budget the wide copies take, for this mood.

draw

open override fun DrawScope.draw(state: VizRenderState)

drawFront

open fun DrawScope.drawFront(state: VizRenderState)

Drawn after the echo layer, straight on the canvas, for things that must stay sharp.

echo

open fun echo(state: VizRenderState): EchoFrame

How the last frame comes back this frame. The default reads the zoom, spin and drift for the mood, and settles all three towards neutral as the music goes quiet.

feedbackSpinAt

open fun feedbackSpinAt(mood: Float): Float

The feedback spin for this mood.

feedbackZoomAt

open fun feedbackZoomAt(mood: Float): Float

The feedback zoom for this mood.

onPreviousFrame

open fun onPreviousFrame(picture: ImageBitmap?)

The echo layer as it stood a frame ago, handed over just before draw, or null when there is no echo buffer yet. Most drawings ignore it; one that breaks the picture apart cuts its pieces from it.

replace

fun replace(source: String): String?

Compiles source and switches to it if it worked. Answers the compiler's message, or null.

reset

open override fun reset()

Drops any carried state. Called when this drawing is shown.

trailAt

open fun trailAt(mood: Float): Float

The trail for this mood. The surface calls this rather than reading trail.

trailHalfLifeAt

open fun trailHalfLifeAt(mood: Float): Float

How long the trail takes to fade to half, in seconds, for this mood.