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

    Interface SerializeEffectOptions

    Options for serializeEffect.

    interface SerializeEffectOptions {
        filter?: (node: TransformNode) => boolean;
        generator?: string;
        imageUrl?: (texture: Texture) => string | null | undefined;
        name?: string;
        onWarning?: (message: string) => void;
    }
    Index
    filter?: (node: TransformNode) => boolean

    Leaves a node and everything under it out of the file when it returns false, e.g. helpers an editor parents under an effect.

    generator?: string

    Written to metadata.generator. Default 'babylon.quarks'.

    imageUrl?: (texture: Texture) => string | null | undefined

    The url written for a texture's image. Default: the url the texture's image had in the file it was loaded from (see textureSourceUrl), so a file saved next to its source loads the same images; for a texture made in code, its url. Return a path relative to where the file will be saved when that differs from the source, or give a texture made in code a url or a data: URI. Return null to write the texture without an image.

    name?: string

    Several roots are written as children of one group; its name. Default 'effect'.

    onWarning?: (message: string) => void

    Called for each part of the effect the file cannot hold as it is, such as a texture with no url a file can point at. Default: console.warn.