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

interface export

CanvasImageBackgroundOptions

Placement/effect contract shared by still-image canvas backgrounds. `videoBg` uses these options after its selected video frame has been extracted to a raster image, keeping its public video selection API distinct while sharing the same image rendering semantics as `customBg`.

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

Signature

TypeScript
export interface CanvasImageBackgroundOptions {
    /** Adopt the source image dimensions as the canvas dimensions. */
    inherit?: boolean;
    /** Resize policy when `inherit` is false. */
    fit?: FitMode;
    /** Placement used by `contain` / `cover` when `inherit` is false. */
    align?: AlignMode;
    /** Image filters applied to this background only. */
    filters?: ImageFilter[];
    /** Background-image opacity, multiplied by the canvas-level opacity. */
    opacity?: number;
}

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.