Update XR setup instructions in user manual #835
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added XR compatibility requirements and code example.
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates the PlayCanvas React XR documentation to include the critical xrCompatible flag requirement, which was previously missing and causing XR/AR functionality to fail.
Key Changes:
- Added
xrCompatible: trueflag to graphics device options as a prerequisite for XR functionality - Reorganized setup instructions to prioritize XR compatibility configuration
- Added new documentation section explaining the purpose and usage of the
xrCompatibleflag
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| showControls={false} | ||
| > | ||
| <Application> | ||
| <Application graphicsDeviceOptions={{ xrCompatible: true }}> |
Contributor
There was a problem hiding this comment.
Doesn't this already default to true when the engine initializes? I don't need this in Web Components.
Collaborator
Author
There was a problem hiding this comment.
Actually you're right. For some reason I've overridden the engine default to be false
willeastcott
approved these changes
Oct 28, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updated playcanvas/react docs to include the
xrCompatibleflag which was causing XR/AR mode to fail