babylon.quarks - v1.0.0
    Preparing search index...

    Interface QuarksLoaderOptions

    Options for a QuarksLoader, shared by every load it does.

    interface QuarksLoaderOptions {
        baseUrl?: string;
        onFormatWarning?: (message: string, path: string) => void;
        onResourceError?: (
            kind: QuarksResourceKind,
            url: string,
            error: unknown,
        ) => void;
        resolver?: QuarksResourceResolver;
        shareResources?: boolean;
        strict?: boolean;
        waitForTextures?: boolean;
    }
    Index
    baseUrl?: string

    Prefix joined to relative effect, geometry and image urls (see QuarksLoader.joinUrl). Unset, an effect url is relative to the page, and QuarksLoader.load resolves the effect's geometry and image links against the effect file's own folder; the other loads use ''.

    onFormatWarning?: (message: string, path: string) => void

    Called for each part of an effect file that cannot be read as written (an unknown behavior, shape or curve type, a sub emitter or mesh surface shape whose target is not in the effect, a newer format), with what was used instead and the part's JSON path, such as object.children[2].ps.behaviors[3]. The effect still loads, with that part at its default. Default: a console warning that names the path.

    onResourceError?: (
        kind: QuarksResourceKind,
        url: string,
        error: unknown,
    ) => void

    Called for a geometry file or image that fails to load. The effect still loads: a geometry keeps its link unresolved, and a texture draws nothing. Default: a console warning.

    Custom url / fetch backend (File picker, CDN, IndexedDB).

    shareResources?: boolean

    Reuse one Texture per scene for every effect that references the same image with the same sampling, and one copy of the data for identical mesh geometry. The renderer only batches systems that share the texture (and geometry) object, so without this every loaded effect gets batches — draw calls and buffer uploads — of its own even when its images are the same as another effect's. Default true; turn off to give each effect private textures, e.g. to change one effect's texture settings without touching the others.

    strict?: boolean

    Makes a load of a file with a part that cannot be read as written throw a QuarksFormatError instead of loading on with a warning: for checks that a set of assets loads cleanly, such as in CI. The whole effect is read first, so the error's message names the first such part and its problems list them all; what the load built is freed before it throws. onFormatWarning still hears each part. Default false.

    waitForTextures?: boolean

    Makes load, loadFromJSON, loadAll and loadFromJSONAll resolve only once every texture the effect uses has loaded or failed, so it does not draw its first frames without them. A texture a scene with useDelayedTextureLoading would load only once drawn is loaded at once. parse never waits. Default false: they resolve when the nodes are built.