WebXRDepthSensing | Babylon.js API documentation

Class WebXRDepthSensing

WebXR Feature for WebXR Depth Sensing Module

Since

5.49.1

Hierarchy (View Summary)

WebXRAbstractFeature
- WebXRDepthSensing

Constructors

constructor

new WebXRDepthSensing(
_xrSessionManager: WebXRSessionManager,
options: IWebXRDepthSensingOptions,
): WebXRDepthSensing
Creates a new instance of the depth sensing feature
Parameters
- _xrSessionManager: WebXRSessionManager
  the WebXRSessionManager
- options: IWebXRDepthSensingOptions
  options for WebXR Depth Sensing Feature
Returns WebXRDepthSensing
Overrides WebXRAbstractFeature.constructor
- Defined in .temp/typedoc/docdirectory/doc.d.ts:9577

Properties

`Optional`dependsOn

dependsOn?: string[]

The dependencies of this feature, if any

disableAutoAttach

disableAutoAttach: boolean

Should auto-attach be disabled?

isDisposed

isDisposed: boolean

Is this feature disposed?

onFeatureAttachObservable

onFeatureAttachObservable: Observable<IWebXRFeature>

Observers registered here will be executed when the feature is attached

onFeatureDetachObservable

onFeatureDetachObservable: Observable<IWebXRFeature>

Observers registered here will be executed when the feature is detached

onGetDepthInMetersAvailable

onGetDepthInMetersAvailable: Observable<GetDepthInMetersType>

Event that notify when DepthInformation.getDepthInMeters is available. getDepthInMeters method needs active XRFrame (not available for cached XRFrame)

`Readonly`options

options: IWebXRDepthSensingOptions

`Static` `Readonly`Name

Name: "xr-depth-sensing"

The module's name

`Static` `Readonly`Version

Version: 1

The (Babylon) version of this module. This is an integer representing the implementation version. This number does not correspond to the WebXR specs version

Accessors

attached

get attached(): boolean
Is this feature attached

Returns boolean
Inherited from WebXRAbstractFeature.attached
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10866

depthDataFormat

get depthDataFormat(): WebXRDepthDataFormat
Describes which depth sensing data format ("ushort" or "float") is used.

Returns WebXRDepthDataFormat
- Defined in .temp/typedoc/docdirectory/doc.d.ts:9538

depthUsage

get depthUsage(): WebXRDepthUsage
Describes which depth-sensing usage ("cpu" or "gpu") is used.

Returns WebXRDepthUsage
- Defined in .temp/typedoc/docdirectory/doc.d.ts:9534

height

get height(): Nullable<number>
Height of depth data. If depth data is not exist, returns null.

Returns Nullable<number>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:9522

latestDepthBuffer

get latestDepthBuffer(): Nullable<ArrayBufferView>
cached depth buffer

Returns Nullable<ArrayBufferView>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:9548

latestDepthImageTexture

get latestDepthImageTexture(): Nullable<RawTexture>
Latest cached Texture of depth image which is made from the depth buffer data.

Returns Nullable<RawTexture>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:9557

latestInternalTexture

get latestInternalTexture(): Nullable<InternalTexture>
Latest cached InternalTexture which containing depth buffer information. This can be used when the depth usage is "gpu".

Returns Nullable<InternalTexture>
Deprecated
This will be removed in the future. Use latestDepthImageTexture
- Defined in .temp/typedoc/docdirectory/doc.d.ts:9544

normDepthBufferFromNormView

get normDepthBufferFromNormView(): Nullable<XRRigidTransform>
An XRRigidTransform that needs to be applied when indexing into the depth buffer.

Returns Nullable<XRRigidTransform>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:9530

rawValueToMeters

get rawValueToMeters(): Nullable<number>
Scale factor by which the raw depth values must be multiplied in order to get the depths in meters.

Returns Nullable<number>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:9526

width

get width(): Nullable<number>
Width of depth data. If depth data is not exist, returns null.

Returns Nullable<number>
- Defined in .temp/typedoc/docdirectory/doc.d.ts:9518

xrNativeFeatureName

get xrNativeFeatureName(): string
The name of the native xr feature name (like anchor, hit-test, or hand-tracking)

Returns string
Inherited from WebXRAbstractFeature.xrNativeFeatureName
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10844
set xrNativeFeatureName(name: string): void
The name of the native xr feature name, if applicable (like anchor, hit-test, or hand-tracking)
Parameters
- name: string
Returns void
Inherited from WebXRAbstractFeature.xrNativeFeatureName
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10845

Methods

attach

attach(force?: boolean): boolean
attach this feature Will usually be called by the features manager
Parameters
- Optionalforce: boolean
  should attachment be forced (even when already attached)
Returns boolean
true if successful.
Overrides WebXRAbstractFeature.attach
- Defined in .temp/typedoc/docdirectory/doc.d.ts:9584

detach

detach(): boolean
detach this feature.

Returns boolean
true if successful, false if failed or already detached
Overrides WebXRAbstractFeature.detach
- Defined in .temp/typedoc/docdirectory/doc.d.ts:9585

dispose

dispose(): void
Dispose this feature and all of the resources attached

Returns void
Overrides WebXRAbstractFeature.dispose
- Defined in .temp/typedoc/docdirectory/doc.d.ts:9589

getXRSessionInitExtension

getXRSessionInitExtension(): Promise<Partial<XRSessionInit>>
Extends the session init object if needed

Returns Promise<Partial<XRSessionInit>>
augmentation object for the xr session init object.
- Defined in .temp/typedoc/docdirectory/doc.d.ts:9597

isCompatible

isCompatible(): boolean
This function will be executed during before enabling the feature and can be used to not-allow enabling it. Note that at this point the session has NOT started, so this is purely checking if the browser supports it

Returns boolean
whether or not the feature is compatible in this environment
Inherited from WebXRAbstractFeature.isCompatible
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10890

Class WebXRDepthSensing

Since

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns WebXRDepthSensing

Properties

OptionaldependsOn

disableAutoAttach

isDisposed

onFeatureAttachObservable

onFeatureDetachObservable

onGetDepthInMetersAvailable

Readonlyoptions

Static ReadonlyName

Static ReadonlyVersion

Accessors

attached

Returns boolean

depthDataFormat

Returns WebXRDepthDataFormat

depthUsage

Returns WebXRDepthUsage

height

Returns Nullable<number>

latestDepthBuffer

Returns Nullable<ArrayBufferView>

latestDepthImageTexture

Returns Nullable<RawTexture>

latestInternalTexture

Returns Nullable<InternalTexture>

Deprecated

normDepthBufferFromNormView

Returns Nullable<XRRigidTransform>

rawValueToMeters

Returns Nullable<number>

width

Returns Nullable<number>

xrNativeFeatureName

Returns string

Parameters

Returns void

Methods

attach

Parameters

Returns boolean

detach

Returns boolean

dispose

Returns void

getXRSessionInitExtension

Returns Promise<Partial<XRSessionInit>>

isCompatible

Returns boolean

Settings

On This Page

`Optional`dependsOn

`Readonly`options

`Static` `Readonly`Name

`Static` `Readonly`Version