Login
HypnoSpec // space.hypna.feature.spirals.customgl
Scripted WebGL Spiral Feature Descriptor

Scripted WebGL Spiral Feature Descriptor

Type: object

This feature renders a spiral from a user-authored WebGL fragment shader. The player supplies the standard spiral uniforms (iTime, iRes, u_resolution, spiralColor, bgColor, spinSpeed, throbSpeed, throbStrength, zoom); the fragment shader source is fully editable by the session author.

root id
Type: string

A unique identifier for the project. Current standard is java-inspired. ex. 'space.hypna.feature.variables'

root creator
Type: string

Name or ID of the Creator of this Feature.

root version
Type: string

Version of this Feature.

root required
Type: boolean

Flag to determine if the feature is required or not.

root useProjectLevelConfiguration
Type: boolean

If this schema is used in a Session Container, and this value is true, the system should read the configuration from the Project-Level Feature Schema with the same key. If the key cannot be found, fall back to this configuration.

root dependencies
Type: array of string

List of features that are required to enable this feature. An exclamation mark in front of the string denotes an optional requirement that should raise a warning.

 No Additional Items

Each item of this array must be:

root dependencies dependencies items
Type: string

root configuration
Type: object

The configuration of this feature. Can be any free-form configuration in this space, but should be documented somewhere for feature comparison. It is recommended that this spec be used as the base for other feature specs.

root configuration opacity
Type: number Default: 0.6

Opacity of the spiral canvas

root configuration spiral_color
Type: string Default: "#FFFFFF"

Color passed to the shader as the spiralColor uniform (HEX CODE)

root configuration bg_color
Type: string Default: "#000000"

Color passed to the shader as the bgColor uniform (HEX CODE)

root configuration spin_speed
Type: number Default: 1

Value passed to the shader as the spinSpeed uniform

root configuration throb_speed
Type: number Default: 2

Value passed to the shader as the throbSpeed uniform

root configuration throb_strength
Type: number Default: 1

Value passed to the shader as the throbStrength uniform

root configuration zoom
Type: number Default: 1

Value passed to the shader as the zoom uniform

root configuration fragment_source
Type: string

WebGL 1 (GLSL ES 1.0) fragment shader source rendered on a full-screen quad. May declare any of the standard spiral uniforms.