xr.docs

XR

XR(props): Element

Core XR component for connecting the XRStore with the scene. Requires an XRStore which it will provide to its children.

props


XRProperties

children

Children to be rendered inside the context.

store

The XRStore to be used for the session.

Returns


Element

packages/react/xr/src/xr.tsx

Edit this page

VRButton
XRButton
  • getting started
  • tutorials
  • advanced
  • handles
  • migration
  • api
    • ARButton
    • CombinedPointer
    • createXRStore
    • DefaultXRController
    • DefaultXRControllerGrabPointer
    • DefaultXRGaze
    • DefaultXRHand
    • DefaultXRHandGrabPointer
    • DefaultXRHandTouchPointer
    • DefaultXRInputSourceRayPointer
    • DefaultXRInputSourceTeleportPointer
    • DefaultXRScreenInput
    • DefaultXRTransientPointer
    • IfFacingCamera
    • IfInSessionMode
    • IfSessionModeSupported
    • IfSessionVisible
    • Interactive
    • NotInXR
    • PointerCursorModel
    • PointerRayModel
    • RayGrab
    • ShowIfFacingCamera
    • ShowIfInSessionMode
    • ShowIfSessionModeSupported
    • ShowIfSessionVisible
    • TeleportTarget
    • UNSAFE_useXRStore
    • useApplyXRSpaceMatrix
    • useGetXRSpaceMatrix
    • useGrabPointer
    • useHover
    • useInitRoomCapture
    • useInteraction
    • useLinesPointer
    • useLoadXRControllerLayout
    • useLoadXRControllerModel
    • usePointerXRInputSourceEvents
    • useRayPointer
    • useRequestXRAnchor
    • useSessionFeatureEnabled
    • useSessionModeSupported
    • useTouchPointer
    • useXR
    • useXRAnchor
    • useXRControllerButtonEvent
    • useXRControllerLocomotion
    • useXRControllerState
    • useXREvent
    • useXRGazeState
    • useXRHandState
    • useXRHitTest
    • useXRHitTestSource
    • useXRInputSourceEvent
    • useXRMeshes
    • useXRMeshGeometry
    • useXRPlaneGeometry
    • useXRPlanes
    • useXRReferenceSpace
    • useXRRequestHitTest
    • useXRScreenInputState
    • useXRSessionFeatureEnabled
    • useXRSessionModeSupported
    • useXRSessionVisibilityState
    • useXRSpace
    • useXRStore
    • useXRTransientPointerState
    • VRButton
    • XR
    • XRButton
    • XRControllerComponent
    • XRControllerModel
    • XRDomOverlay
    • XRHandJoint
    • XRHandModel
    • XRHitTest
    • XRLayer
    • XRMeshModel
    • XROrigin
    • XRPlaneModel
    • XRSpace
    • XRSpaceType

On This Page

props

Returns