Skip to content

Commit

Permalink
fix useXRInputSource docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bbohlender committed Aug 19, 2024
1 parent f451cda commit 55f9ca2
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion docs/getting-started/all-hooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,15 @@ Inputs are a key aspect of react-three/fiber. The following hooks provide access

Hook for listening to xr input source events.

### `useXRInputSourceStateContext`

Hook for getting the XR input source state inside of a component that renders the input source. For example, the `DefaultXRHand` uses this hook to get the state of the hand it renders using `useXRInputSourceStateContext("hand")`.

- `type`: the type that the input source state should have (e.g. `"hand"`)

### `useXRInputSourceState`

Hook for getting the XR controller state.
Hook for getting the XR input source state.

- `type`: the type that the input source state should have (e.g. `"hand"`)
- `handedness`: (optional) the handedness that the XR input source state should have.
Expand Down

0 comments on commit 55f9ca2

Please sign in to comment.