Skip to content

Update OpenXR Settings page for 4.6 #11546

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
skyace65 wants to merge 1 commit into
base: master
Choose a base branch
from
+19 −0
Open

Update OpenXR Settings page for 4.6 #11546

Show file tree
Hide file tree
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
Binary file modified tutorials/xr/img/openxr_eye_gaze_interaction.webp
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified tutorials/xr/img/openxr_settings.webp
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
19 changes: 19 additions & 0 deletions tutorials/xr/openxr_settings.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,6 +236,18 @@ Debug Message Types

This allows you to choose which debug messages are logged.

Frame Synthesis
~~~~~~~~~~~~~~~

When enabled, provided it's supported by the XR runtime, lower resolution motion
vector and depth buffers are rendered and provided to the XR runtime. The XR
runtime can now inject reprojection frames and compensate for lower framerates.

It currently has the following limitations:

- Does NOT work in the Forward+ renderer.
- Only works with stereo rendering.

Hand Tracking
~~~~~~~~~~~~~

Expand Down Expand Up @@ -278,6 +290,13 @@ the user is holding a controller.
If only a hand interaction profile is supplied any runtime should use hand
interaction even if a controller is being held.

Spatial Entity
~~~~~~~~~~~~~~
Comment on lines +293 to +294
Copy link
Member

@AThousandShips AThousandShips Dec 19, 2025

Choose a reason for hiding this comment

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

Suggested change
Spatial Entity
~~~~~~~~~~~~~~
Spatial Entities
~~~~~~~~~~~~~~~~

How it's usually called

Copy link
Contributor Author

@skyace65 skyace65 Dec 19, 2025

Choose a reason for hiding this comment

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

That's how it's named on the settings page, I'd rather keep them consistent.
image

Copy link
Member

@AThousandShips AThousandShips Dec 19, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

But it's inconsistent with other places, the documentation uses "spatial entities", the settings also says "render model" but the entry here and the associated page says "render models", it's weird to me that the section "Spatial Entity" links to the page "spatial entities", also the OpenXR extension name is "spatial entities" not "spatial entity"

Copy link
Contributor Author

@skyace65 skyace65 Dec 19, 2025

Choose a reason for hiding this comment

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

@BastiaanOlij is the actual name of the extension the plural version or the singluar version? Because the Kronos website blog uses plural, but then the spec sheet uses singular (here)

Copy link
Contributor

@BastiaanOlij BastiaanOlij Dec 22, 2025

Choose a reason for hiding this comment

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

Hard one, because we can make arguments for both which is why in this case we see both, even in OpenXRs official documentation.

When we look at a given extension, it's generally named singular. So XR_EXT_spatial_entity, XR_EXT_render_model, XR_EXT_dpad_binding, etc. even though each manages a multitude of objects or items.

However when we look at spatial entities it isn't just the one extension that defines what a single spatial entity looks like. It's a collection of extensions that further detail out how to access different types of spatial entities.
As a system, plural makes more sense imho.


This extension and its settings are used to obtain and interacting with
Copy link
Member

@AThousandShips AThousandShips Dec 19, 2025

Choose a reason for hiding this comment

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

Suggested change
This extension and its settings are used to obtain and interacting with
This extension and its settings are used to obtain and interact with

information about the user's real world environment. You can find more detailed
information on how it works on the :ref:`spatial entities page <doc_openxr_spatial_entities>`.

Eye Gaze Interaction
~~~~~~~~~~~~~~~~~~~~

Expand Down
Loading