Skip to content

Update XR setup instructions in user manual #835

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update XR setup instructions in user manual #835

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 18 additions & 6 deletions docs/user-manual/playcanvas-react/guide/xr.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,23 @@ PlayCanvas React makes it easy to add Virtual Reality (VR) and Augmented Reality

To enable XR support in your React application, you'll need:

1. **XR Scripts** - Import the XR controller and navigation scripts from the PlayCanvas engine package
2. **Camera Setup** - Configure your camera entity with XR scripts attached
3. **XR Controls** - Add UI buttons to enter and exit XR sessions (WebXR requires user interaction)
4. **Secure Context** - Serve your app over HTTPS (or `localhost` during development)
1. **XR-Compatible Graphics Device** - Enable the `xrCompatible` flag when creating your application
2. **XR Scripts** - Import the XR controller and navigation scripts from the PlayCanvas engine package
3. **Camera Setup** - Configure your camera entity with XR scripts attached
4. **XR Controls** - Add UI buttons to enter and exit XR sessions (WebXR requires user interaction)
5. **Secure Context** - Serve your app over HTTPS (or `localhost` during development)

### Enable XR Compatibility

First, ensure your application's graphics device is XR-compatible by setting the `xrCompatible` flag:

```tsx
<Application graphicsDeviceOptions={{ xrCompatible: true }}>
{/* Your XR content */}
</Application>
```

This tells the browser to create a WebGL context that's compatible with WebXR. Without this flag, XR features won't work.

## XR Scripts

Expand Down Expand Up @@ -81,7 +94,7 @@ Here's a complete example with XR support, including buttons to enter AR/VR mode
showDemo
showControls={false}
>
<Application>
<Application graphicsDeviceOptions={{ xrCompatible: true }}>
Copy link
Contributor

@willeastcott willeastcott Oct 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doesn't this already default to true when the engine initializes? I don't need this in Web Components.

Copy link
Collaborator Author

@marklundin marklundin Oct 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually you're right. For some reason I've overridden the engine default to be false

<Staging useGrid useLight camera={[3, 2, 3]}>
<XrExample />
</Staging>
Expand All @@ -90,7 +103,6 @@ Here's a complete example with XR support, including buttons to enter AR/VR mode

:::tip

- Press **Escape** to exit an active XR session
- XR availability depends on your device and browser support
- Use a VR headset or AR-capable mobile device to test the full experience
- During development, Chrome and Edge support WebXR emulation via DevTools
Expand Down