2021-12-14 09:44:12 +08:00
|
|
|
#!/usr/bin/env python
|
2024-06-12 04:19:07 +08:00
|
|
|
from misc.utility.scons_hints import *
|
2021-12-14 09:44:12 +08:00
|
|
|
|
2024-12-05 22:04:25 +08:00
|
|
|
import sys
|
|
|
|
|
2021-12-14 09:44:12 +08:00
|
|
|
Import("env")
|
|
|
|
Import("env_modules")
|
|
|
|
|
|
|
|
env_openxr = env_modules.Clone()
|
|
|
|
|
2023-02-16 21:47:31 +08:00
|
|
|
# Thirdparty source files
|
2021-12-14 09:44:12 +08:00
|
|
|
|
|
|
|
thirdparty_obj = []
|
|
|
|
|
2023-02-16 21:47:31 +08:00
|
|
|
# Khronos OpenXR loader
|
|
|
|
|
|
|
|
# Needs even for build against shared library, at least the defines used in public headers.
|
2021-12-14 09:44:12 +08:00
|
|
|
if env["platform"] == "android":
|
|
|
|
# may need to set OPENXR_ANDROID_VERSION_SUFFIX
|
2022-09-24 19:56:00 +08:00
|
|
|
env_openxr.AppendUnique(CPPDEFINES=["XR_OS_ANDROID", "XR_USE_PLATFORM_ANDROID"])
|
|
|
|
env_openxr.AppendUnique(CPPDEFINES=["JSON_USE_EXCEPTION=0"])
|
2021-12-14 09:44:12 +08:00
|
|
|
|
|
|
|
# may need to include java parts of the openxr loader
|
|
|
|
elif env["platform"] == "linuxbsd":
|
2022-09-24 19:56:00 +08:00
|
|
|
env_openxr.AppendUnique(CPPDEFINES=["XR_OS_LINUX"])
|
2022-07-20 09:42:15 +08:00
|
|
|
|
|
|
|
if env["x11"]:
|
2022-09-24 19:56:00 +08:00
|
|
|
env_openxr.AppendUnique(CPPDEFINES=["XR_USE_PLATFORM_XLIB"])
|
2022-07-20 09:42:15 +08:00
|
|
|
|
Add Wayland support
Not everything is yet implemented, either for Godot or personal
limitations (I don't have all hardware in the world). A brief list of
the most important issues follows:
- Single-window only: the `DisplayServer` API doesn't expose enough
information for properly creating XDG shell windows.
- Very dumb rendering loop: this is very complicated, just know that
the low consumption mode is forced to 2000 Hz and some clever hacks are
in place to overcome a specific Wayland limitation. This will be
improved to the extent possible both downstream and upstream.
- Features to implement yet: IME, touch input, native file dialog,
drawing tablet (commented out due to a refactor), screen recording.
- Mouse passthrough can't be implement through a poly API, we need a
rect-based one.
- The cursor doesn't yet support fractional scaling.
- Auto scale is rounded up when using fractional scaling as we don't
have a per-window scale query API (basically we need
`DisplayServer::window_get_scale`).
- Building with `x11=no wayland=yes opengl=yes openxr=yes` fails.
This also adds a new project property and editor setting for selecting the
default DisplayServer to start, to allow this backend to start first in
exported projects (X11 is still the default for now). The editor setting
always overrides the project setting.
Special thanks to Drew Devault, toger5, Sebastian Krzyszkowiak, Leandro
Benedet Garcia, Subhransu, Yury Zhuravlev and Mara Huldra.
2023-12-15 09:55:34 +08:00
|
|
|
if env["wayland"]:
|
2024-10-03 23:24:01 +08:00
|
|
|
env_openxr.AppendUnique(CPPDEFINES=["XR_USE_PLATFORM_EGL"])
|
Add Wayland support
Not everything is yet implemented, either for Godot or personal
limitations (I don't have all hardware in the world). A brief list of
the most important issues follows:
- Single-window only: the `DisplayServer` API doesn't expose enough
information for properly creating XDG shell windows.
- Very dumb rendering loop: this is very complicated, just know that
the low consumption mode is forced to 2000 Hz and some clever hacks are
in place to overcome a specific Wayland limitation. This will be
improved to the extent possible both downstream and upstream.
- Features to implement yet: IME, touch input, native file dialog,
drawing tablet (commented out due to a refactor), screen recording.
- Mouse passthrough can't be implement through a poly API, we need a
rect-based one.
- The cursor doesn't yet support fractional scaling.
- Auto scale is rounded up when using fractional scaling as we don't
have a per-window scale query API (basically we need
`DisplayServer::window_get_scale`).
- Building with `x11=no wayland=yes opengl=yes openxr=yes` fails.
This also adds a new project property and editor setting for selecting the
default DisplayServer to start, to allow this backend to start first in
exported projects (X11 is still the default for now). The editor setting
always overrides the project setting.
Special thanks to Drew Devault, toger5, Sebastian Krzyszkowiak, Leandro
Benedet Garcia, Subhransu, Yury Zhuravlev and Mara Huldra.
2023-12-15 09:55:34 +08:00
|
|
|
|
2021-12-14 09:44:12 +08:00
|
|
|
# FIXME: Review what needs to be set for Android and macOS.
|
2024-12-05 22:04:25 +08:00
|
|
|
# FreeBSD uses non-standard getenv functions.
|
|
|
|
if not sys.platform.startswith("freebsd"):
|
|
|
|
env_openxr.AppendUnique(CPPDEFINES=["HAVE_SECURE_GETENV"])
|
2021-12-14 09:44:12 +08:00
|
|
|
elif env["platform"] == "windows":
|
2022-09-24 19:56:00 +08:00
|
|
|
env_openxr.AppendUnique(CPPDEFINES=["XR_OS_WINDOWS", "NOMINMAX", "XR_USE_PLATFORM_WIN32"])
|
2023-07-18 22:02:47 +08: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
|
|
|
|
|
2021-12-14 09:44:12 +08:00
|
|
|
|
2022-09-24 19:56:00 +08:00
|
|
|
# may need to check and set:
|
|
|
|
# - XR_USE_TIMESPEC
|
2021-12-14 09:44:12 +08:00
|
|
|
|
2023-02-16 21:47:31 +08: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()
|
2023-08-14 19:02:40 +08:00
|
|
|
|
2023-02-16 21:47:31 +08:00
|
|
|
env_thirdparty.AppendUnique(CPPDEFINES=["DISABLE_STD_FILESYSTEM"])
|
2023-08-14 19:02:40 +08:00
|
|
|
if env["disable_exceptions"]:
|
|
|
|
env_thirdparty.AppendUnique(CPPDEFINES=["XRLOADER_DISABLE_EXCEPTION_HANDLING", ("JSON_USE_EXCEPTION", 0)])
|
2023-02-16 21:47:31 +08: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 = []
|
2023-10-26 15:25:05 +08:00
|
|
|
env_thirdparty.add_source_files(khrloader_obj, thirdparty_dir + "/src/xr_generated_dispatch_table_core.c")
|
2023-02-16 21:47:31 +08:00
|
|
|
|
|
|
|
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
|
2021-12-14 09:44:12 +08:00
|
|
|
|
|
|
|
module_obj = []
|
|
|
|
|
|
|
|
env_openxr.add_source_files(module_obj, "*.cpp")
|
2023-12-27 11:49:25 +08:00
|
|
|
env.modules_sources += module_obj
|
2021-12-14 09:44:12 +08:00
|
|
|
|
2023-12-27 11:49:25 +08:00
|
|
|
Export("env_openxr")
|
2022-03-09 16:09:25 +08:00
|
|
|
|
2023-12-27 11:49:25 +08:00
|
|
|
SConscript("action_map/SCsub")
|
|
|
|
SConscript("extensions/SCsub")
|
|
|
|
SConscript("scene/SCsub")
|
2021-12-14 09:44:12 +08:00
|
|
|
|
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 14:28:55 +08:00
|
|
|
if env.editor_build:
|
2022-03-17 07:24:47 +08:00
|
|
|
SConscript("editor/SCsub")
|
|
|
|
|
2021-12-14 09:44:12 +08:00
|
|
|
# Needed to force rebuilding the module files when the thirdparty library is updated.
|
|
|
|
env.Depends(module_obj, thirdparty_obj)
|