godotengine/godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
a88b4a4d56
godot/thirdparty/README.md

30 KiB
Vendored
Raw Blame History

Third party libraries

Please keep categories (## level) listed alphabetically and matching their respective folder names. Use two empty lines to separate categories for readability.

amd-fsr

Files extracted from upstream source:

  • ffx_a.h and ffx_fsr1.h from ffx-fsr
  • license.txt

amd-fsr2

Files extracted from upstream source:

  • ffx_*.cpp and ffx_*.h from src/ffx-fsr2-api
  • shaders folder from src/ffx-fsr2-api with ffx_*.hlsl files excluded
  • LICENSE.txt

Apply patches to add the new options required by Godot and general compilation fixes.

angle

Files extracted from upstream source:

  • include/*
  • LICENSE

astcenc

Files extracted from upstream source:

  • astcenc_* and astcenc.h files from Source
  • LICENSE.txt

basis_universal

Files extracted from upstream source:

  • encoder/ and transcoder/ folders, minus jpgd.{cpp,h}
  • LICENSE

Applied upstream PR https://github.com/BinomialLLC/basis_universal/pull/344 to fix build with our own copy of zstd (patch in patches).

brotli

Files extracted from upstream source:

  • common/, dec/ and include/ folders from c/, minus the dictionary.bin* files
  • LICENSE

certs

clipper2

Files extracted from upstream source:

  • CPP/Clipper2Lib/ folder (in root)
  • LICENSE

Apply the patches in the patches/ folder when syncing on newer upstream commits.

cvtt

Files extracted from upstream source:

  • All .cpp and .h files except the folders MakeTables and etc2packer
  • LICENSE.txt

Changes related to BC6H packing and unpacking made upstream in 2e4b6b2747 have been removed as they caused massive quality regressions. Apply the patches in the patches/ folder when syncing on newer upstream commits.

d3d12ma

Files extracted from upstream source:

  • src/D3D12MemAlloc.cpp, src/D3D12MemAlloc.natvis
  • include/D3D12MemAlloc.h
  • LICENSE.txt, NOTICES.txt

Important: Some files have Godot-made changes for use with MinGW. They are marked with /* GODOT start */ and /* GODOT end */ comments.

directx_headers

Files extracted from upstream source:

  • include/directx/*.h
  • include/dxguids/*.h
  • LICENSE

Important: Some files have Godot-made changes for use with MinGW. They are marked with /* GODOT start */ and /* GODOT end */ comments.

doctest

Files extracted from upstream source:

  • doctest/doctest.h as doctest.h
  • LICENSE.txt

embree

Files extracted from upstream:

  • All .cpp files listed in modules/raycast/godot_update_embree.py
  • All header files in the directories listed in modules/raycast/godot_update_embree.py
  • All config files listed in modules/raycast/godot_update_embree.py
  • LICENSE.txt

The modules/raycast/godot_update_embree.py script can be used to pull the relevant files from the latest Embree release and apply some automatic changes.

Some changes have been made in order to remove exceptions and fix minor build errors. They are marked with // -- GODOT start -- and // -- GODOT end -- comments. Apply the patches in the patches/ folder when syncing on newer upstream commits.

enet

Files extracted from upstream source:

  • All .c files in the main directory (except unix.c and win32.c)
  • The include/enet/ folder as enet/ (except unix.h and win32.h)
  • LICENSE file

Important: enet.h, host.c, protocol.c have been slightly modified to be usable by Godot's socket implementation and allow IPv6 and DTLS. Apply the patches in the patches/ folder when syncing on newer upstream commits.

Three files (godot.cpp, enet/godot.h, enet/godot_ext.h) have been added to provide ENet socket implementation using Godot classes.

It is still possible to build against a system wide ENet but doing so will limit its functionality to IPv4 only.

etcpak

Files extracted from upstream source:

  • Only the files relevant for compression (i.e. Process*.cpp and their deps): 
    Dither.{cpp,hpp} ForceInline.hpp Math.hpp ProcessCommon.hpp ProcessRGB.{cpp,hpp}
ProcessDxtc.{cpp,hpp} Tables.{cpp,hpp} Vector.hpp
  • AUTHORS.txt and LICENSE.txt

fonts

All fonts are converted from the unhinted .ttf sources using the https://github.com/google/woff2 tool.

Use UI font variant if available, because it has tight vertical metrics and good for UI.

freetype

  • Upstream: https://www.freetype.org
  • Version: 2.13.2 (920c5502cc3ddda88f6c7d85ee834ac611bb11cc, 2023)
  • License: FreeType License (BSD-like)

Files extracted from upstream source:

  • src/ folder, minus the dlg and tools subfolders
    • These files can be removed: .dat, .diff, .mk, .rc, README*
    • In src/gzip/, keep only ftgzip.c
  • include/ folder, minus the dlg subfolder
  • LICENSE.TXT and docs/FTL.TXT

glad

Files extracted from upstream source:

  • LICENSE

Files generated from upstream web instance:

  • EGL/eglplatform.h
  • KHR/khrplatform.h
  • egl.c
  • glad/egl.h
  • gl.c
  • glad/gl.h
  • glx.c
  • glad/glx.h

See the permalinks in glad/gl.h and glad/glx.h to regenrate the files with a new version of the web instance.

Some changes have been made in order to allow loading OpenGL and OpenGLES APIs at the same time. See the patches in the patches directory.

glslang

Version should be kept in sync with the one of the used Vulkan SDK (see vulkan section).

Files extracted from upstream source:

  • glslang/ folder (except the glslang/HLSL and glslang/ExtensionHeaders subfolders), SPIRV/ folder
    • Remove C interface code: CInterface/ folders, files matching "*_c[_\.]*"
  • Run cmake . && make and copy generated include/glslang/build_info.h to glslang/build_info.h
  • LICENSE.txt
  • Unnecessary files like CMakeLists.txt or updateGrammar removed

graphite

Files extracted from upstream source:

  • The include folder
  • The src folder (minus CMakeLists.txt and files.mk)
  • COPYING

harfbuzz

Files extracted from upstream source:

  • AUTHORS, COPYING, THANKS
  • From the src folder, recursively:
    • All the .c, .cc, .h, .hh files
    • Except main.cc, harfbuzz*.cc, failing-alloc.c, test*.cc, hb-wasm*.*, and the wasm folder

icu4c

Files extracted from upstream source:

  • The common folder
  • scriptset.*, ucln_in.*, uspoof.cpp" and uspoof_impl.cpp from the i18n folder
  • uspoof.h from the i18n/unicode folder
  • LICENSE

Files generated from upstream source:

  1. Download and extract both icu4c-{version}-src.tgz and icu4c-{version}-data.zip (replace data subfolder from the main source archive)
  2. Build ICU with default options: ./runConfigureICU {PLATFORM} && make
  3. Reconfigure ICU with custom data config: ICU_DATA_FILTER_FILE={GODOT_SOURCE}/thirdparty/icu4c/godot_data.json ./runConfigureICU {PLATFORM} --with-data-packaging=common
  4. Delete data/out folder and rebuild data: cd data && rm -rf ./out && make
  5. Copy source/data/out/icudt74l.dat to the {GODOT_SOURCE}/thirdparty/icu4c/icudt74l.dat

jpeg-compressor

Files extracted from upstream source:

  • jpgd*.{c,h}
  • jpge*.{c,h}

libktx

Files extracted from upstream source:

  • LICENSE.md
  • include/*
  • lib/dfdutils/LICENSE.adoc as LICENSE.dfdutils.adoc (in root)
  • lib/dfdutils/LICENSES/Apache-2.0.txt as Apache-2.0.txt (in root)
  • lib/dfdutils/{KHR/*,dfd.h,colourspaces.c,createdfd.c,interpretdfd.c,printdfd.c,queries.c,dfd2vk.inl,vk2dfd.*}
  • lib/{basis_sgd.h,formatsize.h,gl_format.h,ktxint.h,uthash.h,vk_format.h,vkformat_enum.h,checkheader.c,swap.c,hashlist.c,vkformat_check.c,basis_transcode.cpp,miniz_wrapper.cpp,filestream.*,memstream.*,texture*}
  • other_include/KHR/*
  • utils/unused.h

Some Godot-specific changes are applied via patches included in the patches folder.

libogg

  • Upstream: https://www.xiph.org/ogg
  • Version: 1.3.5 (e1774cd77f471443541596e09078e78fdc342e4f, 2021)
  • License: BSD-3-Clause

Files extracted from upstream source:

  • src/*.{c,h}
  • include/ogg/*.h in ogg/ (run configure to generate config_types.h)
  • COPYING

libpng

Files extracted from upstream source:

  • All .c and .h files of the main directory, apart from example.c and pngtest.c
  • arm/, intel/ and powerpc/ folders
  • scripts/pnglibconf.h.prebuilt as pnglibconf.h
  • LICENSE

libtheora

  • Upstream: https://www.theora.org
  • Version: git (7180717276af1ebc7da15c83162d6c5d6203aabf, 2020)
  • License: BSD-3-Clause

Files extracted from upstream source:

  • All .c and .h files in lib/, except arm/ and c64x/ folders
  • All .h files in include/theora/ as theora/
  • COPYING and LICENSE

libvorbis

Files extracted from upstream source:

  • lib/* except from: lookups.pl, Makefile.*
  • include/vorbis/*.h as vorbis/
  • COPYING

libwebp

Files extracted from upstream source:

  • src/ and sharpyuv/ except from .am, .rc and .in files
  • AUTHORS, COPYING, PATENTS

Patch godot-node-debug-fix.patch workarounds shadowing of Godot's Node class in the MSVC debugger.

mbedtls

File extracted from upstream release tarball:

  • All .h from include/mbedtls/ to thirdparty/mbedtls/include/mbedtls/ except config_psa.h and psa_util.h
  • All .c and .h from library/ to thirdparty/mbedtls/library/ except those starting with psa_*
  • The LICENSE file (edited to keep only the Apache 2.0 variant)
  • Applied the patch windows-arm64-hardclock.diff to fix Windows ARM64 build Applied the patch windows-entropy-bcrypt.diff to fix Windows Store support
  • Added 2 files godot_core_mbedtls_platform.c and godot_core_mbedtls_config.h providing configuration for light bundling with core
  • Added the file godot_module_mbedtls_config.h to customize the build configuration when bundling the full library

meshoptimizer

Files extracted from upstream repository:

  • All files in src/
  • LICENSE.md

A patch is included to modify the simplifier to report only distance error metrics instead of a combination of distance and attribute errors.

mingw-std-threads

Files extracted from upstream repository:

  • LICENSE
  • mingw.condition_variable.h
  • mingw.invoke.h
  • mingw.mutex.h
  • mingw.shared_mutex.h
  • mingw.thread.h

Once copied, apply godot.patch (needed because Godot is built without exceptions and to avoid std:: replacements leak in Clang builds).

minimp3

Files extracted from upstream repository:

  • minimp3.h
  • minimp3_ex.h
  • LICENSE

Some changes have been made in order to fix Windows on ARM build errors, and to solve some MSVC warnings. See the patches in the patches directory.

miniupnpc

Files extracted from upstream source:

  • Copy miniupnpc/src and miniupnpc/include to thirdparty/miniupnpc
  • Remove the following test or sample files: listdevices.c,minihttptestserver.c,miniupnpcmodule.c,upnpc.c,upnperrors.*,test*
  • LICENSE

The only modified file is src/miniupnpcstrings.h, which was created for Godot (it is usually autogenerated by cmake). Bump the version number for miniupnpc in that file when upgrading.

minizip

Files extracted from the upstream source:

  • From contrib/minizip: {crypt.h,ioapi.{c,h},unzip.{c,h},zip.{c,h}} MiniZip64_info.txt

Important: Some files have Godot-made changes for use in core/io. They are marked with /* GODOT start */ and /* GODOT end */ comments and a patch is provided in the patches folder.

misc

Collection of single-file libraries used in Godot components.

msdfgen

Files extracted from the upstream source:

  • msdfgen.h
  • Files in core/ folder
  • LICENSE.txt

noise

Files extracted from the upstream source:

  • FastNoiseLite.h
  • LICENSE

Some custom changes were made to fix compiler warnings, and can be re-applied with the provided patch.

nvapi

openxr

Files extracted from upstream source:

  • include/
  • src/common/
  • src/loader/
  • src/*.{c,h}
  • src/external/jsoncpp/include/
  • src/external/jsoncpp/src/lib_json/
  • src/external/jsoncpp/{AUTHORS,LICENSE}
  • LICENSE and COPYING.adoc

Exclude:

  • src/external/android-jni-wrappers and src/external/jnipp (not used yet)
  • Obsolete src/xr_generated_dispatch_table.{c,h}
  • All CMake stuff: cmake/, CMakeLists.txt and *.cmake
  • All Gradle stuff: *gradle*, AndroidManifest.xml
  • All following files (and their .license files): *.{def,expsym,in,json,map,pom,rc,txt}
  • All dotfiles

pcre2

  • Upstream: http://www.pcre.org
  • Version: 10.43 (3864abdb713f78831dd12d898ab31bbb0fa630b6, 2024)
  • License: BSD-3-Clause

Files extracted from upstream source:

  • Files listed in the file NON-AUTOTOOLS-BUILD steps 1-4
  • All .h files in src/ apart from pcre2posix.h
  • src/pcre2_jit_match.c
  • src/pcre2_jit_misc.c
  • src/pcre2_ucptables.c
  • src/sljit/
  • AUTHORS and LICENCE

recastnavigation

Files extracted from upstream source:

  • Recast/ folder without CMakeLists.txt
  • License.txt

rvo2

For 2D in rvo2_2d folder

For 3D in rvo2_3d folder

Files extracted from upstream source:

  • All .cpp and .h files in the src/ folder except for Export.h and RVO.h
  • LICENSE

Important: Nearly all files have Godot-made changes and renames to make the 2D and 3D rvo libraries compatible with each other and solve conflicts and also enrich the feature set originally proposed by these libraries and better integrate them with Godot.

spirv-reflect

Version should be kept in sync with the one of the used Vulkan SDK (see vulkan section).

Files extracted from upstream source:

  • spirv_reflect.h, spirv_reflect.c
  • include/ folder
  • LICENSE

Some downstream changes have been made and are identified by // -- GODOT begin -- and // -- GODOT end -- comments. They can be reapplied using the patches included in the patches folder.

squish

Files extracted from upstream source:

  • All .cpp, .h and .inl files

Important: Some files have Godot-made changes. They are marked with // -- GODOT start -- and // -- GODOT end -- comments and a patch is provided in the squish/ folder.

tinyexr

Files extracted from upstream source:

  • tinyexr.{cc,h}

The tinyexr.cc file was modified to include zlib.h which we provide, instead of miniz.h as an external dependency.

thorvg

Files extracted from upstream source:

See thorvg/update-thorvg.sh for extraction instructions. Set the version number and run the script.

ufbx

Files extracted from upstream source:

  • ufbx.{c,h}
  • LICENSE

vhacd

Files extracted from upstream source:

  • From src/VHACD_Lib/: inc, public and src
  • LICENSE

Some downstream changes have been made and are identified by // -- GODOT start -- and // -- GODOT end -- comments. They can be reapplied using the patches included in the vhacd folder.

volk

Unless there is a specific reason to package a more recent version, please stick to tagged releases. All Vulkan libraries and headers should be kept in sync so:

  • Update Vulkan SDK components to the matching tag (see "vulkan")
  • Update glslang (see "glslang")
  • Update spirv-reflect (see "spirv-reflect")

Files extracted from upstream source:

  • volk.h, volk.c
  • LICENSE.md

vulkan

The vendored version should be kept in sync with volk, see above.

Files extracted from upstream source:

  • include/
  • LICENSE.md

vk_enum_string_helper.h is taken from the matching Vulkan-Utility-Libraries SDK release: https://github.com/KhronosGroup/Vulkan-Utility-Libraries/blob/main/include/vulkan/vk_enum_string_helper.h

vk_mem_alloc.h is taken from https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator Version: git (38627f4e37d7a9b13214fd267ec60e0e877e3997, 2024), as advised by upstream: https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator/issues/318#issuecomment-1411804981 vk_mem_alloc.cpp is a Godot file and should be preserved on updates.

Patches in the patches directory should be re-applied after updates.

wayland

Files extracted from upstream source:

  • protocol/wayland.xml
  • COPYING

wayland-protocols

Files extracted from upstream source:

  • stable/viewporter/README
  • stable/viewporter/viewporter.xml
  • stable/xdg-shell/README
  • stable/xdg-shell/xdg-shell.xml
  • staging/fractional-scale/README
  • staging/fractional-scale/fractional-scale-v1.xml
  • staging/xdg-activation/README
  • staging/xdg-activation/xdg-activation-v1.xml
  • unstable/idle-inhibit/README
  • unstable/idle-inhibit/idle-inhibit-unstable-v1.xml
  • unstable/pointer-constraints/README
  • unstable/pointer-constraints/pointer-constraints-unstable-v1.xml
  • unstable/pointer-gestures/README
  • unstable/pointer-gestures/pointer-gestures-unstable-v1.xml
  • unstable/primary-selection/README
  • unstable/primary-selection/primary-selection-unstable-v1.xml
  • unstable/relative-pointer/README
  • unstable/relative-pointer/relative-pointer-unstable-v1.xml
  • unstable/tablet/README
  • unstable/tablet/tablet-unstable-v2.xml
  • unstable/xdg-decoration/README
  • unstable/xdg-decoration/xdg-decoration-unstable-v1.xml
  • unstable/xdg-foreign/README
  • unstable/xdg-foreign/xdg-foreign-unstable-v1.xml
  • COPYING

wslay

File extracted from upstream release tarball:

  • Run cmake . to generate config.h and wslayver.h Contents might need tweaking for Godot, review diff
  • All .c and .h files from lib/
  • All .h in lib/includes/wslay/ as wslay/
  • wslay/wslay.h has a small Godot addition to fix MSVC build See patches/msvcfix.diff
  • COPYING

xatlas

Files extracted from upstream source:

  • source/xatlas/xatlas.{cpp,h}
  • LICENSE

zlib

Files extracted from upstream source:

  • All .c and .h files, minus infback.c
  • LICENSE

zstd

Files extracted from upstream source:

  • lib/{common/,compress/,decompress/,zstd.h,zstd_errors.h}
  • LICENSE