class DepthMap

Contains the depth map information corresponding to a specific RenderViewpoint

Summary

Nested types

Contains the current state of depth tracking

Public companion functions
DepthMap?
left(session: Session)

Returns the DepthMap associated with the left display.
DepthMap?
mono(session: Session)

Returns the DepthMap associated with the single device display.
DepthMap?
right(session: Session)

Returns the DepthMap associated with the right display.

Public properties
StateFlow<DepthMap.State>

The current State of the depth map.

Public companion functions

left

Added in 1.0.0-alpha06
fun left(session: Session): DepthMap?

Returns the DepthMap associated with the left display.

Supported only on devices that use stereo displays for rendering.

Parameters
session: Session

the currently active Session.

mono

Added in 1.0.0-alpha06
fun mono(session: Session): DepthMap?

Returns the DepthMap associated with the single device display.

When the device uses a single display, this will return the depth map for that display. When the device uses stereo displays, this will return the depth map for the center of the two displays.

Parameters
session: Session

the currently active Session.

right

Added in 1.0.0-alpha06
fun right(session: Session): DepthMap?

Returns the DepthMap associated with the right display.

Supported only on devices that use stereo displays for rendering.

Parameters
session: Session

the currently active Session.

Public properties

state

Added in 1.0.0-alpha06
val state: StateFlow<DepthMap.State>

The current State of the depth map.