godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/modules/openxr/SCsub

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

128 lines
5.7 KiB
Plaintext
Raw Normal View History

Implementing OpenXR driver
2021-12-14 01:44:12 +00:00
#!/usr/bin/env python
Import("env")
Import("env_modules")
env_openxr = env_modules.Clone()
Allow unbundling OpenXR (for Linux distros) Copy XrMatrix4x4f_CreateProjectionFov to our OpenXRUtil, instead of relying on a private header.
2023-02-16 13:47:31 +00:00
# Thirdparty source files
Implementing OpenXR driver
2021-12-14 01:44:12 +00:00
thirdparty_obj = []
Allow unbundling OpenXR (for Linux distros) Copy XrMatrix4x4f_CreateProjectionFov to our OpenXRUtil, instead of relying on a private header.
2023-02-16 13:47:31 +00:00
# Khronos OpenXR loader
# Needs even for build against shared library, at least the defines used in public headers.
Implementing OpenXR driver
2021-12-14 01:44:12 +00:00
if env["platform"] == "android":
# may need to set OPENXR_ANDROID_VERSION_SUFFIX
Dynamic loading of OpenXR Loader on Android This change implements dynamic loading of the OpenXR Loader library on Android. If an OpenXR Loader library is not found, Godot will still function with OpenXR disabled. Also, on every platform, the OpenXR symbols are resolved at runtime using xrGetInstanceProcAddr. On Windows and Linux the OpenXR loader is included in the main engine binary. On Android, the OpenXR Loader is not built with the engine. Separately distributed Android plugins will be provided with the correct loader library for each device. Co-authored-by: Gábor Pál Korom <gabor.p.korom@migeran.com> Co-authored-by: Gábor Koncz <gabor.koncz@migeran.com>
2022-09-24 11:56:00 +00:00
env_openxr.AppendUnique(CPPDEFINES=["XR_OS_ANDROID", "XR_USE_PLATFORM_ANDROID"])
env_openxr.AppendUnique(CPPDEFINES=["JSON_USE_EXCEPTION=0"])
Implementing OpenXR driver
2021-12-14 01:44:12 +00:00
# may need to include java parts of the openxr loader
elif env["platform"] == "linuxbsd":
Dynamic loading of OpenXR Loader on Android This change implements dynamic loading of the OpenXR Loader library on Android. If an OpenXR Loader library is not found, Godot will still function with OpenXR disabled. Also, on every platform, the OpenXR symbols are resolved at runtime using xrGetInstanceProcAddr. On Windows and Linux the OpenXR loader is included in the main engine binary. On Android, the OpenXR Loader is not built with the engine. Separately distributed Android plugins will be provided with the correct loader library for each device. Co-authored-by: Gábor Pál Korom <gabor.p.korom@migeran.com> Co-authored-by: Gábor Koncz <gabor.koncz@migeran.com>
2022-09-24 11:56:00 +00:00
env_openxr.AppendUnique(CPPDEFINES=["XR_OS_LINUX"])
Improve `linuxbsd` headless building, cleanup build scripts Now the `linuxbsd` platform can be built headlessly (e.g. without X11 development libraries). I also cleaned up some weird (old?) usages of the `env` variable which seem to make no difference and are used nowhere else.
2022-07-20 01:42:15 +00:00
if env["x11"]:
Dynamic loading of OpenXR Loader on Android This change implements dynamic loading of the OpenXR Loader library on Android. If an OpenXR Loader library is not found, Godot will still function with OpenXR disabled. Also, on every platform, the OpenXR symbols are resolved at runtime using xrGetInstanceProcAddr. On Windows and Linux the OpenXR loader is included in the main engine binary. On Android, the OpenXR Loader is not built with the engine. Separately distributed Android plugins will be provided with the correct loader library for each device. Co-authored-by: Gábor Pál Korom <gabor.p.korom@migeran.com> Co-authored-by: Gábor Koncz <gabor.koncz@migeran.com>
2022-09-24 11:56:00 +00:00
env_openxr.AppendUnique(CPPDEFINES=["XR_USE_PLATFORM_XLIB"])
Improve `linuxbsd` headless building, cleanup build scripts Now the `linuxbsd` platform can be built headlessly (e.g. without X11 development libraries). I also cleaned up some weird (old?) usages of the `env` variable which seem to make no difference and are used nowhere else.
2022-07-20 01:42:15 +00:00
Implementing OpenXR driver
2021-12-14 01:44:12 +00:00
# FIXME: Review what needs to be set for Android and macOS.
Dynamic loading of OpenXR Loader on Android This change implements dynamic loading of the OpenXR Loader library on Android. If an OpenXR Loader library is not found, Godot will still function with OpenXR disabled. Also, on every platform, the OpenXR symbols are resolved at runtime using xrGetInstanceProcAddr. On Windows and Linux the OpenXR loader is included in the main engine binary. On Android, the OpenXR Loader is not built with the engine. Separately distributed Android plugins will be provided with the correct loader library for each device. Co-authored-by: Gábor Pál Korom <gabor.p.korom@migeran.com> Co-authored-by: Gábor Koncz <gabor.koncz@migeran.com>
2022-09-24 11:56:00 +00:00
env_openxr.AppendUnique(CPPDEFINES=["HAVE_SECURE_GETENV"])
Implementing OpenXR driver
2021-12-14 01:44:12 +00:00
elif env["platform"] == "windows":
Dynamic loading of OpenXR Loader on Android This change implements dynamic loading of the OpenXR Loader library on Android. If an OpenXR Loader library is not found, Godot will still function with OpenXR disabled. Also, on every platform, the OpenXR symbols are resolved at runtime using xrGetInstanceProcAddr. On Windows and Linux the OpenXR loader is included in the main engine binary. On Android, the OpenXR Loader is not built with the engine. Separately distributed Android plugins will be provided with the correct loader library for each device. Co-authored-by: Gábor Pál Korom <gabor.p.korom@migeran.com> Co-authored-by: Gábor Koncz <gabor.koncz@migeran.com>
2022-09-24 11:56:00 +00:00
env_openxr.AppendUnique(CPPDEFINES=["XR_OS_WINDOWS", "NOMINMAX", "XR_USE_PLATFORM_WIN32"])
Compile OpenXR into MacOS build
2023-07-18 14:02:47 +00:00
elif env["platform"] == "macos":
env_openxr.AppendUnique(CPPDEFINES=["XR_OS_APPLE"])
# There does not seem to be a XR_USE_PLATFORM_XYZ for Apple
Implementing OpenXR driver
2021-12-14 01:44:12 +00:00
Dynamic loading of OpenXR Loader on Android This change implements dynamic loading of the OpenXR Loader library on Android. If an OpenXR Loader library is not found, Godot will still function with OpenXR disabled. Also, on every platform, the OpenXR symbols are resolved at runtime using xrGetInstanceProcAddr. On Windows and Linux the OpenXR loader is included in the main engine binary. On Android, the OpenXR Loader is not built with the engine. Separately distributed Android plugins will be provided with the correct loader library for each device. Co-authored-by: Gábor Pál Korom <gabor.p.korom@migeran.com> Co-authored-by: Gábor Koncz <gabor.koncz@migeran.com>
2022-09-24 11:56:00 +00:00
# may need to check and set:
# - XR_USE_TIMESPEC
Implementing OpenXR driver
2021-12-14 01:44:12 +00:00
Allow unbundling OpenXR (for Linux distros) Copy XrMatrix4x4f_CreateProjectionFov to our OpenXRUtil, instead of relying on a private header.
2023-02-16 13:47:31 +00:00
if env["builtin_openxr"]:
thirdparty_dir = "#thirdparty/openxr"
env_openxr.Prepend(
CPPPATH=[
thirdparty_dir,
thirdparty_dir + "/include",
thirdparty_dir + "/src",
thirdparty_dir + "/src/common",
thirdparty_dir + "/src/external/jsoncpp/include",
]
)
env_thirdparty = env_openxr.Clone()
env_thirdparty.disable_warnings()
SCons: Disable C++ exception handling Upon investigating the extremely slow MSVC build times in #80513, I noticed that while Godot policy is to never use exceptions, we weren't enforcing it with compiler flags, and thus still included exception handling code and stack unwinding. This is wasteful on multiple aspects: - Binary size: Around 20% binary size reduction with exceptions disabled for both MSVC and GCC binaries. - Compile time: * More than 50% build time reduction with MSVC. * 10% to 25% build time reduction with GCC + LTO. - Performance: Possibly, needs to be benchmarked. Since users may want to re-enable exceptions in their own thirdparty code or the libraries they compile with Godot, this behavior can be toggled with the `disable_exceptions` SCons option, which defaults to true.
2023-08-14 11:02:40 +00:00
Allow unbundling OpenXR (for Linux distros) Copy XrMatrix4x4f_CreateProjectionFov to our OpenXRUtil, instead of relying on a private header.
2023-02-16 13:47:31 +00:00
env_thirdparty.AppendUnique(CPPDEFINES=["DISABLE_STD_FILESYSTEM"])
SCons: Disable C++ exception handling Upon investigating the extremely slow MSVC build times in #80513, I noticed that while Godot policy is to never use exceptions, we weren't enforcing it with compiler flags, and thus still included exception handling code and stack unwinding. This is wasteful on multiple aspects: - Binary size: Around 20% binary size reduction with exceptions disabled for both MSVC and GCC binaries. - Compile time: * More than 50% build time reduction with MSVC. * 10% to 25% build time reduction with GCC + LTO. - Performance: Possibly, needs to be benchmarked. Since users may want to re-enable exceptions in their own thirdparty code or the libraries they compile with Godot, this behavior can be toggled with the `disable_exceptions` SCons option, which defaults to true.
2023-08-14 11:02:40 +00:00
if env["disable_exceptions"]:
env_thirdparty.AppendUnique(CPPDEFINES=["XRLOADER_DISABLE_EXCEPTION_HANDLING", ("JSON_USE_EXCEPTION", 0)])
Allow unbundling OpenXR (for Linux distros) Copy XrMatrix4x4f_CreateProjectionFov to our OpenXRUtil, instead of relying on a private header.
2023-02-16 13:47:31 +00:00
env_thirdparty.Append(CPPPATH=[thirdparty_dir + "/src/loader"])
# add in external jsoncpp dependency
thirdparty_jsoncpp_dir = thirdparty_dir + "/src/external/jsoncpp/src/lib_json/"
env_thirdparty.add_source_files(thirdparty_obj, thirdparty_jsoncpp_dir + "json_reader.cpp")
env_thirdparty.add_source_files(thirdparty_obj, thirdparty_jsoncpp_dir + "json_value.cpp")
env_thirdparty.add_source_files(thirdparty_obj, thirdparty_jsoncpp_dir + "json_writer.cpp")
# add in load
if env["platform"] != "android":
# On Android the openxr_loader is provided by separate plugins for each device
# Build the engine using object files
khrloader_obj = []
env_thirdparty.add_source_files(khrloader_obj, thirdparty_dir + "/src/xr_generated_dispatch_table.c")
env_thirdparty.add_source_files(khrloader_obj, thirdparty_dir + "/src/common/filesystem_utils.cpp")
env_thirdparty.add_source_files(khrloader_obj, thirdparty_dir + "/src/common/object_info.cpp")
env_thirdparty.add_source_files(khrloader_obj, thirdparty_dir + "/src/loader/api_layer_interface.cpp")
env_thirdparty.add_source_files(khrloader_obj, thirdparty_dir + "/src/loader/loader_core.cpp")
env_thirdparty.add_source_files(khrloader_obj, thirdparty_dir + "/src/loader/loader_instance.cpp")
env_thirdparty.add_source_files(khrloader_obj, thirdparty_dir + "/src/loader/loader_logger_recorders.cpp")
env_thirdparty.add_source_files(khrloader_obj, thirdparty_dir + "/src/loader/loader_logger.cpp")
env_thirdparty.add_source_files(khrloader_obj, thirdparty_dir + "/src/loader/manifest_file.cpp")
env_thirdparty.add_source_files(khrloader_obj, thirdparty_dir + "/src/loader/runtime_interface.cpp")
env_thirdparty.add_source_files(khrloader_obj, thirdparty_dir + "/src/loader/xr_generated_loader.cpp")
env.modules_sources += khrloader_obj
env.modules_sources += thirdparty_obj
# Godot source files
Implementing OpenXR driver
2021-12-14 01:44:12 +00:00
module_obj = []
env_openxr.add_source_files(module_obj, "*.cpp")
env_openxr.add_source_files(module_obj, "action_map/*.cpp")
Adding OpenXR hand tracking support
2022-04-17 02:58:09 +00:00
env_openxr.add_source_files(module_obj, "scene/*.cpp")
Implementing OpenXR driver
2021-12-14 01:44:12 +00:00
Fix typos with codespell Using codespell 2.2-dev from current git. Fix a couple incorrect uses of gendered pronouns.
2022-03-31 12:06:10 +00:00
# We're a little more targeted with our extensions
Implementing OpenXR driver
2021-12-14 01:44:12 +00:00
if env["platform"] == "android":
env_openxr.add_source_files(module_obj, "extensions/openxr_android_extension.cpp")
if env["vulkan"]:
env_openxr.add_source_files(module_obj, "extensions/openxr_vulkan_extension.cpp")
Compile OpenXR into MacOS build
2023-07-18 14:02:47 +00:00
if env["opengl3"] and env["platform"] != "macos":
Add support for OpenGL to OpenXR
2022-10-23 01:29:15 +00:00
env_openxr.add_source_files(module_obj, "extensions/openxr_opengl_extension.cpp")
Implementing OpenXR driver
2021-12-14 01:44:12 +00:00
Add OpenXR palm pose extension support
2022-09-23 03:20:12 +00:00
env_openxr.add_source_files(module_obj, "extensions/openxr_palm_pose_extension.cpp")
Adding getters to RenderTarget and implementing override functionality for XR
2022-09-01 08:10:53 +00:00
env_openxr.add_source_files(module_obj, "extensions/openxr_composition_layer_depth_extension.cpp")
Removed member variables from OpenXRExtensionWrapper Made extension container in OpenXRAPI static Moved controller meta data into extensions where applicable
2022-12-29 05:34:25 +00:00
env_openxr.add_source_files(module_obj, "extensions/openxr_htc_controller_extension.cpp")
Adding HTC tracker support
2022-03-09 08:09:25 +00:00
env_openxr.add_source_files(module_obj, "extensions/openxr_htc_vive_tracker_extension.cpp")
Removed member variables from OpenXRExtensionWrapper Made extension container in OpenXRAPI static Moved controller meta data into extensions where applicable
2022-12-29 05:34:25 +00:00
env_openxr.add_source_files(module_obj, "extensions/openxr_huawei_controller_extension.cpp")
Adding OpenXR hand tracking support
2022-04-17 02:58:09 +00:00
env_openxr.add_source_files(module_obj, "extensions/openxr_hand_tracking_extension.cpp")
Add Passthrough extension wrapper
2022-09-26 07:04:12 +00:00
env_openxr.add_source_files(module_obj, "extensions/openxr_fb_passthrough_extension_wrapper.cpp")
Adding support for the OpenXR Display Refresh Rate extension
2022-10-10 07:51:53 +00:00
env_openxr.add_source_files(module_obj, "extensions/openxr_fb_display_refresh_rate_extension.cpp")
OpenXR: Add preliminary Pico controller profile This commit adds the Pico controller used in the Pico 4 as implemented in current versions of the OpenXR runtime on the device itself. Note that the extension and paths used in this commit might become obsolete once there is official support for the Pico 4 in the OpenXR standard.
2022-12-16 20:14:24 +00:00
env_openxr.add_source_files(module_obj, "extensions/openxr_pico_controller_extension.cpp")
Removed member variables from OpenXRExtensionWrapper Made extension container in OpenXRAPI static Moved controller meta data into extensions where applicable
2022-12-29 05:34:25 +00:00
env_openxr.add_source_files(module_obj, "extensions/openxr_wmr_controller_extension.cpp")
Add Magic Leap 2 OpenXR Interaction Profile
2023-02-02 11:45:43 +00:00
env_openxr.add_source_files(module_obj, "extensions/openxr_ml2_controller_extension.cpp")
Add GDExtension support for OpenXR extension wrappers This commit adds the classes OpenXRExtensionWrapperExtension and OpenXRAPIExtension that can be used in GDExtensions to define OpenXR extension wrappers. It modifies extension wrapper registration so that they can be registered before OpenXRAPI instantiation (e.g. in core level initialization of GDExtensions). Developed by Migeran (https://migeran.com)
2022-12-29 05:34:25 +00:00
env_openxr.add_source_files(module_obj, "extensions/openxr_extension_wrapper_extension.cpp")
env_openxr.add_source_files(module_obj, "extensions/openxr_api_extension.cpp")
Adding HTC tracker support
2022-03-09 08:09:25 +00:00
Implementing OpenXR driver
2021-12-14 01:44:12 +00:00
env.modules_sources += module_obj
SCons: Unify tools/target build type configuration Implements https://github.com/godotengine/godot-proposals/issues/3371. New `target` presets ==================== The `tools` option is removed and `target` changes to use three new presets, which match the builds users are familiar with. These targets control the default optimization level and enable editor-specific and debugging code: - `editor`: Replaces `tools=yes target=release_debug`. * Defines: `TOOLS_ENABLED`, `DEBUG_ENABLED`, `-O2`/`/O2` - `template_debug`: Replaces `tools=no target=release_debug`. * Defines: `DEBUG_ENABLED`, `-O2`/`/O2` - `template_release`: Replaces `tools=no target=release`. * Defines: `-O3`/`/O2` New `dev_build` option ====================== The previous `target=debug` is now replaced by a separate `dev_build=yes` option, which can be used in combination with either of the three targets, and changes the following: - `dev_build`: Defines `DEV_ENABLED`, disables optimization (`-O0`/`/0d`), enables generating debug symbols, does not define `NDEBUG` so `assert()` works in thirdparty libraries, adds a `.dev` suffix to the binary name. Note: Unlike previously, `dev_build` defaults to off so that users who compile Godot from source get an optimized and small build by default. Engine contributors should now set `dev_build=yes` in their build scripts or IDE configuration manually. Changed binary names ==================== The name of generated binaries and object files are changed too, to follow this format: `godot.<platform>.<target>[.dev][.double].<arch>[.<extra_suffix>][.<ext>]` For example: - `godot.linuxbsd.editor.dev.arm64` - `godot.windows.template_release.double.x86_64.mono.exe` Be sure to update your links/scripts/IDE config accordingly. More flexible `optimize` and `debug_symbols` options ==================================================== The optimization level and whether to generate debug symbols can be further specified with the `optimize` and `debug_symbols` options. So the default values listed above for the various `target` and `dev_build` combinations are indicative and can be replaced when compiling, e.g.: `scons p=linuxbsd target=template_debug dev_build=yes optimize=debug` will make a "debug" export template with dev-only code enabled, `-Og` optimization level for GCC/Clang, and debug symbols. Perfect for debugging complex crashes at runtime in an exported project.
2022-09-22 06:28:55 +00:00
if env.editor_build:
Add action map editor for OpenXR
2022-03-16 23:24:47 +00:00
SConscript("editor/SCsub")
Implementing OpenXR driver
2021-12-14 01:44:12 +00:00
# Needed to force rebuilding the module files when the thirdparty library is updated.
env.Depends(module_obj, thirdparty_obj)