Skip to content

Add support for OpenVR background application type #189

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

Merged
vilhalmer merged 1 commit into from
May 26, 2026
Merged

Add support for OpenVR background application type #189

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
32 changes: 22 additions & 10 deletions src/open_vr/openvr_data.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,12 +148,24 @@ bool openvr_data::initialise() {

if (success) {
// Loading the SteamVR Runtime
if (application_type == OpenVRApplicationType::OVERLAY) {
hmd = vr::VR_Init(&error, vr::VRApplication_Overlay);
UtilityFunctions::print("Application in overlay mode.");
} else {
hmd = vr::VR_Init(&error, vr::VRApplication_Scene);
UtilityFunctions::print("Application in scene (normal) mode.");
switch (application_type) {
case OpenVRApplicationType::OTHER:
hmd = vr::VR_Init(&error, vr::VRApplication_Other);
UtilityFunctions::print("Application in other mode.");
break;
case OpenVRApplicationType::OVERLAY:
hmd = vr::VR_Init(&error, vr::VRApplication_Overlay);
UtilityFunctions::print("Application in overlay mode.");
break;
case OpenVRApplicationType::BACKGROUND:
hmd = vr::VR_Init(&error, vr::VRApplication_Background);
UtilityFunctions::print("Application in background mode.");
break;
case OpenVRApplicationType::SCENE:
default:
hmd = vr::VR_Init(&error, vr::VRApplication_Scene);
UtilityFunctions::print("Application in scene (normal) mode.");
break;
}

if (error != vr::VRInitError_None) {
Expand Down Expand Up @@ -183,15 +195,15 @@ bool openvr_data::initialise() {
}

if (success) {
if (!vr::VRCompositor()) {
if ((application_type != OpenVRApplicationType::BACKGROUND) && !vr::VRCompositor()) {
success = false;

UtilityFunctions::print("Compositor initialization failed. See log file for details.");
}
}

if (success) {
if (application_type == OpenVRApplicationType::OVERLAY) {
if (application_type == OpenVRApplicationType::OVERLAY || application_type == OpenVRApplicationType::BACKGROUND) {
if (!vr::VROverlay()) {
success = false;

Expand Down Expand Up @@ -552,7 +564,7 @@ void openvr_data::process() {
// update our poses structure, this tracks our controllers
vr::TrackedDevicePose_t tracked_device_pose[vr::k_unMaxTrackedDeviceCount];

if (get_application_type() == openvr_data::OpenVRApplicationType::OVERLAY) {
if (get_application_type() == openvr_data::OpenVRApplicationType::OVERLAY || get_application_type() == openvr_data::OpenVRApplicationType::BACKGROUND) {
openvr_data::OpenVRTrackingUniverse tracking_universe = get_tracking_universe();
if (tracking_universe == openvr_data::OpenVRTrackingUniverse::SEATED) {
vr::VRSystem()->GetDeviceToAbsoluteTrackingPose(vr::TrackingUniverseSeated, 0.0, tracked_device_pose, vr::k_unMaxTrackedDeviceCount);
Expand Down Expand Up @@ -746,7 +758,7 @@ Transform3D openvr_data::get_eye_to_head_transform(int p_view, double p_world_sc
}

void openvr_data::pre_render_update() {
if (get_application_type() != openvr_data::OpenVRApplicationType::OVERLAY) {
if (get_application_type() != openvr_data::OpenVRApplicationType::OVERLAY && get_application_type() != openvr_data::OpenVRApplicationType::BACKGROUND) {
vr::TrackedDevicePose_t tracked_device_pose[vr::k_unMaxTrackedDeviceCount];
vr::VRCompositor()->WaitGetPoses(tracked_device_pose, vr::k_unMaxTrackedDeviceCount, nullptr, 0);

Expand Down
3 changes: 2 additions & 1 deletion src/open_vr/openvr_data.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,8 @@ class openvr_data {
enum OpenVRApplicationType {
OTHER,
SCENE,
OVERLAY
OVERLAY,
BACKGROUND
};

enum OpenVRTrackingUniverse {
Expand Down
2 changes: 1 addition & 1 deletion src/xr_interface_openvr.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ using namespace godot;
void XRInterfaceOpenVR::_bind_methods() {
ClassDB::bind_method(D_METHOD("get_application_type"), &XRInterfaceOpenVR::get_application_type);
ClassDB::bind_method(D_METHOD("set_application_type", "application_type"), &XRInterfaceOpenVR::set_application_type);
ADD_PROPERTY(PropertyInfo(Variant::INT, "application_type", PROPERTY_HINT_ENUM, "Other,Scene,Overlay"), "set_application_type", "get_application_type");
ADD_PROPERTY(PropertyInfo(Variant::INT, "application_type", PROPERTY_HINT_ENUM, "Other,Scene,Overlay,Background"), "set_application_type", "get_application_type");

ClassDB::bind_method(D_METHOD("get_tracking_universe"), &XRInterfaceOpenVR::get_tracking_universe);
ClassDB::bind_method(D_METHOD("set_tracking_universe", "tracking_universe"), &XRInterfaceOpenVR::set_tracking_universe);
Expand Down
Loading