effect-motion
API Referenceeffect-motionNamespacesParticlesInterfaces

FieldInput

props unique to a floating field (scattered, drifting, wrapping)

Interface: FieldInput

Defined in: packages/motion/src/particles/constructors.ts:64

props unique to a floating field (scattered, drifting, wrapping)

Extends

  • CommonInput

Properties

capacity?

readonly optional capacity?: number;

Defined in: packages/motion/src/particles/constructors.ts:50

fixed particle capacity

Inherited from

CommonInput.capacity

drift

readonly drift: Range;

Defined in: packages/motion/src/particles/constructors.ts:66

drift speed range (px/sec); direction is uniform-random


gravity?

readonly optional gravity?: number;

Defined in: packages/motion/src/particles/constructors.ts:46

shared screen-downward (-y) acceleration (px/sec²)

Inherited from

CommonInput.gravity

opacityOverLife?

readonly optional opacityOverLife?: OverLifeInput;

Defined in: packages/motion/src/particles/constructors.ts:48

Inherited from

CommonInput.opacityOverLife

opacityRange?

readonly optional opacityRange?: Range;

Defined in: packages/motion/src/particles/constructors.ts:42

per-particle birth opacity range (0..1); over-life curve multiplies it

Inherited from

CommonInput.opacityRange

palette?

readonly optional palette?: readonly Color[];

Defined in: packages/motion/src/particles/constructors.ts:44

colors drawn from uniformly at birth

Inherited from

CommonInput.palette

region?

readonly optional region?: {
  h: number;
  w: number;
};

Defined in: packages/motion/src/particles/constructors.ts:68

spread/wrap region in local coords; defaults to the whole frame

h

readonly h: number;

w

readonly w: number;

size?

readonly optional size?: Range;

Defined in: packages/motion/src/particles/constructors.ts:40

birth size range (px radius)

Inherited from

CommonInput.size

sizeOverLife?

readonly optional sizeOverLife?: OverLifeInput;

Defined in: packages/motion/src/particles/constructors.ts:47

Inherited from

CommonInput.sizeOverLife

x?

readonly optional x?: number;

Defined in: packages/motion/src/particles/constructors.ts:37

Inherited from

CommonInput.x

y?

readonly optional y?: number;

Defined in: packages/motion/src/particles/constructors.ts:38

Inherited from

CommonInput.y

On this page