Class XRRenderPipeline

XR渲染管线

Export

Date

2025.10.11

Author

lyx

Hierarchy

  • RenderPipeline
    • XRRenderPipeline

Constructors

constructor

Properties

_sceneRenderer

Accessors

camera originalReferenceSpace referenceSpace

Methods

dispose enterAR enterVR exit getGripInput getHandInput getTargetRayInput renderScene requestHitText requestTransientHitTest isARAvailable isVRAvailable

Constructors

constructor

Properties

Protected _sceneRenderer

_sceneRenderer: SceneRenderer

Accessors

camera

  • get camera(): WebXRArrayCamera

  • 获取WebXR相机

    Returns WebXRArrayCamera

    Memberof

    XRRenderPipeline

originalReferenceSpace

  • get originalReferenceSpace(): XRReferenceSpace

  • 获取原始关联空间

    Returns XRReferenceSpace

    Memberof

    XRRenderPipeline

referenceSpace

  • get referenceSpace(): XRReferenceSpace

  • 获取关联空间

    Returns XRReferenceSpace

    Memberof

    XRRenderPipeline

Methods

dispose

  • 销毁渲染管线（注：内部方法切勿主动调用）

    Returns void

    Memberof

    XRRenderPipeline

enterAR

  • 进入AR模式

    Parameters

    Returns Promise<void>

    {Promise}

    Memberof

    XRRenderPipeline

enterVR

  • 进入VR模式

    Parameters

    Returns Promise<void>

    {Promise}

    Memberof

    XRRenderPipeline

exit

  • 退出AR/VR模式

    Returns Promise<void>

    {Promise}

    Memberof

    XRRenderPipeline

getGripInput

  • 获取Grip类型输入

    Parameters

    • index: number

      输入索引（注：通常0对应左手，1对应右手）

    Returns XRGripInput

    Memberof

    XRRenderPipeline

getHandInput

  • 获取Hand类型输入

    Parameters

    • index: number

      输入索引（注：通常0对应左手，1对应右手）

    Returns XRHandInput

    Memberof

    XRRenderPipeline

getTargetRayInput

  • 获取TargetRay类型输入

    Parameters

    • index: number

      输入索引（注：通常0对应左手，1对应右手）

    Returns XRTargetRayInput

    Memberof

    XRRenderPipeline

renderScene

  • 手动渲染场景

    Parameters

    • Optional timeSinceLastFrame: number

      距离上一帧的更新时长（单位：毫秒）

    • Optional renderTaget: WebGLRenderTarget<Texture>

      渲染目标，默认null

    Returns void

    Memberof

    XRRenderPipeline

requestHitText

  • 请求HitTest

    Parameters

    • Optional referenceSpaceType: XRReferenceSpaceType = 'viewer'

      检测空间

    Returns Promise<HitTest>

    {Promise}

    Memberof

    XRRenderPipeline

requestTransientHitTest

  • 请求Transient类型HitTest

    Parameters

    • profile: string

    Returns HitTest

    Memberof

    XRRenderPipeline

Static isARAvailable

  • 判断是否支持AR

    Returns Promise<boolean>

    {Promise}

    Static

    Memberof

    XRRenderPipeline

Static isVRAvailable

  • 判断是否支持VR

    Returns Promise<boolean>

    {Promise}

    Static

    Memberof

    XRRenderPipeline

Settings

Member Visibility

Theme

On This Page