mirror/openmw-tes3mp
1
0
Fork 1
mirror of https://github.com/TES3MP/openmw-tes3mp.git synced 2025-03-31 01:06:41 +00:00
Code Issues Releases Wiki Activity

More useful error messages for typical init failures

Browse source
This commit is contained in:
madsbuvi 2021-02-07 00:07:14 +01:00
parent 697caaff84
commit f9c13f3163
4 changed files with 70 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
apps/openmw/mwvr/openxrmanager.cpp
View file

@ -76,15 +76,7 @@ namespace MWVR
if (!realized())
{
gc->makeCurrent();
try {
mPrivate = std::make_shared<OpenXRManagerImpl>(gc);
}
catch (std::exception& e)
{
std::string error = std::string("Exception thrown while initializing OpenXR: ") + e.what();
Log(Debug::Error) << error;
throw std::runtime_error(error);
}
mPrivate = std::make_shared<OpenXRManagerImpl>(gc);
}
}

5
apps/openmw/mwvr/openxrmanagerimpl.cpp
View file

@ -73,8 +73,9 @@ namespace MWVR
// Get system ID
XrSystemGetInfo systemInfo{ XR_TYPE_SYSTEM_GET_INFO };
systemInfo.formFactor = mFormFactor = XR_FORM_FACTOR_HEAD_MOUNTED_DISPLAY;
CHECK_XRCMD(xrGetSystem(mInstance, &systemInfo, &mSystemId));
assert(mSystemId);
auto res = CHECK_XRCMD(xrGetSystem(mInstance, &systemInfo, &mSystemId));
if (!XR_SUCCEEDED(res))
mPlatform.initFailure(res, mInstance);
// Create session
mSession = mPlatform.createXrSession(mInstance, mSystemId);

68
apps/openmw/mwvr/openxrplatform.cpp
View file

@ -29,6 +29,7 @@
#include <stdexcept>
#include <deque>
#include <cassert>
#include <optional>
namespace MWVR
{
@ -409,13 +410,17 @@ namespace MWVR
createInfo.enabledExtensionNames = mEnabledExtensions.data();
strcpy(createInfo.applicationInfo.applicationName, "openmw_vr");
createInfo.applicationInfo.apiVersion = XR_CURRENT_API_VERSION;
CHECK_XRCMD(xrCreateInstance(&createInfo, &instance));
auto res = CHECK_XRCMD(xrCreateInstance(&createInfo, &instance));
if (!XR_SUCCEEDED(res))
initFailure(res, instance);
return instance;
}
XrSession OpenXRPlatform::createXrSession(XrInstance instance, XrSystemId systemId)
{
XrSession session = XR_NULL_HANDLE;
XrResult res = XR_SUCCESS;
#ifdef _WIN32
std::string graphicsAPIExtension = graphicsAPIExtensionName();
if(graphicsAPIExtension == XR_KHR_OPENGL_ENABLE_EXTENSION_NAME)
@ -448,7 +453,7 @@ namespace MWVR
XrSessionCreateInfo createInfo{ XR_TYPE_SESSION_CREATE_INFO };
createInfo.next = &graphicsBindings;
createInfo.systemId = systemId;
CHECK_XRCMD(xrCreateSession(instance, &createInfo, &session));
res = CHECK_XRCMD(xrCreateSession(instance, &createInfo, &session));
}
#ifdef XR_USE_GRAPHICS_API_D3D11
else if(graphicsAPIExtension == XR_KHR_D3D11_ENABLE_EXTENSION_NAME)
@ -462,7 +467,7 @@ namespace MWVR
XrSessionCreateInfo createInfo{ XR_TYPE_SESSION_CREATE_INFO };
createInfo.next = &mPrivate->mD3D11bindings;
createInfo.systemId = systemId;
CHECK_XRCMD(xrCreateSession(instance, &createInfo, &session));
res = CHECK_XRCMD(xrCreateSession(instance, &createInfo, &session));
}
#endif
else
@ -510,10 +515,11 @@ namespace MWVR
XrSessionCreateInfo createInfo{ XR_TYPE_SESSION_CREATE_INFO };
createInfo.next = &graphicsBindings;
createInfo.systemId = systemId;
CHECK_XRCMD(xrCreateSession(instance, &createInfo, &session));
res = CHECK_XRCMD(xrCreateSession(instance, &createInfo, &session));
}
#endif
assert(session);
if (!XR_SUCCEEDED(res))
initFailure(res, instance);
uint32_t swapchainFormatCount;
CHECK_XRCMD(xrEnumerateSwapchainFormats(session, 0, &swapchainFormatCount, nullptr));
@ -678,4 +684,56 @@ namespace MWVR
mPrivate->wglDXUnlockObjectsNV(mPrivate->wglDXDevice, 1, &dxResourceShareHandle);
#endif
}
static XrInstanceProperties
getInstanceProperties(XrInstance instance)
{
XrInstanceProperties properties{ XR_TYPE_INSTANCE_PROPERTIES };
if (instance)
xrGetInstanceProperties(instance, &properties);
return properties;
}
std::string OpenXRPlatform::getInstanceName(XrInstance instance)
{
if (instance)
return getInstanceProperties(instance).runtimeName;
return "unknown";
}
XrVersion OpenXRPlatform::getInstanceVersion(XrInstance instance)
{
if (instance)
return getInstanceProperties(instance).runtimeVersion;
return 0;
}
void OpenXRPlatform::initFailure(XrResult res, XrInstance instance)
{
std::stringstream ss;
std::string runtimeName = getInstanceName(instance);
XrVersion runtimeVersion = getInstanceVersion(instance);
ss << "Error caught while initializing VR device: " << XrResultString(res) << std::endl;
ss << "Device: " << runtimeName << std::endl;
ss << "Version: " << runtimeVersion << std::endl;
if (res == XR_ERROR_FORM_FACTOR_UNAVAILABLE)
{
ss << "Cause: Unable to open VR device. Make sure your device is plugged in and the VR driver is running." << std::endl;
ss << std::endl;
if (runtimeName == "Oculus" || runtimeName == "Quest")
{
ss << "Your device has been identified as an Oculus device." << std::endl;
ss << "The most common cause for this error when using an oculus device, is quest users attempting to run the game via Virtual Desktop." << std::endl;
ss << "Unfortunately this is currently broken, and quest users will need to play via a link cable." << std::endl;
}
}
else if (res == XR_ERROR_LIMIT_REACHED)
{
ss << "Cause: Device resources exhausted. Close other VR applications if you have any open. If you have none, you may need to reboot to reset the driver." << std::endl;
}
else
{
ss << "Cause: Unknown. Make sure your device is plugged in and ready." << std::endl;
}
throw std::runtime_error(ss.str());
}
}

3
apps/openmw/mwvr/openxrplatform.hpp
View file

@ -62,6 +62,9 @@ namespace MWVR
/// Unlocks a DX object for use by DirectX as if calling wglDXUnlockObjectsNV
void DXUnlockObject(void* dxResourceShareHandle);
std::string getInstanceName(XrInstance instance);
XrVersion getInstanceVersion(XrInstance instance);
void initFailure(XrResult, XrInstance);
private:
void enumerateExtensions(const char* layerName, int logIndent);