Skip to content
sigma.js sigma.js
v4.0.6 Docs Examples GitHub 12.2K

LayerLifecycleHooks

Defined in: packages/sigma/src/rendering/nodes/types.ts:271

Lifecycle hooks for layers that need async resources. Returned by the lifecycle factory function.

optional beforeRender?: () => void

Defined in: packages/sigma/src/rendering/nodes/types.ts:282

Called before each render. Use for binding textures, updating dynamic uniforms, etc.

void


optional getAttributeData?: (data, attributeSource) => number | number[] | null

Defined in: packages/sigma/src/rendering/nodes/types.ts:306

Returns data for special attribute sources. Used by layers that need to inject per-node data from external sources (like texture coordinates from an atlas).

Record<string, unknown>

The node’s display data

string

The source name from the attribute specification

number | number[] | null

The value(s) for the attribute, or null to fall back to node data


optional init?: () => void

Defined in: packages/sigma/src/rendering/nodes/types.ts:276

Called after the program is initialized and ready. Use for setting up event listeners, initializing resources, etc.

void


optional kill?: () => void

Defined in: packages/sigma/src/rendering/nodes/types.ts:295

Called when the program is destroyed. Use for cleanup: removing listeners, releasing resources, etc.

void


optional regenerate?: () => FragmentLayer

Defined in: packages/sigma/src/rendering/nodes/types.ts:289

Called when the layer’s shader portion needs regeneration. Should return a new FragmentLayer definition with updated GLSL. If not provided, the original layer definition is reused.

FragmentLayer