Improve xr gdnative #49301

BastiaanOlij · 2021-06-04T08:08:41Z

Depends on #48207

This PR adds additional changes to XRInterfaceGDNative and related structures to enable writing XR plugins for Godot 4.

Breaking changes (some of these I'm still working on, some coming from 48207):

Output now based on Vulkan renderer using commit_views
is_stereo was replaced by get_view_count
get_name now has String as parameter, not return value
godot_xr_get_worldscale will be removed (use XRServer)
'godot_xr_get_reference_framewill be removed (useXRServer`)
godot_xr_*_controller* will be removed (use XRPositionalTracker)

Currently deprecated but will be re-introduced in another form:

get_external_texture_for_eye
get_external_depth_for_eye
'commit_for_eye' (maybe, depends on the requirements of the OpenGL backend)

fire · 2021-06-04T15:12:11Z

doc/classes/ProjectSettings.xml

@@ -1593,6 +1593,9 @@
 		<member name="rendering/textures/vram_compression/import_s3tc" type="bool" setter="" getter="" default="true">
 			If [code]true[/code], the texture importer will import VRAM-compressed textures using the S3 Texture Compression algorithm. This algorithm is only supported on desktop platforms and consoles.
 		</member>
+		<member name="rendering/vr/enabled" type="bool" setter="" getter="" default="false">
+			If [code]true[/code], VR support is enabled in Godot, this ensures required shaders are compiled.


Is it VR or XR?

This change comes from #48207, basically this enabled stereoscopic rendering which I guess has a purpose for both AR and VR. Possibly renaming this setting to XR might be more future proof.

BastiaanOlij · 2021-06-08T02:27:34Z

Rebase issues not withstanding, this now does enough for the OpenVR plugin to work. There are a number of shortcuts in place so I'll be prettying up things in the next couple of days.

fire · 2021-06-08T17:22:55Z

I can verify that it works. However, I can see that rendering is not enabled?

https://github.com/GodotVR/godot_openvr/pull/123/files#diff-b8924b2ef5b728671d43c41693816e9cac2d13358f330b0af011522d7939747dR213-R217

void godot_arvr_commit_views(void *p_data, godot_rid *p_render_target, godot_rect2 *p_screen_rect) {

Had to convert Transform to Transform3D. Quat to Quaternion. Some of the GDNative XR interface changed.

BastiaanOlij · 2021-06-08T02:30:28Z

drivers/vulkan/rendering_device_vulkan.cpp

@@ -8318,3 +8328,23 @@ RenderingDeviceVulkan::~RenderingDeviceVulkan() {
 		context->local_device_free(local_device);
 	}
 }
+


@reduz I'm not happy about exposing these this way, but I don't see any other way atm. Open to suggestions. Note that this is purely so we can send this data to the GDNative XR plugin. OpenVR needs this, OpenXR likely as well.

BastiaanOlij · 2021-06-08T02:32:07Z

drivers/vulkan/rendering_device_vulkan.h

@@ -946,6 +946,9 @@ class RenderingDeviceVulkan : public RenderingDevice {
 	virtual Error texture_clear(RID p_texture, const Color &p_color, uint32_t p_base_mipmap, uint32_t p_mipmaps, uint32_t p_base_layer, uint32_t p_layers, uint32_t p_post_barrier = BARRIER_MASK_ALL);
 	virtual Error texture_resolve_multisample(RID p_from_texture, RID p_to_texture, uint32_t p_post_barrier = BARRIER_MASK_ALL);

+	// for now to get access to VkImage
+	virtual void *texture_get_vulkan_image(const RID p_texture);
+


@reduz similarly this one, I need access to VkImage (which is a pointer), I'm casting it to void * so the rest of the engine doesn't need to know. Interestingly enough OpenVR ends up casting it to uint64_t before submitting it to the VR Compositor.

BastiaanOlij · 2021-06-08T02:33:02Z

modules/gdnative/gdnative_api.json

-				"major": 1,
-				"minor": 1
+				"major": 4,
+				"minor": 0


Renumbered this to 4.0, might be better to just name it 2.0, as we're breaking the API to something entirely new for Vulkan anyway it didn't make sense to keep this at 1.1.

BastiaanOlij · 2021-06-08T02:33:52Z

modules/gdnative/include/xr/godot_xr.h

@@ -48,7 +48,7 @@ typedef struct {
 	godot_gdnative_api_version version; /* version of our API */
 	void *(*constructor)(godot_object *);
 	void (*destructor)(void *);
-	godot_string (*get_name)(const void *);
+	void (*get_name)(const void *, godot_string *);
 	godot_int (*get_capabilities)(const void *);


May end up making similar changes in a few other API calls after discussing with @vnen. Seeing string allocates memory this seems to be a safer way to ensure there are no memory leaks.

BastiaanOlij · 2021-06-08T02:35:00Z

modules/gdnative/include/xr/godot_xr.h

 godot_real_t GDAPI godot_xr_get_worldscale();
 godot_transform3d GDAPI godot_xr_get_reference_frame();

-// helper functions for rendering
+// helper functions for rendering (deprecated)


Many of these functions will be removed before I'm done with this.

BastiaanOlij · 2021-06-08T02:35:48Z

modules/gdnative/xr/xr_interface_gdnative.cpp

+	ERR_FAIL_COND_V(interface == nullptr, blit_to_screen);
+
+	// commit_views can do callbacks to `godot_xr_blit_layer` to blit output to screen. This is ignored if this isn't the main view
+	interface->commit_views(data, (void *)&blit_to_screen, (const godot_rid *)&p_render_target, (godot_rect2 *)&p_screen_rect);


Thinking of using a RID for blit_to_screen to enable these callbacks for preview output.

BastiaanOlij · 2021-06-08T02:36:48Z

modules/gdnative/xr/xr_interface_gdnative.cpp

+	const Rect2 *rect = (const Rect2 *)p_rect;
+
+	BlitToScreen blit;
+	blit.render_target = *render_target;


We need to add a source rect option to BlitToScreen, as we're mostly using this for previewing an image on screen that is properly displayed inside of the headset, it's often only part of the image we're showing.

BastiaanOlij · 2021-06-10T01:48:30Z

I can verify that it works. However, I can see that rendering is not enabled?

https://github.com/GodotVR/godot_openvr/pull/123/files#diff-b8924b2ef5b728671d43c41693816e9cac2d13358f330b0af011522d7939747dR213-R217
void godot_arvr_commit_views(void *p_data, godot_rid *p_render_target, godot_rect2 *p_screen_rect) {
Had to convert Transform to Transform3D. Quat to Quaternion. Some of the GDNative XR interface changed.

Yeah did all those but as I was without internet didn't have a chance to push it all in yet. Those are all changes on godot-cpp so also make sure you're on the correct version of that.
These are all brand new renames upstream so.

BastiaanOlij · 2021-06-19T12:03:31Z

#warning TODO check for support via RenderingDevice to enable on mobile when possible
 ^
drivers/vulkan/rendering_device_vulkan.cpp:3250:9: error: cannot initialize return object of type 'void *' with an lvalue of type 'VkImage' (aka 'unsigned long long')
        return tex->image;

So on some implementations VkImage is a *VkImage_t, and on some it's a uint64_t, OpenVR actually works with uint64_t on all platforms so might change the functions to return that instead of void *.

BastiaanOlij · 2021-08-23T12:54:23Z

Leaving this to harvest stuff from, but with GDNative being retired it is being superseeded by #52003

BastiaanOlij · 2021-08-29T05:04:38Z

Now that we've merged the GD Extensions changes I've moved the remaining changes into #52203 and #52205

BastiaanOlij · 2021-08-29T05:08:08Z

Now that we've merged the GD Extensions changes I've moved the remaining changes into

BastiaanOlij self-assigned this Jun 4, 2021

BastiaanOlij added topic:xr breaks compat enhancement labels Jun 4, 2021

BastiaanOlij added this to the 4.0 milestone Jun 4, 2021

BastiaanOlij mentioned this pull request Jun 4, 2021

Add stereoscopic rendering through multiview #48207

Merged

BastiaanOlij force-pushed the improve_xr_gdnative branch from ec7b60a to 35da7c2 Compare June 4, 2021 11:00

fire reviewed Jun 4, 2021

View reviewed changes

BastiaanOlij force-pushed the improve_xr_gdnative branch from 35da7c2 to 89025ff Compare June 8, 2021 02:28

BastiaanOlij force-pushed the improve_xr_gdnative branch from 89025ff to 044ff50 Compare June 10, 2021 01:46

BastiaanOlij commented Jun 10, 2021

View reviewed changes

BastiaanOlij mentioned this pull request Jun 10, 2021

Port to godot 4 GodotVR/godot_openvr#123

Merged

BastiaanOlij force-pushed the improve_xr_gdnative branch 5 times, most recently from 6ffc8a8 to a2dfdb6 Compare June 19, 2021 10:22

Make GDNative XR interface work in Godot 4

afac489

BastiaanOlij force-pushed the improve_xr_gdnative branch from a2dfdb6 to afac489 Compare July 7, 2021 00:31

BastiaanOlij mentioned this pull request Jul 18, 2021

Re-enable building WebXR in GitHub Actions #50563

Merged

BastiaanOlij closed this Aug 29, 2021

BastiaanOlij deleted the improve_xr_gdnative branch August 29, 2021 05:08

akien-mga added the archived label Sep 14, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve xr gdnative #49301

Improve xr gdnative #49301

BastiaanOlij commented Jun 4, 2021 •

edited

Loading

fire Jun 4, 2021

BastiaanOlij Jun 6, 2021 •

edited

Loading

BastiaanOlij commented Jun 8, 2021

fire commented Jun 8, 2021 •

edited

Loading

BastiaanOlij Jun 8, 2021

BastiaanOlij Jun 8, 2021

BastiaanOlij Jun 8, 2021

BastiaanOlij Jun 8, 2021

BastiaanOlij Jun 8, 2021

BastiaanOlij Jun 8, 2021

BastiaanOlij Jun 8, 2021

BastiaanOlij commented Jun 10, 2021

BastiaanOlij commented Jun 19, 2021

BastiaanOlij commented Aug 23, 2021

BastiaanOlij commented Aug 29, 2021

BastiaanOlij commented Aug 29, 2021

Improve xr gdnative #49301

Improve xr gdnative #49301

Conversation

BastiaanOlij commented Jun 4, 2021 • edited Loading

Choose a reason for hiding this comment

BastiaanOlij Jun 6, 2021 • edited Loading

Choose a reason for hiding this comment

BastiaanOlij commented Jun 8, 2021

fire commented Jun 8, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BastiaanOlij commented Jun 10, 2021

BastiaanOlij commented Jun 19, 2021

BastiaanOlij commented Aug 23, 2021

BastiaanOlij commented Aug 29, 2021

BastiaanOlij commented Aug 29, 2021

BastiaanOlij commented Jun 4, 2021 •

edited

Loading

BastiaanOlij Jun 6, 2021 •

edited

Loading

fire commented Jun 8, 2021 •

edited

Loading