mirror/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-12-09 10:09:20 +08:00
Code Issues Packages Projects Releases Wiki Activity
d744d3046e
godot/thirdparty/README.md
Rémi Verschelde d744d3046e vulkan: Re-add option to build Vulkan-Loader statically 
Upstream removed the option in KhronosGroup/Vulkan-Loader#260, which
breaks our current use case.
This commit reverts KhronosGroup/Vulkan-Loader#260 is our vendored
loader.

We may need to re-evaluate how we link the loader, but until then,
reverting this PR fixes Windows support after the upgrade to a recent
SDK version in #36932.
2020-03-09 15:25:54 +01:00

15 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. Subcategories (### level) where needed are separated by a single empty line.

assimp

Files extracted from upstream source:

  • Run cmake . in root folder to generate files
  • code/{CApi,Common,FBX,Material,PostProcessing}/
  • contrib/utf8cpp/source/
  • include/
  • revision.h
  • CREDITS and LICENSE files
  • rm -f code/Common/ZipArchiveIOSystem.cpp include/assimp/ZipArchiveIOSystem.h include/assimp/irrXMLWrapper.h

basis_universal

Files extracted from upstream source:

  • .cpp and .h files in root folder
  • .cpp, .h and .inc files in transcoder/, keeping folder structure
  • LICENSE

bullet

Files extracted from upstream source:

  • src/* apart from CMakeLists.txt and premake4.lua files
  • LICENSE.txt

certs

File extracted from a recent Fedora install: /etc/pki/ca-trust/extracted/pem/tls-ca-bundle.pem (It can't be extracted directly from the package, as it's generated on the user's system.)

cvtt

Files extracted from upstream source:

  • all .cpp, .h, and .txt files in ConvectionKernels/

enet

Files extracted from upstream source:

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

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

Two files (godot.cpp and enet/godot.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 it's functionality to IPv4 only.

etc2comp

Files extracted from upstream source:

  • all .cpp and .h files in EtcLib/
  • README.md, LICENSE, AUTHORS

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

fonts

Noto Sans

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

Hack Regular

DroidSans*.ttf

freetype

Files extracted from upstream source:

  • the src/ folder, stripped of the Jamfile files and the tools subfolder
  • the include/ folder
  • docs/{FTL.TXT,LICENSE.TXT}

glad

The files we package are automatically generated. See the header of glad.c for instructions on how to generate them for the GLES version Godot targets.

glslang

Version should be kept in sync with the one of the used Vulkan SDK (see vulkan section). Check Vulkan-ValidationLayers at the matching SDK tag for the known good glslang commit: https://github.com/KhronosGroup/Vulkan-ValidationLayers/blob/master/scripts/known_good.json

Files extracted from upstream source:

  • glslang, OGLCompilersDLL, SPIRV
  • LICENSE.txt
  • Unnecessary files like CMakeLists.txt, revision.template and updateGrammar removed.

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

jpeg-compressor

Files extracted from upstream source:

  • jpgd.{c,h}

libogg

Files extracted from upstream source:

  • src/*.{c,h}
  • include/ogg/*.h in ogg/
  • COPYING

libpng

Files extracted from upstream source:

  • all .c and .h files of the main directory, except from example.c and pngtest.c
  • the arm/ folder
  • scripts/pnglibconf.h.prebuilt as pnglibconf.h
  • LICENSE

libsimplewebm

This contains libwebm, but the version in use is updated from the one used by libsimplewebm, and may have unmarked alterations from that.

Files extracted from upstream source:

  • all the .cpp, .hpp files in the main folder except example.cpp
  • LICENSE

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

libtheora

Files extracted from upstream source:

  • all .c, .h in lib/
  • all .h files in include/theora/ as theora/
  • COPYING and LICENSE

Upstream patches included in the patches directory have been applied on top of the 1.1.1 source (not included in any stable release yet).

libvorbis

Files extracted from upstream source:

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

libvpx

Files extracted from upstream source:

TODO.

Important: File libvpx/vpx_dsp/x86/vpx_subpixel_8t_intrin_avx2.c has Godot-made change marked with // -- GODOT -- comments.

The files libvpx/third_party/android/cpu-features.{c,h} were copied from the Android NDK r18.

libwebp

Files extracted from upstream source:

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

Important: The files utils/bit_reader_utils.{c,h} have Godot-made changes to ensure they build for Javascript/HTML5. Those changes are marked with // -- GODOT -- comments.

mbedtls

File extracted from upstream release tarball (-apache.tgz variant):

  • All *.h from include/mbedtls/ to thirdparty/mbedtls/include/mbedtls/
  • All *.c from library/ to thirdparty/mbedtls/library/
  • LICENSE and apache-2.0.txt files
  • Applied the patch in thirdparty/mbedtls/patches/1453.diff (PR 1453). Soon to be merged upstream. Check it out at next update.
  • Added 2 files godot_core_mbedtls_platform.{c,h} providing configuration for light bundling with core.

miniupnpc

Files extracted from upstream source:

  • All *.c and *.h files from miniupnpc to thirdparty/miniupnpc/miniupnpc
  • Remove test*, minihttptestserver.c and wingenminiupnpcstrings.c

The patch windows_fix.diff is applied to minissdpc.c to fix an upstream issue. The only modified file is miniupnpcstrings.h, which was created for Godot (it is usually autogenerated by cmake).

minizip

Files extracted from the upstream source:

  • contrib/minizip/{crypt.h,ioapi.{c,h},zip.{c,h},unzip.{c,h}}

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 minizip/ folder.

misc

Collection of single-file libraries used in Godot components.

core

modules

platform

scene

nanosvg

Files extracted from the upstream source:

  • All .h files in src/
  • LICENSE.txt

opus

Files extracted from upstream source:

  • all .c and .h files in src/ (both opus and opusfile)
  • all .h files in include/ (both opus and opusfile) as opus/
  • remove unused opus_demo.c,
  • remove http.c, wincerts.c and winerrno.h (part of unused libopusurl)
  • celt/ and silk/ subfolders
  • COPYING

pcre2

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_compile.c
  • src/pcre2_jit_match.c
  • src/pcre2_jit_misc.c
  • src/sljit/*
  • AUTHORS and LICENCE

pvrtccompressor

Files extracted from upstream source:

  • all .cpp and .h files apart from main.cpp
  • LICENSE.TXT

recastnavigation

Files extracted from upstream source:

  • Recast/ folder
  • License.txt

Rvo2

Files extracted from upstream source:

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

Important: Some files have Godot-made changes; so to enrich the features originally proposed by this library and better integrate this library with Godot. Please check the file to know what's new.

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}

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.

vulkan

Unless there is a specific reason to package a more recent version, please stick to Vulkan SDK releases (prefixed by sdk-) for all components.

NOTE: Use scripts/update_deps.py --ref <version> in the Loader git repository to retrieve the Vulkan-Headers repository matching the loader version.

Files extracted from upstream source:

  • Vulkan-Headers/include/ as include/
  • All .c and .h files in loader/ and loader/generated/, put in a common loader/ folder
  • LICENSE.txt

vk_enum_string_helper.h is taken from the matching Vulkan-ValidationLayers SDK release: https://github.com/KhronosGroup/Vulkan-ValidationLayers/blob/master/layers/generated/vk_enum_string_helper.h

vk_mem_alloc.h is taken from https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator Version: 2.3.0

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

wslay

File extracted from upstream release tarball:

  • All *.c and *.h in lib/ and lib/includes/
  • wslay.h has a small Godot addition to fix MSVC build. See thirdparty/wslay/msvcfix.diff

xatlas

Files extracted from upstream source:

  • xatlas.{cpp,h}
  • LICENSE

zlib

Files extracted from upstream source:

  • all .c and .h files

zstd

Files extracted from upstream source:

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