Details for custom OpenXR Loaders.

Signed-off-by: Nick Klingensmith <quic_nklingen@quicinc.com>

Author: Nick Klingensmith

CMakeLists.txt

@@ -51,6 +51,10 @@ set(ANDROID_PACKAGE_NAME       "com.example.${PROJECT_NAME}")
 set(ANDROID_MIN_SDK_VERSION    29)
 set(ANDROID_TARGET_SDK_VERSION 32)
 
+# If you need to use a custom OpenXR Loader, uncomment this line and change the
+# path to the loader you want!
+#set(OPENXR_CUSTOM_LOADER "${CMAKE_SOURCE_DIR}/loader/snapdragon/libopenxr_loader.so")
+
 #######################################
 ## Primary Target                    ##
 #######################################
@@ -87,6 +91,9 @@ include(FetchContent)
 set(SK_BUILD_TESTS       OFF CACHE INTERNAL "")
 set(SK_BUILD_SHARED_LIBS ON  CACHE INTERNAL "") # Shared libraries allows for faster builds!
 set(SK_PHYSICS           OFF CACHE INTERNAL "") # SK Physics is deprecated, simplifies build.
+if (ANDROID AND DEFINED OPENXR_CUSTOM_LOADER)
+	set(SK_DYNAMIC_OPENXR ON CACHE INTERNAL "")
+endif()
 FetchContent_Declare(
 	StereoKitC
 	GIT_REPOSITORY https://github.com/StereoKit/StereoKit.git
@@ -102,6 +109,14 @@ target_link_libraries( ${PROJECT_NAME}
 	PRIVATE StereoKitC
 )
 
+# If a custom OpenXR Loader binary has been specified, we can add it to the
+# project as a shared library!
+if (ANDROID AND DEFINED OPENXR_CUSTOM_LOADER)
+	add_library          (custom_openxr_loader SHARED IMPORTED)
+	set_target_properties(custom_openxr_loader PROPERTIES IMPORTED_LOCATION ${OPENXR_CUSTOM_LOADER})
+	target_link_libraries(${PROJECT_NAME} PRIVATE custom_openxr_loader)
+endif()
+
 # This needs to be called after all libraries have been linked to
 # ${PROJECT_NAME}, or their shared binaries will be missed when building the
 # APK!

README.md

@@ -112,4 +112,8 @@ cmake -B build-android ^
 cmake --build build-android -j8 --target run
 # Or just build an APK
 cmake --build build-android -j8 --target apk
-```
+```
+
+## Custom OpenXR Loader
+
+If you need to use a custom OpenXR Loader for a non-conformant runtime such as Snapdragon Spaces, you can specify it with the `OPENXR_CUSTOM_LOADER` variable! See the CMakeLists.txt file for a commented out example. Note that you may need to do a _full_ clean and rebuild if you're switching between the standard and a custom loader. It may be better to have a different build folder per-loader.