API

Interface IWebXRBackgroundRemoverOptions

Options interface for the background remover plugin

interface IWebXRBackgroundRemoverOptions {
    backgroundMeshes?: AbstractMesh[];
    environmentHelperRemovalFlags?: { ground?: boolean; skyBox?: boolean };
    ignoreEnvironmentHelper?: boolean;
}
Index
backgroundMeshes?: AbstractMesh[]

Further background meshes to disable when entering AR

environmentHelperRemovalFlags?: { ground?: boolean; skyBox?: boolean }

flags to configure the removal of the environment helper. If not set, the entire background will be removed. If set, flags should be set as well.

Type Declaration

  • Optionalground?: boolean

    Should the ground be removed (default false)

  • OptionalskyBox?: boolean

    Should the skybox be removed (default false)

ignoreEnvironmentHelper?: boolean

don't disable the environment helper