Files
flightgear/3rdparty/osgXR/src/OpenXR/Quirks.cpp
2022-10-20 20:29:11 +08:00

120 lines
3.8 KiB
C++

// SPDX-License-Identifier: LGPL-2.1-only
// Copyright (C) 2021 James Hogan <james@albanarts.com>
#include "Instance.h"
#include "Quirks.h"
#include <cstdlib>
#include <cstring>
#ifdef OSGXR_USE_X11
#define USING_X11 1
#else
#define USING_X11 0
#endif
using namespace osgXR::OpenXR;
void Quirks::probe(Instance *instance)
{
static struct {
Quirk quirk;
const char *envName;
bool condition;
const char *runtimeMatch;
XrVersion runtimeVersionMin;
XrVersion runtimeVersionMax;
const char *description;
} quirkInfo[] = {
#define QUIRK(NAME, COND, RUNTIME, VMIN, VMAX, LINK) \
{ NAME, "OSGXR_"#NAME, COND, RUNTIME, VMIN, VMAX, \
#NAME LINK }
#define MIN_XR_VERSION XR_MAKE_VERSION(0, 0, 0)
#define MAX_XR_VERSION XR_MAKE_VERSION(-1, -1, -1)
#define MATCH_MONADO "Monado"
#define MATCH_STEAMVR "SteamVR"
// As of 2021-12-16 Monado expects the GL context to be current.
// See https://gitlab.freedesktop.org/monado/monado/-/issues/145
// Fixed by https://gitlab.freedesktop.org/monado/monado/-/merge_requests/1216
QUIRK(QUIRK_GL_CONTEXT_IGNORED,
USING_X11,
MATCH_MONADO, MIN_XR_VERSION, XR_MAKE_VERSION(21, 0, 0),
" (https://gitlab.freedesktop.org/monado/monado/-/issues/145)"),
// Prior to 1.16.4 linux_v1.14 switched context but didn't restore.
// The SteamVR runtimeVersion is unfortunately fairly useless here.
QUIRK(QUIRK_GL_CONTEXT_CHANGED,
USING_X11,
MATCH_STEAMVR, MIN_XR_VERSION, XR_MAKE_VERSION(0, 1, 0),
""),
// Since SteamVR 1.16.4 the GL context is cleared by various calls.
// The SteamVR runtimeVersion is unfortunately fairly useless here.
QUIRK(QUIRK_GL_CONTEXT_CLEARED,
USING_X11,
MATCH_STEAMVR, MIN_XR_VERSION, MAX_XR_VERSION,
" (https://github.com/ValveSoftware/SteamVR-for-Linux/issues/421)"),
// Since SteamVR 1.15.x apps hang during xrDestroyInstance.
QUIRK(QUIRK_AVOID_DESTROY_INSTANCE,
USING_X11,
MATCH_STEAMVR, MIN_XR_VERSION, MAX_XR_VERSION,
" (https://github.com/ValveSoftware/SteamVR-for-Linux/issues/422)"),
#undef QUIRK
};
const char *runtime = instance->getRuntimeName();
XrVersion version = instance->getRuntimeVersion();
// Clear all quirks
reset();
// Probe each quirk
for (auto &quirk: quirkInfo)
{
const char *env = getenv(quirk.envName);
if (env)
{
if (!strncmp(env, "0", 2))
{
set(quirk.quirk, false);
}
else if (!strncmp(env, "1", 2))
{
set(quirk.quirk, true);
}
else
{
env = nullptr;
OSG_WARN << "osgXR: Unknown value for env \""
<< quirk.envName << "\", ignored" << std::endl;
}
}
// Probe the runtime name and version
if (!env &&
quirk.condition &&
!strncmp(runtime, quirk.runtimeMatch, strlen(quirk.runtimeMatch)) &&
version >= quirk.runtimeVersionMin &&
version <= quirk.runtimeVersionMax)
{
set(quirk.quirk, true);
}
}
// Print to log any enabled quirks
if (any())
{
OSG_WARN << "osgXR: OpenXR Runtime: \"" << runtime
<< "\" version " << XR_VERSION_MAJOR(version)
<< "." << XR_VERSION_MINOR(version)
<< "." << XR_VERSION_PATCH(version) << std::endl;
for (auto &quirk: quirkInfo)
if (test(quirk.quirk))
OSG_WARN << "osgXR: Enabling " << quirk.description << std::endl;
}
}