Skip to main content

Class: DepthOptions

Defined in: src/depth/DepthOptions.ts:27

Constructors​

Constructor​

new DepthOptions(options?): DepthOptions

Defined in: src/depth/DepthOptions.ts:44

Parameters​

options?​
dataFormatPreference?​

readonly (XRDepthDataFormat | undefined)[] = ...

debugging?​

boolean = false

depthMesh?​

{ colliderUpdateFps?: number; depthFullResolution?: number; depthMeshUpdateFps?: number; enabled?: boolean; ignoreEdgePixels?: number; opacity?: number; patchHoles?: boolean; patchHolesUpper?: boolean; renderShadow?: boolean; shadowOpacity?: number; showDebugTexture?: boolean; updateFullResolutionGeometry?: boolean; updateVertexNormals?: boolean; useDepthTexture?: boolean; useDownsampledGeometry?: boolean; useDualCollider?: boolean; } = ...

depthMesh.colliderUpdateFps?​

number = 5

depthMesh.depthFullResolution?​

number = 160

depthMesh.depthMeshUpdateFps?​

number = 0

FPS cap for depth mesh geometry updates. 0 = update every frame.

depthMesh.enabled?​

boolean = false

depthMesh.ignoreEdgePixels?​

number = 3

depthMesh.opacity?​

number = 1.0

depthMesh.patchHoles?​

boolean = false

depthMesh.patchHolesUpper?​

boolean = false

depthMesh.renderShadow?​

boolean = false

depthMesh.shadowOpacity?​

number = 0.25

depthMesh.showDebugTexture?​

boolean = false

depthMesh.updateFullResolutionGeometry?​

boolean = false

depthMesh.updateVertexNormals?​

boolean = false

depthMesh.useDepthTexture?​

boolean = false

depthMesh.useDownsampledGeometry?​

boolean = true

depthMesh.useDualCollider?​

boolean = false

depthTexture?​

{ applyGaussianBlur?: boolean; applyKawaseBlur?: boolean; constantKernel?: boolean; enabled?: boolean; } = ...

depthTexture.applyGaussianBlur?​

boolean = false

depthTexture.applyKawaseBlur?​

boolean = false

depthTexture.constantKernel?​

boolean = false

depthTexture.enabled?​

boolean = false

depthTypeRequest?​

readonly (XRDepthType | undefined)[] = ...

enabled?​

boolean = false

matchDepthView?​

boolean = false

occlusion?​

{ enabled?: boolean; } = ...

occlusion.enabled?​

boolean = false

usagePreference?​

readonly (XRDepthUsage | undefined)[] = []

Returns​

DepthOptions

Properties​

dataFormatPreference​

dataFormatPreference: XRDepthDataFormat[]

Defined in: src/depth/DepthOptions.ts:40

debugging​

debugging: boolean = false

Defined in: src/depth/DepthOptions.ts:28

depthMesh​

depthMesh: DepthMeshOptions

Defined in: src/depth/DepthOptions.ts:30

depthTexture​

depthTexture: object

Defined in: src/depth/DepthOptions.ts:31

applyGaussianBlur​

applyGaussianBlur: boolean = false

applyKawaseBlur​

applyKawaseBlur: boolean = false

constantKernel​

constantKernel: boolean = false

enabled​

enabled: boolean = false

depthTypeRequest​

depthTypeRequest: XRDepthType[]

Defined in: src/depth/DepthOptions.ts:41

enabled​

enabled: boolean = false

Defined in: src/depth/DepthOptions.ts:29

matchDepthView​

matchDepthView: boolean = false

Defined in: src/depth/DepthOptions.ts:42

occlusion​

occlusion: object

Defined in: src/depth/DepthOptions.ts:38

enabled​

enabled: boolean = false

usagePreference​

usagePreference: XRDepthUsage[] = []

Defined in: src/depth/DepthOptions.ts:39