effect-motion
API Referenceeffect-motionNamespacesSceneVariables

clearMask

const clearMask: (...args) => Effect<Instance<MaskableTag>, never, Runner>;

Variable: clearMask

const clearMask: (...args) => Effect<Instance<MaskableTag>, never, Runner>;

Defined in: packages/motion/src/Scene.ts:819

Removes a target's mask at the current scene frame and returns the target.

Details

The former source resumes ordinary rendering if it is mounted and visible. Calling this on an unmasked target leaves it unchanged.

Parameters

ParameterType
...args[Instance<MaskableTag>]

Returns

Effect<Instance<MaskableTag>, never, Runner>

See

setMask to attach or replace a mask.

On this page