Scrawl-canvas API
    Preparing search index...

    Interface RenderSaveInputs

    interface RenderSaveInputs {
        afterClear?: DefaultInputFunction;
        afterCompile?: DefaultInputFunction;
        afterCreated?: DefaultInputFunction;
        afterShow?: DefaultInputFunction;
        commence?: DefaultInputFunction;
        error?: DefaultInputFunction;
        includeDefaults?: boolean | string[];
        maxFrameRate?: number;
        name?: string;
        noTarget?: boolean;
        observer?: boolean | CommonObjectInput;
        onHalt?: DefaultInputFunction;
        onKill?: DefaultInputFunction;
        onRun?: DefaultInputFunction;
        order?: number;
        target?: string | TargetInstance | (string | TargetInstance)[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    afterClear? afterCompile? afterCreated? afterShow? commence? error? includeDefaults? maxFrameRate? name? noTarget? observer? onHalt? onKill? onRun? order? target?

    Properties

    afterClear?: DefaultInputFunction
    afterCompile?: DefaultInputFunction
    afterCreated?: DefaultInputFunction
    afterShow?: DefaultInputFunction
    commence?: DefaultInputFunction
    error?: DefaultInputFunction
    includeDefaults?: boolean | string[]
    maxFrameRate?: number
    name?: string
    noTarget?: boolean
    observer?: boolean | CommonObjectInput
    onHalt?: DefaultInputFunction
    onKill?: DefaultInputFunction
    onRun?: DefaultInputFunction
    order?: number
    target?: string | TargetInstance | (string | TargetInstance)[]

    One or more render targets.

    Accepts a target name, a Canvas/Stack/Cell instance, or an array mixing names and instances. In most day-to-day use this will be a Canvas or Stack.

    If omitted, the render can still run when noTarget is true and the hook functions are being used for orchestration rather than drawing.

    Settings

    Member Visibility

    On This Page

    Properties