godot/thirdparty/README.md
Andrii Doroshenko (Xrayez) 9bf48db891 Build Clipper with tools=no and patch it to auto-disable exceptions
Reverts "Build polygon clipper only in tools builds" (see #17319)
which allows to build Clipper with tools disabled (release) and because
of that, Clipper has to be patched to optionally disable exceptions in
order to be built on some platforms.

Patched Clipper 6.4.2 to be compiled with exceptions enabled/disabled.
and ensure that Clipper-specific exception macros are defined: don't use
exceptions by default unless exception handling is detected.

Compilation with exceptions will be determined by various
C++ exceptions defines:

* ` __cpp_exceptions` is part of C++ feature testing macros (since C++98);
* `__EXCEPTIONS` is used by some GNU compilers;
* `_CPPUNWIND` is used by MSVC.

The user can override specific exceptions behavior via corresponding
`*_USER` macros (i.e. compiling for embedded systems).
2019-05-22 13:12:21 +03:00

14 KiB
Vendored

Third party libraries

assimp

b2d_convexdecomp

The files were adapted to Godot by removing the dependency on b2Math (replacing it by b2Glue.h) and commenting out some verbose printf calls. Upstream code has not changed in 10 years, no need to keep track of changes.

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

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. 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. Check the diff of enet.h, protocol.c, and host.c with the 1.3.13 tarball before the next update.

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
  • 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.

jpeg-compressor

Files extracted from upstream source:

  • jpgd.{c,h}

libogg

Files extracted from upstream source:

  • src/*.c
  • 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.

libwebsockets

File extracted from upstream source:

  • From lib/ into thirdparty/libwebsockets:
    • Everything from core
    • From event-libs only the poll subfolder
    • From misc only base64-decode.c, getifaddrs.c, getifaddrs.h, lejp.c, and sha-1.c
    • From plat only lws-plat-unix.c and lws-plat-win.c
    • From roles only private.h, h1, http, listen, pipe, raw, ws
      • From roles/http exclude minilex.c
      • From roles/http/server exclude access-log.c, lws-spa.c, ranges.c, and rewrite.c
      • From roles/ws exclude ext folder.
    • From tls exclude openssl folder.
  • Also copy win32helpers/ from win32port/ inside thirdparty/libwebsockets
  • A fix has been added to allow building for 32-bits UWP, replacing GetFileSize[Ex] and CreateFileW with supported functions. There is a diff for this change in thirdparty/libwebsockets/uwp_fixes.diff
  • A fix to disable V6ONLY flag from IPv6 sockets (on by default on some systems) has been also applied. The diff for this change can be found in thirdparty/libwebsockets/ipv6_fixes.diff

Important: lws_config.h and lws_config_private.h contains custom Godot build configurations, check them out when updating.

mbedtls

File extracted from upstream release tarball mbedtls-2.16.0-apache.tgz:

  • All *.h from include/mbedtls/ to thirdparty/mbedtls/include/mbedtls/
  • All *.c from library/ to thirdparty/mbedtls/library/
  • Applied the patch in thirdparty/mbedtls/1453.diff (PR 1453). Soon to be merged upstream. Check it out at next update.
  • Applied the patch in thirdparty/mbedtls/padlock.diff. This disables VIA padlock support which defines a symbol unsupported which clashes with a symbol in libwebsockets.

miniupnpc

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

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.

xatlas

Files extracted from upstream source:

  • xatlas.{cpp,h}

Note: License is marked as Public Domain in the files, but it was later clarified upstream to MIT 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