All Hooks

Hook for reading the state from the XR store.

Hook for getting the XR store from the context.

Hook for getting the function to initialize the room capture for scanning the room.

Hook for checking if a session mode is supported.

• onError: callback executed when an error happens while checking if the session mode is supported.

Hook for getting the session visibility state.

Hook for creating a hit test source originating from the provided object or xr space.

Hook that allows to set up a continous hit test originating from the provided object or xr space.

Hook that returns a function to request a single hit test.

Hook that returns a function that allows to request a xr anchor.

Hook for requesting and storing a single xr anchor.

@react-three/xr provides several hooks to synchronize the space provided by WebXR with the scene.

Hook for retrieving the XR reference space from the context.

Hook that applies the transformation of the provided XR space to the provided object reference.

• onFrame: optional callback that gets executed after the matrix of the reference object is updated.
• Requires that matrixAutoUpdate is disabled for the referenced object.

Hook that returns a function to compute a matrix that contains the transformation of the provided XR space.

Hook for creating a touch pointer.

Hook for creating a grab pointer.

Hook for creating a ray pointer.

Hook for binding the XR session events such as selectstart to the provided pointer down/up events.

Hook for listening to xr input source events.

Building custom inputs requires access and bindings to the events. The following hook allow to access the inputs state and bind function to events.

Hook for subscribing to a button state change event on the controller.

• id: ID of the button.
• onChange: callback that gets executed when the state of the button changes.
• handedness: handedness of the controller.

Hook for getting the XR controller state.

• handedness: (optional) the handedness that the XR controller state should have.

Hook for getting the gaze state.

Hook for getting the XR hand state.

• handedness: (optional) the handedness that the XR hand state should have.

Hook for getting the transient-pointer state.

• handedness: (optional) the handedness that the XR transient pointer state should have.

Hook for getting the screen-input state.

@react-three/xr exposes WebXR's object detection capabilities for meshes and planes. The following functions allow to access these WebXR primitives inside of the components responsible for rendering these detected object and retrieving their geometry.

Hook for getting the detected mesh in the current context.

Hook for getting the geometry from the detected mesh.

• mesh: the detected mesh.
• disposeBuffer: allows to disable auto disposing the geometry buffer.

Hook for getting all detected meshes with the provided semantic label.

Hook for getting the detected plane in the current context.

Hook for getting the geometry from the detected plane.

• plane: the detected plane.
• disposeBuffer: allows to disable auto disposing the geometry buffer.

Hook for getting all detected planes with the provided semantic label.