Add documentation about OpenXR spatial entities #11015

BastiaanOlij · 2025-06-11T06:14:11Z

This PR adds documentation for the spatial entities implementation being added here: godotengine/godot#107391

JD-The-65th

I noticed a few grammatical issues and typos so I wanted to make a review addressing some of them. I saw that it was also a commonality in this PR to omit commas after dependent clauses, so I left in 2 cases where I noticed it occurred, but I can go back and mark more where I noticed them.

tutorials/xr/openxr_spatial_entities.rst

AThousandShips

Will do a pass to improve sentence structure as well later

tutorials/xr/openxr_spatial_entities.rst

BastiaanOlij · 2025-07-16T01:17:10Z

Thanks for the feedback everyone, just to let you all know, I'm planning on updating this PR after we're certain about the API on the implementation PR just to minimize having to go back and forth on those changes. Will be updating this PR soonish

BastiaanOlij · 2025-08-06T05:56:49Z

tutorials/xr/openxr_spatial_entities.rst

+
+
+    **
+        Q : Should we be doing update queries here to get position changes for markers??


Mostly a reminder to myself, I need to add this in. We now do this in the built-in logic as well.

Is this still something you plan to add? Or, should this be removed at this point?

BastiaanOlij · 2025-08-06T05:57:31Z

I think I covered all the comments, only some outstanding stuff around parameter naming which remains a problem.

Also need to find some time to add update queries to the marker example.

AThousandShips

Some suggestions for breaking up the sentences, can look at more cases later

tutorials/xr/openxr_spatial_entities.rst

Repiteo · 2025-09-29T14:50:34Z

The source PR has since been merged, so this should be prioritized once the style changes are accounted for

AThousandShips

I believe it looks good now

tutorials/xr/openxr_spatial_entities.rst

BastiaanOlij · 2025-10-01T10:57:55Z

Not entirely sure why its not finding some things in the class definitions because those classes should be registered. Unless I'm overlooking a typo or mistake in the references?

dsnopek

Thanks, this looks great!

Only have a bunch of minor notes about type-o's, making some bits a little clearer, and what-not

dsnopek · 2025-10-16T20:23:05Z

tutorials/xr/openxr_spatial_entities.rst

+It has a very modular design. The core of the API defines how real world entities are structured,
+how they are found, and how information about them is stored and accessed.
+
+Various extensions are added on top that implement specific systems such as marker tracking,


Suggested change

Various extensions are added on top that implement specific systems such as marker tracking,

Various extensions are added on top that to implement specific systems such as marker tracking,

dsnopek · 2025-10-16T20:24:09Z

tutorials/xr/openxr_spatial_entities.rst

+   * - Enable persistent anchors
+     - Enables the ability to make spatial anchors persistent. This means that their location is stored
+       and can be retrieved in subsequent sessions.
+   * - Enabled built-in anchor detection


Suggested change

* - Enabled built-in anchor detection

* - Enable built-in anchor detection

dsnopek · 2025-10-16T20:27:05Z

tutorials/xr/openxr_spatial_entities.rst

+
+    # See if this tracker should be managed by us and add it.
+    func _add_tracker(tracker: OpenXRSpatialEntityTracker):
+        var new_node : XRAnchor3D


I think we use the style without a space before the colon in the docs (but I'm not 100% sure about that):

Suggested change

var new_node : XRAnchor3D

var new_node: XRAnchor3D

dsnopek · 2025-10-16T20:27:32Z

tutorials/xr/openxr_spatial_entities.rst

+    # A new tracker was added to our XRServer.
+    func _on_tracker_added(tracker_name: StringName, type: int):
+        if type == XRServer.TRACKER_ANCHOR:
+            var tracker : XRTracker = XRServer.get_tracker(tracker_name)


Suggested change

var tracker : XRTracker = XRServer.get_tracker(tracker_name)

var tracker: XRTracker = XRServer.get_tracker(tracker_name)

dsnopek · 2025-10-16T20:27:42Z

tutorials/xr/openxr_spatial_entities.rst

+    # A tracker was removed from our XRServer.
+    func _on_tracker_removed(tracker_name: StringName, type: int):
+        if type == XRServer.TRACKER_ANCHOR:
+            var tracker : XRTracker = XRServer.get_tracker(tracker_name)


Suggested change

var tracker : XRTracker = XRServer.get_tracker(tracker_name)

var tracker: XRTracker = XRServer.get_tracker(tracker_name)

dsnopek · 2025-10-16T20:42:31Z

tutorials/xr/openxr_spatial_entities.rst

+It's up to your use case how best to link the marker data to the scene that needs to be loaded.
+An example would be to encode the name of the asset you wish to display in a QR code.
+
+**Maybe see if we can work out at least one example here, need access to hardware that supports this, should have that soon**


This looks like a TODO: are you still planning to add something here? Or, should this note just be removed?

dsnopek · 2025-10-16T20:43:15Z

tutorials/xr/openxr_spatial_entities.rst

+For most purposes the core system, along with any vendor extensions, should be what most
+users would use as provided.
+
+For those who are implementing vendor extensions, or those for who the built-in logic doesn't


Suggested change

For those who are implementing vendor extensions, or those for who the built-in logic doesn't

For those who are implementing vendor extensions, or those for whom the built-in logic doesn't

dsnopek · 2025-10-16T20:44:51Z

tutorials/xr/openxr_spatial_entities.rst

+
+    extends Node
+
+    var spatial_context : RID


I think I'm going to stop pointing these out. They can all be grep'd for and there's also the possibility that the docs style doesn't mandate this anyway :-)

Suggested change

var spatial_context : RID

var spatial_context: RID

dsnopek · 2025-10-16T20:49:54Z

tutorials/xr/openxr_spatial_entities.rst

+are different between your discovery snapshot and your update snapshot, you have to take that you query
+different components into account.


I think some words got jumbled in this text: "you have to take that you query different components into account"

dsnopek · 2025-10-16T20:55:39Z

tutorials/xr/openxr_spatial_entities.rst

+
+
+    **
+        Q : Should we be doing update queries here to get position changes for markers??


Is this still something you plan to add? Or, should this be removed at this point?

BastiaanOlij added this to the 4.x milestone Jun 11, 2025

BastiaanOlij self-assigned this Jun 11, 2025

BastiaanOlij added enhancement topic:xr Related to XR documentation labels Jun 11, 2025

BastiaanOlij mentioned this pull request Jun 11, 2025

OpenXR: Add support for spatial entities extension godotengine/godot#107391

Merged

AThousandShips added the waiting on pr merge PRs that can't be merged until an engine PR is merged first label Jun 11, 2025

JD-The-65th suggested changes Jun 11, 2025

View reviewed changes

AThousandShips removed this from the 4.x milestone Jun 12, 2025

AThousandShips reviewed Jun 24, 2025

View reviewed changes

BastiaanOlij force-pushed the openxr_spatial_entities_docs branch 7 times, most recently from a5b0b4a to 4edb00e Compare August 6, 2025 05:56

BastiaanOlij commented Aug 6, 2025

View reviewed changes

AThousandShips reviewed Aug 7, 2025

View reviewed changes

BastiaanOlij force-pushed the openxr_spatial_entities_docs branch 2 times, most recently from e0bca81 to 73c533b Compare August 29, 2025 02:58

BastiaanOlij force-pushed the openxr_spatial_entities_docs branch from 73c533b to b04e6b1 Compare September 29, 2025 09:25

Repiteo removed the waiting on pr merge PRs that can't be merged until an engine PR is merged first label Sep 29, 2025

AThousandShips approved these changes Sep 30, 2025

View reviewed changes

BastiaanOlij force-pushed the openxr_spatial_entities_docs branch 3 times, most recently from 3f59079 to dcbf8f6 Compare October 1, 2025 10:53

skyace65 added this to the 4.6 milestone Oct 11, 2025

BastiaanOlij force-pushed the openxr_spatial_entities_docs branch from dcbf8f6 to c2523fc Compare October 13, 2025 00:17

Add documentation about OpenXR spatial entities

71ba12c

BastiaanOlij force-pushed the openxr_spatial_entities_docs branch from c2523fc to 71ba12c Compare October 13, 2025 00:37

dsnopek reviewed Oct 16, 2025

View reviewed changes



		**
		Q : Should we be doing update queries here to get position changes for markers??

	Various extensions are added on top that implement specific systems such as marker tracking,
	Various extensions are added on top that to implement specific systems such as marker tracking,

	* - Enabled built-in anchor detection
	* - Enable built-in anchor detection

	var tracker : XRTracker = XRServer.get_tracker(tracker_name)
	var tracker: XRTracker = XRServer.get_tracker(tracker_name)

	For those who are implementing vendor extensions, or those for who the built-in logic doesn't
	For those who are implementing vendor extensions, or those for whom the built-in logic doesn't

		are different between your discovery snapshot and your update snapshot, you have to take that you query
		different components into account.

Uh oh!

Add documentation about OpenXR spatial entities #11015

Are you sure you want to change the base?

Add documentation about OpenXR spatial entities #11015

Conversation

BastiaanOlij commented Jun 11, 2025

Uh oh!

JD-The-65th left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

AThousandShips left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

BastiaanOlij commented Jul 16, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

BastiaanOlij commented Aug 6, 2025

Uh oh!

AThousandShips left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Repiteo commented Sep 29, 2025

Uh oh!

AThousandShips left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

BastiaanOlij commented Oct 1, 2025

Uh oh!

dsnopek left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment