gpu-io

The WebGLTexture corresponding to a GPULayer buffer (e.g. currentState or lastState). This data structure also includes a reference back to the GPULayer that it originated from.

Type declaration

Name	Type
`texture`	`WebGLTexture`
`layer`	`GPULayer`

ImageFormat

Ƭ ImageFormat: typeof RGB | typeof RGBA

Image formats for GPULayer.initFromImage().

ImageType

Ƭ ImageType: typeof UNSIGNED_BYTE | typeof FLOAT | typeof HALF_FLOAT

Image types for GPULayer.initFromImage().

GLSLVersion

Ƭ GLSLVersion: typeof GLSL1 | typeof GLSL3

GLSL available versions.

GLSLPrecision

Ƭ GLSLPrecision: typeof PRECISION_LOW_P | typeof PRECISION_MEDIUM_P | typeof PRECISION_HIGH_P

GLSL available precision declarations.

UniformType

Ƭ UniformType: typeof FLOAT | typeof INT | typeof UINT | typeof BOOL

GPUProgram uniform types.

UniformValue

Ƭ UniformValue: boolean | boolean[] | number | number[]

GPUProgram uniform values.

UniformParams

Ƭ UniformParams: Object

GPUProgram uniform parameters.

Type declaration

Name	Type
`name`	`string`
`value`	`UniformValue`
`type`	`UniformType`

CompileTimeConstants

Ƭ CompileTimeConstants: Object

Object containing compile time #define constants for GPUProgram fragment shader.

Index signature

▪ [key: string]: string

ErrorCallback

Ƭ ErrorCallback: (message: string) => void

Type declaration

▸ (message): void

Parameters

Name	Type
`message`	`string`

Returns

void

BoundaryEdge

Ƭ BoundaryEdge: typeof BOUNDARY_TOP | typeof BOUNDARY_BOTTOM | typeof BOUNDARY_LEFT | typeof BOUNDARY_RIGHT

GPUProgram Helper Functions

copyProgram

▸ copyProgram(composer, params): GPUProgram

Init GPUProgram to copy contents of one GPULayer to another GPULayer.

Parameters

Name	Type	Description
`composer`	`GPUComposer`	The current GPUComposer.
`params`	`Object`	Program parameters.
`params.type`	`GPULayerType`	The type of the input/output.
`params.name?`	`string`	Optionally pass in a GPUProgram name, used for error logging.
`params.precision?`	`GLSLPrecision`	Optionally specify the precision of the input/output.

Returns

GPUProgram

addLayersProgram

▸ addLayersProgram(composer, params): GPUProgram

Init GPUProgram to add several GPULayers together.

Parameters

Name	Type	Description
`composer`	`GPUComposer`	The current GPUComposer.
`params`	`Object`	Program parameters.
`params.type`	`GPULayerType`	The type of the inputs/output.
`params.components?`	`string`	Component(s) of inputs to add, defaults to 'xyzw.
`params.name?`	`string`	Optionally pass in a GPUProgram name, used for error logging.
`params.numInputs?`	`number`	The number of inputs to add together, defaults to 2.
`params.precision?`	`GLSLPrecision`	Optionally specify the precision of the inputs/output.

Returns

GPUProgram

addValueProgram

▸ addValueProgram(composer, params): GPUProgram

Init GPUProgram to add uniform "u_value" to a GPULayer.

Parameters

Name	Type	Description
`composer`	`GPUComposer`	The current GPUComposer.
`params`	`Object`	Program parameters.
`params.type`	`GPULayerType`	The type of the input/output (we assume "u_value" has the same type).
`params.value`	`number` \| `number`[]	Initial value to add, if value has length 1 it will be applied to all components of GPULayer. Change this later using uniform "u_value".
`params.name?`	`string`	Optionally pass in a GPUProgram name, used for error logging.
`params.precision?`	`GLSLPrecision`	Optionally specify the precision of the input/output/"u_value".

Returns

GPUProgram

multiplyValueProgram

▸ multiplyValueProgram(composer, params): GPUProgram

Init GPUProgram to multiply uniform "u_value" to a GPULayer.

Parameters

Name	Type	Description
`composer`	`GPUComposer`	The current GPUComposer.
`params`	`Object`	Program parameters.
`params.type`	`GPULayerType`	The type of the input/output (we assume "u_value" has the same type).
`params.value`	`number` \| `number`[]	Initial value to multiply, if value has length 1 it will be applied to all components of GPULayer. Change this later using uniform "u_value".
`params.name?`	`string`	Optionally pass in a GPUProgram name, used for error logging.
`params.precision?`	`GLSLPrecision`	Optionally specify the precision of the input/output/"u_value".

Returns

GPUProgram

setValueProgram

▸ setValueProgram(composer, params): GPUProgram

Init GPUProgram to set all elements in a GPULayer to uniform "u_value".

Parameters

Name	Type	Description
`composer`	`GPUComposer`	The current GPUComposer.
`params`	`Object`	Program parameters.
`params.type`	`GPULayerType`	The type of the output (we assume "u_value" has same type).
`params.value`	`number` \| `number`[]	Initial value to set, if value has length 1 it will be applied to all components of GPULayer. Change this later using uniform "u_value".
`params.name?`	`string`	Optionally pass in a GPUProgram name, used for error logging.
`params.precision?`	`GLSLPrecision`	Optionally specify the precision of the output/"u_value".

Returns

GPUProgram

setColorProgram

▸ setColorProgram(composer, params): GPUProgram

Init GPUProgram to set all elements in a GPULayer to uniform "u_value".

Parameters

Name	Type	Description
`composer`	`GPUComposer`	The current GPUComposer.
`params`	`Object`	Program parameters.
`params.type`	`GPULayerType`	The type of the output.
`params.color?`	`number`[]	Initial color as RGB in range [0, 1], defaults to [0, 0, 0]. Change this later using uniform "u_color".
`params.opacity?`	`number`	Initial opacity in range [0, 1], defaults to 1. Change this later using uniform "u_opacity".
`params.name?`	`string`	Optionally pass in a GPUProgram name, used for error logging.
`params.precision?`	`GLSLPrecision`	Optionally specify the precision of the output/uniforms.

Returns

GPUProgram

zeroProgram

▸ zeroProgram(composer, params): GPUProgram

Init GPUProgram to zero output GPULayer.

Parameters

Name	Type	Description
`composer`	`GPUComposer`	The current GPUComposer.
`params`	`Object`	Program parameters.
`params.name?`	`string`	Optionally pass in a GPUProgram name, used for error logging.

Returns

GPUProgram

renderRGBProgram

▸ renderRGBProgram(composer, params): GPUProgram

Init GPUProgram to render 3 component GPULayer as RGB.

Parameters

Name	Type	Description
`composer`	`GPUComposer`	The current GPUComposer.
`params`	`Object`	Program parameters.
`params.type`	`GPULayerType`	The type of the input.
`params.name?`	`string`	Optionally pass in a GPUProgram name, used for error logging.
`params.scale?`	`number`	Scaling factor, defaults to 1. Change this later using uniform "u_scale".
`params.opacity?`	`number`	Opacity, defaults to 1. Change this later using uniform "u_opacity".
`params.precision?`	`GLSLPrecision`	Optionally specify the precision of the input.

Returns

GPUProgram

renderAmplitudeProgram

▸ renderAmplitudeProgram(composer, params): GPUProgram

Init GPUProgram to render RGBA amplitude of an input GPULayer's components, defaults to grayscale rendering and works for scalar and vector fields.

Parameters

Name	Type	Description
`composer`	`GPUComposer`	The current GPUComposer.
`params`	`Object`	Program parameters.
`params.type`	`GPULayerType`	The type of the input.
`params.components?`	`string`	Component(s) of input GPULayer to render, defaults to 'xyzw'.
`params.name?`	`string`	Optionally pass in a GPUProgram name, used for error logging.
`params.scale?`	`number`	Scaling factor, defaults to 1. Change this later using uniform "u_scale".
`params.opacity?`	`number`	Opacity, defaults to 1. Change this later using uniform "u_opacity".
`params.colorMax?`	`number`[]	RGB color for amplitude === scale, scaled to [0,1] range, defaults to white. Change this later using uniform "u_colorMax".
`params.colorMin?`	`number`[]	RGB color for amplitude === 0, scaled to [0,1] range, defaults to black. Change this later using uniform "u_colorMin".
`params.precision?`	`GLSLPrecision`	Optionally specify the precision of the input.

Returns

GPUProgram

renderSignedAmplitudeProgram

▸ renderSignedAmplitudeProgram(composer, params): GPUProgram

Init GPUProgram to render signed amplitude of an input GPULayer to linearly interpolated colors.

Parameters

Name	Type	Description
`composer`	`GPUComposer`	The current GPUComposer.
`params`	`Object`	Program parameters.
`params.type`	`GPULayerType`	The type of the input.
`params.component?`	`"x"` \| `"y"` \| `"z"` \| `"w"`	Component of input GPULayer to render, defaults to "x".
`params.name?`	`string`	Optionally pass in a GPUProgram name, used for error logging.
`params.scale?`	`number`	Scaling factor, defaults to 1. Change this later using uniform "u_scale".
`params.bias?`	`number`	Bias for center point of color range, defaults to 0. Change this later using uniform "u_bias".
`params.opacity?`	`number`	Opacity, defaults to 1. Change this later using uniform "u_opacity".
`params.colorMax?`	`number`[]	RGB color for amplitude === bias + scale, scaled to [0,1] range, defaults to red. Change this later using uniform "u_colorMax".
`params.colorMin?`	`number`[]	RGB color for amplitude === bias + scale, scaled to [0,1] range, defaults to blue. Change this later using uniform "u_colorMin".
`params.colorCenter?`	`number`[]	RGB color for amplitude === bias, scaled to [0,1] range, defaults to white. Change this later using uniform "u_colorCenter".
`params.precision?`	`GLSLPrecision`	Optionally specify the precision of the input.