Skip to content
Apexify.jsDocs
Apexify.js version v5.4.5

interface export

HitDetectionOptions

Published interface export HitDetectionOptions.

apexify.jsCURRENTnode22node24node26
Source: lib-next/types/hit-detection.ts (opens in a new tab)

Signature

TypeScript
export interface HitDetectionOptions {
    includeStroke?: boolean;
    strokeWidth?: number;
    tolerance?: number;
    region?: HitRegion;
    /** Fill rule when testing {@link PathCommand} / {@link Path2D} regions. */
    fillRule?: CanvasFillRule;
}

Related APIs

No explicit related API metadata.

Next steps

AdsrEnvelopeAPI · node · CURRENT

ADSR envelope (seconds + sustain level 0–1). Stages are proportionally fitted when A+D+R exceeds the layer duration.

ApexifyPluginAPI · node · CURRENT

Install hook for optional features without growing the core {@link ApexPainter } class. Installation may be synchronous or asynchronous. `ApexPainter.use(plugin)` always returns a Promise and must be awaited before plugin APIs are considered installed. Plugin names are unique per painter. Registrations made through `painter.plugins` during a failed installation are rolled back.

AssetRegistrationInfoAPI · node · CURRENT

Published interface export AssetRegistrationInfo.

AvatarToLayersOptionsAPI · node · CURRENT

Published interface export AvatarToLayersOptions.