Update the passthrough documentation to reflect the changes in Godot 4.3 #9311
Conversation
BastiaanOlij
added
enhancement
topic:xr
|
Ok added the chapter |
BastiaanOlij
force-pushed
the
update_ar_passthrough
branch
from
ab56dc0
to
c97281c
Compare
|
@DanielSnd any chance you have a screengrab of your AR project we can use to show the use of shadow to opacity? |
BastiaanOlij
force-pushed
the
update_ar_passthrough
branch
2 times, most recently
from
38f164c
to
b6071aa
Compare
I can take one with a "on/off" comparison. |
Yup, but I didn't know how to do that so some advise here is welcome :) |
BastiaanOlij
force-pushed
the
update_ar_passthrough
branch
from
b6071aa
to
5152822
Compare
|
Still todo before this can be merged:
|
Took a few screenshots today, are those good? I can try taking it differently if you have something specific in mind. |
BastiaanOlij
force-pushed
the
update_ar_passthrough
branch
from
5152822
to
a68d8de
Compare
|
Thanks @DanielSnd , I added the middle one in. The hand is really cool but I think its harder to see what is going on. Just with the desk in front of the pitstop while there are some aliens standing on the desks... Shame we didn't have shadows working properly yet :) |
BastiaanOlij
force-pushed
the
update_ar_passthrough
branch
3 times, most recently
from
8c3da9e
to
f4741bb
Compare
|
Ok, also added the redirect, I don't know if I did this right or how to test it, but it's in there :) |
BastiaanOlij
force-pushed
the
update_ar_passthrough
branch
from
f4741bb
to
91294f7
Compare
|
|
||
| Augmented Reality is supported through various methods depending on the capabilities of the hardware. | ||
|
|
||
| Headsets such as the Magic Leap and glasses such as TiltFive show the rendered result on transparent displays |
There was a problem hiding this comment.
We can add that the technique is usually referred to as [see-through] (https://en.wikipedia.org/wiki/See-through_display).
| - The rendered image is added to the real world. This mode generally applies to AR only devices | ||
| such as the Hololens where the optics are not able to obscure the real world. | ||
| This will turn on passthrough if passthrough is used. | ||
| * - XR_ENV_BLEND_MODE_ALPHA_BLEND | ||
| - The rendered image is alpha blended with the real world. | ||
| This is supported on devices that can fully obscure the real world | ||
| and generally the preferred way to do AR. |
There was a problem hiding this comment.
Following up on my comment about terminology confusion, the use of AR only devices and AR throughout can get confusing to developers new with the apis, capabilities.
My suggestion would be that we use the terms see-through devices to refer to devices like Magic Leap, Hololens, and video passthrough devices to refer to devices like Quest, HTC Elite; unless OpenXR has another term for how to refer to either types of devices.
| This is supported on devices that can fully obscure the real world | ||
| and generally the preferred way to do AR. |
There was a problem hiding this comment.
The sentence is a bit confusing; the first section states This is supported on devices that can fully obscure the real world leading to the assumption it's only supported on video-passthrough devices.
But the second section asserts this is generally the preferred way to do AR, leading to the assumption it can be used on both types of devices.
| It is advisable to do the same with ``XR_ENV_BLEND_MODE_ADDITIVE`` however here you | ||
| can alternatively set your background color to black. |
There was a problem hiding this comment.
This seems to assume that XR_ENV_BLEND_MODE_ADDITIVE is only used on see-through devices (otherwise setting the background color to black would hide the real world on video-passthrough devices) but we don't mention it so in the section above.
| Some AR SDKs do provide ambient lighting information or even provide a full radiance | ||
| map to allow for real world reflections in your virtual objects. | ||
| The core Godot XR functionality doesn't currently have support for this, however this | ||
| functionality can be exposed through plugins. |
There was a problem hiding this comment.
Note sure if this is relevant to this documentation.
|
|
||
| .. note:: | ||
|
|
||
| The way specifically passthrough is implemented has vast differences between different platforms. |
There was a problem hiding this comment.
| The way specifically passthrough is implemented has vast differences between different platforms. | |
| Passthrough is implemented very differently across platforms. |
| Shadow to opacity is a render mode for Godot spatial shaders | ||
| that was introduced in Godot 3 specifically for the AR use case. |
There was a problem hiding this comment.
| Shadow to opacity is a render mode for Godot spatial shaders | |
| that was introduced in Godot 3 specifically for the AR use case. | |
| Shadow to opacity is a render mode for Godot spatial shaders | |
| that was introduced in Godot 3 specifically for AR. |
We had some major changes in the way we handle AR and passthrough in Godot 4.3, this PR updates the documentation to reflect this.
The page has also been changes from an OpenXR centric page to more core focussed documentation. I don't know if there is a way once this becomes stable that it redirect the old page to the new?