API

Variable DumpToolsConst

DumpTools: {
    Dispose: () => void;
    DumpData: (
        width: number,
        height: number,
        data: ArrayBufferView,
        successCallback?: (data: string | ArrayBuffer) => void,
        mimeType?: string,
        fileName?: string,
        invertY?: boolean,
        toArrayBuffer?: boolean,
        quality?: number,
    ) => void;
    DumpDataAsync: {
        (
            width: number,
            height: number,
            data: ArrayBufferView,
            mimeType: string | undefined,
            fileName: string | undefined,
            invertY: boolean | undefined,
            toArrayBuffer: true,
            quality?: number,
        ): Promise<ArrayBuffer>;
        (
            width: number,
            height: number,
            data: ArrayBufferView,
            mimeType?: string,
            fileName?: string,
            invertY?: boolean,
            toArrayBuffer?: boolean,
            quality?: number,
        ): Promise<string>;
    };
    DumpFramebuffer: (
        width: number,
        height: number,
        engine: AbstractEngine,
        successCallback?: (data: string) => void,
        mimeType?: string,
        fileName?: string,
        quality?: number,
    ) => Promise<void>;
} = ...

Object containing a set of static utilities functions to dump data from a canvas

Type Declaration

  • Dispose: () => void
  • DumpData: (
        width: number,
        height: number,
        data: ArrayBufferView,
        successCallback?: (data: string | ArrayBuffer) => void,
        mimeType?: string,
        fileName?: string,
        invertY?: boolean,
        toArrayBuffer?: boolean,
        quality?: number,
    ) => void
  • DumpDataAsync: {
        (
            width: number,
            height: number,
            data: ArrayBufferView,
            mimeType: string | undefined,
            fileName: string | undefined,
            invertY: boolean | undefined,
            toArrayBuffer: true,
            quality?: number,
        ): Promise<ArrayBuffer>;
        (
            width: number,
            height: number,
            data: ArrayBufferView,
            mimeType?: string,
            fileName?: string,
            invertY?: boolean,
            toArrayBuffer?: boolean,
            quality?: number,
        ): Promise<string>;
    }
  • DumpFramebuffer: (
        width: number,
        height: number,
        engine: AbstractEngine,
        successCallback?: (data: string) => void,
        mimeType?: string,
        fileName?: string,
        quality?: number,
    ) => Promise<void>

use functions