@kognifai/cogsengine
    Preparing search index...

    Interface IWASMmodule

    Internal: Interface to COGS Web Assembly module

    interface IWASMmodule {
        canvas: HTMLCanvasElement;
        cogsRuntime: Runtime;
        dynamicLibraries: string[];
        GL: { textures: WebGLTexture[] };
        HEAP32: Int32Array;
        HEAP8: Int8Array;
        HEAPF32: Float32Array;
        HEAPU32: Uint32Array;
        HEAPU8: Uint8Array;
        locateFile: (path: string, prefix: string) => string;
        monitorRunDependencies: (left: number) => void;
        noExitRuntime: boolean;
        noInitialRun: boolean;
        postRun: () => void;
        preInit: () => void;
        print: (msg: string) => void;
        printErr: (msg: string) => void;
        setStatus: (msg: string) => void;
        TOTAL_MEMORY?: number;
        totalDependencies: number;
        _cancelMain(): void;
        _free(buffer: number): void;
        _getContext(): number;
        _getResourceStatistics(flags: number): number;
        _handleFetch(
            userdata: number,
            data: number,
            len: number,
            flags: FileContentsHints,
            status: number,
        ): void;
        _handleTextureFailure(context: number, userData: number): void;
        _handleTextureSuccess(
            context: number,
            width: number,
            height: number,
            srgb: boolean,
            hasMipmaps: boolean,
            userData: number,
        ): void;
        _init(argc: number, argv: number): number;
        _malloc(nDataBytes: number): number;
        _needsUpdate(): boolean;
        _resetFrameTimings(): void;
        _update(): number;
        addFunction(func: Function, signature: string): number;
        callMain(): void;
        cwrap(
            functionName: string,
            returnType: string,
            parameterTypes?: string[],
        ): Function;
        getValue(dataPtr: number, elementType: "float" | "i32" | "i16"): number;
        removeFunction(functionHandle: number): void;
        requestFullscreen(lock: boolean, resize: boolean): void;
        setValue(
            dataPtr: number,
            value: number,
            elementType: "float" | "i32" | "i16",
        ): void;
        stackAlloc(nDataBytes: number): number;
        stackRestore(oldState: number): void;
        stackSave(): number;
        stringToUTF8OnStack(str: string): number;
        UTF8ToString(heapString: number): string;
    }
    Index

    Properties

    canvas cogsRuntime dynamicLibraries GL HEAP32 HEAP8 HEAPF32 HEAPU32 HEAPU8 locateFile monitorRunDependencies noExitRuntime noInitialRun postRun preInit print printErr setStatus TOTAL_MEMORY? totalDependencies

    Methods

    _cancelMain _free _getContext _getResourceStatistics _handleFetch _handleTextureFailure _handleTextureSuccess _init _malloc _needsUpdate _resetFrameTimings _update addFunction callMain cwrap getValue removeFunction requestFullscreen setValue stackAlloc stackRestore stackSave stringToUTF8OnStack UTF8ToString

    Properties

    canvas: HTMLCanvasElement
    cogsRuntime: Runtime
    dynamicLibraries: string[]

    Internal: List of extensions libraries to load at startup

    GL: { textures: WebGLTexture[] }

    Emscripten GL object (cogs.esm.js: var GL = ..)

    HEAP32: Int32Array

    Internal: WASM memory as Int32 array (several versions exists)

    HEAP8: Int8Array

    Internal: WASM memory as Byte array (several versions exists)

    HEAPF32: Float32Array

    Internal: WASM memory as Float array (several versions exists)

    HEAPU32: Uint32Array

    Internal: WASM memory as Uint32 (several versions exists)

    HEAPU8: Uint8Array

    Internal: WASM memory as Byte array (several versions exists)

    locateFile: (path: string, prefix: string) => string
    monitorRunDependencies: (left: number) => void
    noExitRuntime: boolean
    noInitialRun: boolean
    postRun: () => void
    preInit: () => void
    print: (msg: string) => void
    printErr: (msg: string) => void
    setStatus: (msg: string) => void
    TOTAL_MEMORY?: number

    get from

    ControlStatus.totalMemory

    totalDependencies: number

    Methods

    _cancelMain

    • _cancelMain(): void

      Returns void

    _free

    • _free(buffer: number): void

      Internal: Free WASM memory returned by _malloc(..)

      Parameters

      • buffer: number

      Returns void

    _getContext

    • _getContext(): number

      Returns number

    _getResourceStatistics

    • _getResourceStatistics(flags: number): number

      Parameters

      • flags: number

      Returns number

    _handleFetch

    • _handleFetch(
          userdata: number,
          data: number,
          len: number,
          flags: FileContentsHints,
          status: number,
      ): void

      Parameters

      Returns void

    _handleTextureFailure

    • _handleTextureFailure(context: number, userData: number): void

      Parameters

      • context: number
      • userData: number

      Returns void

    _handleTextureSuccess

    • _handleTextureSuccess(
          context: number,
          width: number,
          height: number,
          srgb: boolean,
          hasMipmaps: boolean,
          userData: number,
      ): void

      Cogs.Core WebTextureLoader functions

      Parameters

      • context: number
      • width: number
      • height: number
      • srgb: boolean
      • hasMipmaps: boolean
      • userData: number

      Returns void

    _init

    • _init(argc: number, argv: number): number

      Parameters

      • argc: number
      • argv: number

      Returns number

    _malloc

    • _malloc(nDataBytes: number): number

      Internal: Allocate WASM memory

      Parameters

      • nDataBytes: number

      Returns number

    _needsUpdate

    • _needsUpdate(): boolean

      Returns boolean

    _resetFrameTimings

    • _resetFrameTimings(): void

      Cogs.js Main.cpp functions

      Returns void

    _update

    • _update(): number

      Returns number

    • Internal: register a function

      Parameters

      • func: Function
      • signature: string

      Returns number

    • Returns void

    • WASM cwrap function providing.

      Parameters

      • functionName: string
      • returnType: string
      • OptionalparameterTypes: string[]

      Returns Function

    • Internal: Copy one value from WASM memory (inefficient recommend copyFromHeap for more than few values)

      Parameters

      • dataPtr: number
      • elementType: "float" | "i32" | "i16"

      Returns number

    • Internal: remove a WASM function added by addFunction

      Parameters

      • functionHandle: number

      Returns void

    • Internal: Full screen setup called from Control.requestFullscreen

      Parameters

      • lock: boolean
      • resize: boolean

      Returns void

    • Internal: Copy one value to WASM memory (inefficient recommend runWithHeap/utilPassArrayData for more than few values)

      Parameters

      • dataPtr: number
      • value: number
      • elementType: "float" | "i32" | "i16"

      Returns void

    • Internal: Allocate memory on call-stack

      Parameters

      • nDataBytes: number

      Returns number

    • Internal: Restore stack to saved state

      Parameters

      • oldState: number

      Returns void

    • Internal: Save stack state

      Returns number

    • Parameters

      • str: string

      Returns number

    • Parameters

      • heapString: number

      Returns string

    Settings

    Member Visibility

    On This Page

    Properties
    Methods