API reference

Every public class, method, and event in @codexo/exojs. Generated from source.

classColorOverSpeed

@codexo/exojs-particles / particles / stable

Per-frame, per-particle color sampler driven by velocity magnitude rather than lifetime ratio. Each live particle's tint is set to the gradient evaluated at `clamp((|velocity| - minSpeed) / (maxSpeed - minSpeed), 0, 1)`. Use cases: heat-mapping (slow=blue, fast=red), velocity-tinted trails, speed-gated highlights. GPU-eligible: gradient uploaded as a 256-tap 1D RGBA8 texture, sampled with linear filtering. Replaces the full color word - pair with a separate AlphaFadeOverLifetime after this module if you want to keep alpha controlled by lifetime.

props

methods

events

Import

import { ColorOverSpeed } from '@codexo/exojs-particles'

Use cases: heat-mapping (slow=blue, fast=red), velocity-tinted trails, speed-gated highlights.

GPU-eligible: gradient uploaded as a 256-tap 1D RGBA8 texture, sampled with linear filtering. Replaces the full color word - pair with a separate AlphaFadeOverLifetime after this module if you want to keep alpha controlled by lifetime.

Constructors1

new(gradient: ColorGradientPiecewise-linear color gradient sampled by lifetime ratio `t` in `[0, 1]`. Keyframes are stored sorted by `t`; sampling outside the range returns the nearest e…, minSpeed: number, maxSpeed: number): ColorOverSpeed

Methods5

apply(particles: ParticleBatchThe live particles of one system, addressed by semantic channel. This is the bulk surface an UpdateModule and a ParticleRenderMode operate on. Channels are nam…, _dt: number): void

Mutates the live particles for one frame. Runs only on the CPU path: a system whose modules are all GPU-eligible executes wgsl bodies inside its compute shader instead, and never calls this.

destroy(): void

Optional cleanup hook called from ParticleSystem.destroy.

uploadTextures(device: GPUDevice, textures: ReadonlyMap<string, GPUTexture>): void

Upload texture data (Curve/ColorGradient lookup tables) to the GPU at compile time. Receives the GPUDevice and a map of texture bindings keyed by the name in WgslContribution.textures. Called once after pipeline creation. Required when wgsl declares textures.

wgsl(): WgslContributionWhat an UpdateModule contributes to the system's composite compute shader. `body` runs once per particle in the inner main function, with these locals in scope…

Override to declare a GPU contribution. Returning a WgslContribution makes this module GPU-eligible; omitting (or returning undefined) forces CPU mode for any system that uses this module.

writeUniforms(view: DataView, offset: number): void

Write this module's current uniform values into the shared uniform buffer at byteOffset. Layout must match the field declarations returned by wgsl (in the same order). Receives the current frame dt (seconds). Modules tracking accumulated time (e.g. noise/turbulence) should advance their internal counter here to stay in sync when running in GPU mode (where apply is not called). Required when wgsl declares uniforms. Called every frame by the system before dispatching compute.

Properties3

gradient: ColorGradientPiecewise-linear color gradient sampled by lifetime ratio `t` in `[0, 1]`. Keyframes are stored sorted by `t`; sampling outside the range returns the nearest e…

maxSpeed: number

minSpeed: number

Source

packages/exojs-particles/src/modules/ColorOverSpeed.ts