You've already forked godot
mirror of
https://github.com/godotengine/godot.git
synced 2025-12-01 16:38:31 +00:00
1cb4ada316
OpenXR: Fix Vulkan validation errors and get `XR_META_foveation_eye_tracked` working on Meta Quest devices
281 lines
11 KiB
C++
281 lines
11 KiB
C++
/**************************************************************************/
|
|
/* openxr_fb_foveation_extension.cpp */
|
|
/**************************************************************************/
|
|
/* This file is part of: */
|
|
/* GODOT ENGINE */
|
|
/* https://godotengine.org */
|
|
/**************************************************************************/
|
|
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
|
|
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
|
|
/* */
|
|
/* Permission is hereby granted, free of charge, to any person obtaining */
|
|
/* a copy of this software and associated documentation files (the */
|
|
/* "Software"), to deal in the Software without restriction, including */
|
|
/* without limitation the rights to use, copy, modify, merge, publish, */
|
|
/* distribute, sublicense, and/or sell copies of the Software, and to */
|
|
/* permit persons to whom the Software is furnished to do so, subject to */
|
|
/* the following conditions: */
|
|
/* */
|
|
/* The above copyright notice and this permission notice shall be */
|
|
/* included in all copies or substantial portions of the Software. */
|
|
/* */
|
|
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
|
|
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
|
|
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
|
|
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
|
|
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
|
|
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
|
|
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
|
|
/**************************************************************************/
|
|
|
|
#include "openxr_fb_foveation_extension.h"
|
|
#include "core/config/project_settings.h"
|
|
#include "openxr_eye_gaze_interaction.h"
|
|
|
|
#include "../openxr_platform_inc.h"
|
|
|
|
OpenXRFBFoveationExtension *OpenXRFBFoveationExtension::singleton = nullptr;
|
|
|
|
OpenXRFBFoveationExtension *OpenXRFBFoveationExtension::get_singleton() {
|
|
return singleton;
|
|
}
|
|
|
|
OpenXRFBFoveationExtension::OpenXRFBFoveationExtension(const String &p_rendering_driver) {
|
|
singleton = this;
|
|
rendering_driver = p_rendering_driver;
|
|
swapchain_update_state_ext = OpenXRFBUpdateSwapchainExtension::get_singleton();
|
|
int fov_level = GLOBAL_GET("xr/openxr/foveation_level");
|
|
if (fov_level >= 0 && fov_level < 4) {
|
|
foveation_level = XrFoveationLevelFB(fov_level);
|
|
}
|
|
bool fov_dyn = GLOBAL_GET("xr/openxr/foveation_dynamic");
|
|
foveation_dynamic = fov_dyn ? XR_FOVEATION_DYNAMIC_LEVEL_ENABLED_FB : XR_FOVEATION_DYNAMIC_DISABLED_FB;
|
|
|
|
swapchain_create_info_foveation_fb.type = XR_TYPE_SWAPCHAIN_CREATE_INFO_FOVEATION_FB;
|
|
swapchain_create_info_foveation_fb.next = nullptr;
|
|
swapchain_create_info_foveation_fb.flags = 0;
|
|
|
|
meta_foveation_eye_tracked_create_info.type = XR_TYPE_FOVEATION_EYE_TRACKED_PROFILE_CREATE_INFO_META;
|
|
meta_foveation_eye_tracked_create_info.next = nullptr;
|
|
meta_foveation_eye_tracked_create_info.flags = 0;
|
|
|
|
meta_foveation_eye_tracked_properties.type = XR_TYPE_SYSTEM_FOVEATION_EYE_TRACKED_PROPERTIES_META;
|
|
meta_foveation_eye_tracked_properties.next = nullptr;
|
|
meta_foveation_eye_tracked_properties.supportsFoveationEyeTracked = XR_FALSE;
|
|
|
|
meta_vulkan_swapchain_create_info.type = XR_TYPE_VULKAN_SWAPCHAIN_CREATE_INFO_META;
|
|
meta_vulkan_swapchain_create_info.next = nullptr;
|
|
meta_vulkan_swapchain_create_info.additionalCreateFlags = VK_IMAGE_CREATE_FRAGMENT_DENSITY_MAP_OFFSET_BIT_QCOM;
|
|
meta_vulkan_swapchain_create_info.additionalUsageFlags = 0;
|
|
|
|
if (rendering_driver == "opengl3") {
|
|
swapchain_create_info_foveation_fb.flags = XR_SWAPCHAIN_CREATE_FOVEATION_SCALED_BIN_BIT_FB;
|
|
} else if (rendering_driver == "vulkan") {
|
|
swapchain_create_info_foveation_fb.flags = XR_SWAPCHAIN_CREATE_FOVEATION_FRAGMENT_DENSITY_MAP_BIT_FB;
|
|
}
|
|
}
|
|
|
|
OpenXRFBFoveationExtension::~OpenXRFBFoveationExtension() {
|
|
singleton = nullptr;
|
|
swapchain_update_state_ext = nullptr;
|
|
}
|
|
|
|
HashMap<String, bool *> OpenXRFBFoveationExtension::get_requested_extensions(XrVersion p_version) {
|
|
HashMap<String, bool *> request_extensions;
|
|
|
|
request_extensions[XR_FB_FOVEATION_EXTENSION_NAME] = &fb_foveation_ext;
|
|
request_extensions[XR_FB_FOVEATION_CONFIGURATION_EXTENSION_NAME] = &fb_foveation_configuration_ext;
|
|
|
|
#ifdef XR_USE_GRAPHICS_API_VULKAN
|
|
if (rendering_driver == "vulkan") {
|
|
request_extensions[XR_FB_FOVEATION_VULKAN_EXTENSION_NAME] = &fb_foveation_vulkan_ext;
|
|
request_extensions[XR_META_FOVEATION_EYE_TRACKED_EXTENSION_NAME] = &meta_foveation_eye_tracked_ext;
|
|
request_extensions[XR_META_VULKAN_SWAPCHAIN_CREATE_INFO_EXTENSION_NAME] = &meta_vulkan_swapchain_create_info_ext;
|
|
}
|
|
#endif // XR_USE_GRAPHICS_API_VULKAN
|
|
|
|
return request_extensions;
|
|
}
|
|
|
|
void OpenXRFBFoveationExtension::on_instance_created(const XrInstance p_instance) {
|
|
if (fb_foveation_ext) {
|
|
EXT_INIT_XR_FUNC(xrCreateFoveationProfileFB);
|
|
EXT_INIT_XR_FUNC(xrDestroyFoveationProfileFB);
|
|
}
|
|
|
|
if (fb_foveation_configuration_ext) {
|
|
// nothing to register here...
|
|
}
|
|
|
|
if (meta_foveation_eye_tracked_ext) {
|
|
EXT_INIT_XR_FUNC(xrGetFoveationEyeTrackedStateMETA);
|
|
}
|
|
}
|
|
|
|
void OpenXRFBFoveationExtension::on_instance_destroyed() {
|
|
fb_foveation_ext = false;
|
|
fb_foveation_configuration_ext = false;
|
|
meta_foveation_eye_tracked_ext = false;
|
|
}
|
|
|
|
bool OpenXRFBFoveationExtension::is_enabled() const {
|
|
bool enabled = swapchain_update_state_ext != nullptr && swapchain_update_state_ext->is_enabled() && fb_foveation_ext && fb_foveation_configuration_ext;
|
|
#ifdef XR_USE_GRAPHICS_API_VULKAN
|
|
if (rendering_driver == "vulkan") {
|
|
enabled = enabled && fb_foveation_vulkan_ext;
|
|
}
|
|
#endif // XR_USE_GRAPHICS_API_VULKAN
|
|
return enabled;
|
|
}
|
|
|
|
void *OpenXRFBFoveationExtension::set_system_properties_and_get_next_pointer(void *p_next_pointer) {
|
|
#ifdef XR_USE_GRAPHICS_API_VULKAN
|
|
if (rendering_driver == "vulkan") {
|
|
meta_foveation_eye_tracked_properties.next = p_next_pointer;
|
|
return &meta_foveation_eye_tracked_properties;
|
|
}
|
|
#endif
|
|
return p_next_pointer;
|
|
}
|
|
|
|
void *OpenXRFBFoveationExtension::set_swapchain_create_info_and_get_next_pointer(void *p_next_pointer) {
|
|
void *next = p_next_pointer;
|
|
if (is_enabled()) {
|
|
swapchain_create_info_foveation_fb.next = next;
|
|
next = &swapchain_create_info_foveation_fb;
|
|
|
|
if (meta_foveation_eye_tracked_ext && meta_vulkan_swapchain_create_info_ext && meta_foveation_eye_tracked_properties.supportsFoveationEyeTracked) {
|
|
meta_vulkan_swapchain_create_info.next = next;
|
|
next = &meta_vulkan_swapchain_create_info;
|
|
}
|
|
}
|
|
|
|
return next;
|
|
}
|
|
|
|
void OpenXRFBFoveationExtension::on_main_swapchains_created() {
|
|
update_profile();
|
|
}
|
|
|
|
XrFoveationLevelFB OpenXRFBFoveationExtension::get_foveation_level() const {
|
|
return foveation_level;
|
|
}
|
|
|
|
void OpenXRFBFoveationExtension::set_foveation_level(XrFoveationLevelFB p_foveation_level) {
|
|
foveation_level = p_foveation_level;
|
|
|
|
// Update profile will do nothing if we're not yet initialized.
|
|
update_profile();
|
|
}
|
|
|
|
XrFoveationDynamicFB OpenXRFBFoveationExtension::get_foveation_dynamic() const {
|
|
return foveation_dynamic;
|
|
}
|
|
|
|
void OpenXRFBFoveationExtension::set_foveation_dynamic(XrFoveationDynamicFB p_foveation_dynamic) {
|
|
foveation_dynamic = p_foveation_dynamic;
|
|
|
|
// Update profile will do nothing if we're not yet initialized.
|
|
update_profile();
|
|
}
|
|
|
|
bool OpenXRFBFoveationExtension::is_foveation_eye_tracked_enabled() const {
|
|
return is_enabled() && meta_foveation_eye_tracked_ext && meta_vulkan_swapchain_create_info_ext && meta_foveation_eye_tracked_properties.supportsFoveationEyeTracked;
|
|
}
|
|
|
|
void OpenXRFBFoveationExtension::get_fragment_density_offsets(LocalVector<Vector2i> &r_offsets) {
|
|
// Must be called from rendering thread!
|
|
ERR_NOT_ON_RENDER_THREAD;
|
|
|
|
if (!is_foveation_eye_tracked_enabled() || !OpenXREyeGazeInteractionExtension::get_singleton()->is_available()) {
|
|
return;
|
|
}
|
|
|
|
OpenXRAPI *openxr_api = OpenXRAPI::get_singleton();
|
|
ERR_FAIL_NULL(openxr_api);
|
|
|
|
_update_profile_rt();
|
|
|
|
XrFoveationEyeTrackedStateMETA state = {
|
|
XR_TYPE_FOVEATION_EYE_TRACKED_STATE_META, // type
|
|
nullptr, // next
|
|
{ XrVector2f{}, XrVector2f{} }, // foveationCenter[XR_FOVEATION_CENTER_SIZE_META];
|
|
0, // flags
|
|
};
|
|
XrResult result = xrGetFoveationEyeTrackedStateMETA(openxr_api->get_session(), &state);
|
|
if (XR_FAILED(result)) {
|
|
print_line("OpenXR: Unable to get foveation offsets [", openxr_api->get_error_string(result), "]");
|
|
return;
|
|
}
|
|
if (!(state.flags & XR_FOVEATION_EYE_TRACKED_STATE_VALID_BIT_META)) {
|
|
return;
|
|
}
|
|
|
|
r_offsets.reserve(XR_FOVEATION_CENTER_SIZE_META);
|
|
Size2 dims = openxr_api->get_recommended_target_size() * 0.5;
|
|
for (uint32_t i = 0; i < XR_FOVEATION_CENTER_SIZE_META; ++i) {
|
|
const XrVector2f &xr_center = state.foveationCenter[i];
|
|
r_offsets.push_back(Vector2i((int)(xr_center.x * dims.x), (int)(xr_center.y * dims.y)));
|
|
}
|
|
}
|
|
|
|
void OpenXRFBFoveationExtension::_update_profile_rt() {
|
|
// Must be called from rendering thread!
|
|
ERR_NOT_ON_RENDER_THREAD;
|
|
|
|
if (!is_enabled()) {
|
|
return;
|
|
}
|
|
|
|
OpenXRAPI *openxr_api = OpenXRAPI::get_singleton();
|
|
ERR_FAIL_NULL(openxr_api);
|
|
|
|
XrSwapchain main_color_swapchain = openxr_api->get_color_swapchain();
|
|
if (main_color_swapchain == XR_NULL_HANDLE) {
|
|
// Our swapchain hasn't been created yet, we'll call this again once it has.
|
|
return;
|
|
}
|
|
|
|
void *next = nullptr;
|
|
if (meta_foveation_eye_tracked_ext && meta_vulkan_swapchain_create_info_ext && meta_foveation_eye_tracked_properties.supportsFoveationEyeTracked) {
|
|
meta_foveation_eye_tracked_create_info.next = next;
|
|
next = &meta_foveation_eye_tracked_create_info;
|
|
}
|
|
|
|
XrFoveationLevelProfileCreateInfoFB level_profile_create_info;
|
|
level_profile_create_info.type = XR_TYPE_FOVEATION_LEVEL_PROFILE_CREATE_INFO_FB;
|
|
level_profile_create_info.next = next;
|
|
level_profile_create_info.level = foveation_level;
|
|
level_profile_create_info.verticalOffset = 0.0f;
|
|
level_profile_create_info.dynamic = foveation_dynamic;
|
|
|
|
XrFoveationProfileCreateInfoFB profile_create_info;
|
|
profile_create_info.type = XR_TYPE_FOVEATION_PROFILE_CREATE_INFO_FB;
|
|
profile_create_info.next = &level_profile_create_info;
|
|
|
|
XrFoveationProfileFB foveation_profile;
|
|
XrResult result = xrCreateFoveationProfileFB(openxr_api->get_session(), &profile_create_info, &foveation_profile);
|
|
if (XR_FAILED(result)) {
|
|
print_line("OpenXR: Unable to create the foveation profile [", openxr_api->get_error_string(result), "]");
|
|
return;
|
|
}
|
|
|
|
XrSwapchainStateFoveationFB foveation_update_state;
|
|
foveation_update_state.type = XR_TYPE_SWAPCHAIN_STATE_FOVEATION_FB;
|
|
foveation_update_state.next = nullptr;
|
|
foveation_update_state.flags = 0;
|
|
foveation_update_state.profile = foveation_profile;
|
|
|
|
result = swapchain_update_state_ext->xrUpdateSwapchainFB(main_color_swapchain, (XrSwapchainStateBaseHeaderFB *)&foveation_update_state);
|
|
if (XR_FAILED(result)) {
|
|
print_line("OpenXR: Unable to update the swapchain [", openxr_api->get_error_string(result), "]");
|
|
|
|
// We still want to destroy our profile so keep going...
|
|
}
|
|
|
|
result = xrDestroyFoveationProfileFB(foveation_profile);
|
|
if (XR_FAILED(result)) {
|
|
print_line("OpenXR: Unable to destroy the foveation profile [", openxr_api->get_error_string(result), "]");
|
|
}
|
|
}
|