RenderViewpoint


class RenderViewpoint


Represents a single viewpoint used for rendering, such as a left eye, right eye, or a mono view.

This class provides access to the State of a specific render viewpoint, including its pose, localPose, and fieldOfView.

Summary

Nested types

Class that contains the current state of the render viewpoint.

Public companion functions

RenderViewpoint?
left(session: Session)

Returns the RenderViewpoint associated with the left display.

RenderViewpoint?
mono(session: Session)

Returns the RenderViewpoint associated with the single device display.

RenderViewpoint?
right(session: Session)

Returns the RenderViewpoint associated with the right display.

Public functions

open operator Boolean
equals(other: Any?)
open Int

Public properties

StateFlow<RenderViewpoint.State>

The current State of the render viewpoint.

Extension properties

Flowable<RenderViewpoint.State>

The current State of the Render Viewpoint.

Public companion functions

left

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

Returns the RenderViewpoint 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): RenderViewpoint?

Returns the RenderViewpoint associated with the single device display.

When the device uses a single display, this will return the render viewpoint for that display. When the device uses stereo displays, this will return the render viewpoint 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): RenderViewpoint?

Returns the RenderViewpoint associated with the right display.

Supported only on devices that use stereo displays for rendering.

Parameters
session: Session

the currently active Session.

Public functions

equals

open operator fun equals(other: Any?): Boolean

hashCode

open fun hashCode(): Int

Public properties

state

Added in 1.0.0-alpha06
val stateStateFlow<RenderViewpoint.State>

The current State of the render viewpoint.

Extension properties

val RenderViewpoint.stateAsFlowableFlowable<RenderViewpoint.State>

The current State of the Render Viewpoint.