2019-09-27 02:16:44 +00:00
|
|
|
#!/usr/bin/env python
|
2024-06-11 20:19:07 +00:00
|
|
|
from misc.utility.scons_hints import *
|
2019-09-27 02:16:44 +00:00
|
|
|
|
2020-03-30 06:28:32 +00:00
|
|
|
Import("env")
|
|
|
|
Import("env_modules")
|
2019-09-27 02:16:44 +00:00
|
|
|
|
2019-09-27 12:43:04 +00:00
|
|
|
env_basisu = env_modules.Clone()
|
2019-09-27 07:05:04 +00:00
|
|
|
|
|
|
|
# Thirdparty source files
|
2020-12-17 15:01:36 +00:00
|
|
|
|
|
|
|
thirdparty_obj = []
|
|
|
|
|
2019-09-27 07:05:04 +00:00
|
|
|
# Not unbundled so far since not widespread as shared library
|
|
|
|
thirdparty_dir = "#thirdparty/basis_universal/"
|
2021-05-07 15:00:41 +00:00
|
|
|
# Sync list with upstream CMakeLists.txt
|
|
|
|
encoder_sources = [
|
2024-09-28 10:05:45 +00:00
|
|
|
"3rdparty/android_astc_decomp.cpp",
|
|
|
|
"basisu_astc_hdr_enc.cpp",
|
2020-03-30 06:28:32 +00:00
|
|
|
"basisu_backend.cpp",
|
|
|
|
"basisu_basis_file.cpp",
|
2021-05-07 15:00:41 +00:00
|
|
|
"basisu_bc7enc.cpp",
|
2022-03-24 19:39:24 +00:00
|
|
|
"basisu_opencl.cpp",
|
2020-03-30 06:28:32 +00:00
|
|
|
"basisu_comp.cpp",
|
|
|
|
"basisu_enc.cpp",
|
|
|
|
"basisu_etc.cpp",
|
|
|
|
"basisu_frontend.cpp",
|
|
|
|
"basisu_gpu_texture.cpp",
|
2021-05-07 15:00:41 +00:00
|
|
|
"basisu_kernels_sse.cpp",
|
2020-03-30 06:28:32 +00:00
|
|
|
"basisu_pvrtc1_4.cpp",
|
|
|
|
"basisu_resampler.cpp",
|
2021-05-07 15:00:41 +00:00
|
|
|
"basisu_resample_filters.cpp",
|
2020-03-30 06:28:32 +00:00
|
|
|
"basisu_ssim.cpp",
|
2021-05-07 15:00:41 +00:00
|
|
|
"basisu_uastc_enc.cpp",
|
2022-03-24 19:39:24 +00:00
|
|
|
"pvpngreader.cpp",
|
2019-09-27 07:05:04 +00:00
|
|
|
]
|
2021-05-07 15:00:41 +00:00
|
|
|
encoder_sources = [thirdparty_dir + "encoder/" + file for file in encoder_sources]
|
2019-09-27 07:05:04 +00:00
|
|
|
transcoder_sources = [thirdparty_dir + "transcoder/basisu_transcoder.cpp"]
|
|
|
|
|
2020-02-13 14:53:32 +00:00
|
|
|
# Treat Basis headers as system headers to avoid raising warnings. Not supported on MSVC.
|
|
|
|
if not env.msvc:
|
2024-02-18 17:48:14 +00:00
|
|
|
env_basisu.Append(
|
|
|
|
CPPFLAGS=["-isystem", Dir(thirdparty_dir).path, "-isystem", Dir("#thirdparty/jpeg-compressor").path]
|
|
|
|
)
|
2020-02-13 14:53:32 +00:00
|
|
|
else:
|
2024-02-18 17:48:14 +00:00
|
|
|
env_basisu.Prepend(CPPPATH=[thirdparty_dir, "#thirdparty/jpeg-compressor"])
|
2019-09-27 02:16:44 +00:00
|
|
|
|
2023-02-16 11:15:16 +00:00
|
|
|
if env["builtin_zstd"]:
|
|
|
|
env_basisu.Prepend(CPPPATH=["#thirdparty/zstd"])
|
|
|
|
|
2024-09-28 10:05:45 +00:00
|
|
|
env_basisu.Prepend(CPPPATH=["#thirdparty/tinyexr"])
|
|
|
|
|
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.dev_build:
|
2021-05-07 15:00:41 +00:00
|
|
|
env_basisu.Append(CPPDEFINES=[("BASISU_DEVEL_MESSAGES", 1), ("BASISD_ENABLE_DEBUG_FLAGS", 1)])
|
2019-09-27 02:16:44 +00:00
|
|
|
|
2019-09-27 12:43:04 +00:00
|
|
|
env_thirdparty = env_basisu.Clone()
|
2019-09-27 07:05:04 +00:00
|
|
|
env_thirdparty.disable_warnings()
|
2022-05-14 22:02:52 +00:00
|
|
|
|
|
|
|
# Disable unneeded features to reduce binary size.
|
|
|
|
# <https://github.com/BinomialLLC/basis_universal/wiki/How-to-Use-and-Configure-the-Transcoder>
|
|
|
|
env_thirdparty.Append(
|
|
|
|
CPPDEFINES=[
|
|
|
|
# Storage formats.
|
|
|
|
# Godot only implements `.basis` support through basis_universal.
|
|
|
|
# Support for `.ktx` files are implemented with a direct libktx implementation.
|
|
|
|
# Building the encoder requires `BASISD_SUPPORT_KTX2` to be enabled,
|
|
|
|
# so we can only disable Zstandard compression for `.ktx` files
|
|
|
|
# (this is not used in `.basis` files).
|
|
|
|
("BASISD_SUPPORT_KTX2_ZSTD", 0),
|
|
|
|
# GPU compression formats.
|
|
|
|
("BASISD_SUPPORT_ATC", 0), # Proprietary Adreno format not supported by Godot.
|
|
|
|
("BASISD_SUPPORT_FXT1", 0), # Legacy format not supported by Godot.
|
|
|
|
("BASISD_SUPPORT_PVRTC1", 0), # Legacy format not supported by Godot.
|
|
|
|
("BASISD_SUPPORT_PVRTC2", 0), # Legacy format not supported by Godot.
|
|
|
|
]
|
|
|
|
)
|
|
|
|
|
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:
|
2021-05-07 15:00:41 +00:00
|
|
|
env_thirdparty.Append(CPPDEFINES=["BASISU_NO_IMG_LOADERS"])
|
|
|
|
env_thirdparty.add_source_files(thirdparty_obj, encoder_sources)
|
2020-12-17 15:01:36 +00:00
|
|
|
env_thirdparty.add_source_files(thirdparty_obj, transcoder_sources)
|
|
|
|
env.modules_sources += thirdparty_obj
|
2019-09-27 02:16:44 +00:00
|
|
|
|
2019-09-27 07:05:04 +00:00
|
|
|
# Godot source files
|
2020-12-17 15:01:36 +00:00
|
|
|
|
|
|
|
module_obj = []
|
|
|
|
|
|
|
|
env_basisu.add_source_files(module_obj, "*.cpp")
|
|
|
|
env.modules_sources += module_obj
|
|
|
|
|
|
|
|
# Needed to force rebuilding the module files when the thirdparty library is updated.
|
|
|
|
env.Depends(module_obj, thirdparty_obj)
|