API
API|
@babylonjs/core|
EquiRectangularCaptureOptions

Interface EquiRectangularCaptureOptions

Interface containing options related to equirectangular capture of the current scene

interface EquiRectangularCaptureOptions {
    filename?: string;
    meshesFilter?: (mesh: AbstractMesh) => boolean;
    position?: Vector3;
    probe?: ReflectionProbe;
    size: number;
}
Index
filename? meshesFilter? position? probe? size
filename?: string

Optional argument to specify filename, passing this would auto download the given file

meshesFilter?: (mesh: AbstractMesh) => boolean

Optional function to map which meshes should get rendered on the equirectangular map This is specifically helpful when you have certain meshes that you want to skip, especially ground

position?: Vector3

Optional argument to specify position in 3D Space from where the equirectangular capture should be taken, if not specified, it would take the position of the scene's active camera or else origin

probe?: ReflectionProbe

Optional argument to specify probe with which the equirectangular image is generated When passing this, size and position arguments are ignored

size: number

This option relates to smallest dimension of the given equirectangular capture Giving a 512px size would result in an image that 512 x 1024px