Jolt Physics
A multi core friendly Game Physics Engine
Loading...
Searching...
No Matches
Core.h
Go to the documentation of this file.
1// Jolt Physics Library (https://github.com/jrouwe/JoltPhysics)
2// SPDX-FileCopyrightText: 2021 Jorrit Rouwe
3// SPDX-License-Identifier: MIT
4
5#pragma once
6
7// Jolt library version
8#define JPH_VERSION_MAJOR 5
9#define JPH_VERSION_MINOR 2
10#define JPH_VERSION_PATCH 1
11
12// Determine which features the library was compiled with
13#ifdef JPH_DOUBLE_PRECISION
14 #define JPH_VERSION_FEATURE_BIT_1 1
15#else
16 #define JPH_VERSION_FEATURE_BIT_1 0
17#endif
18#ifdef JPH_CROSS_PLATFORM_DETERMINISTIC
19 #define JPH_VERSION_FEATURE_BIT_2 1
20#else
21 #define JPH_VERSION_FEATURE_BIT_2 0
22#endif
23#ifdef JPH_FLOATING_POINT_EXCEPTIONS_ENABLED
24 #define JPH_VERSION_FEATURE_BIT_3 1
25#else
26 #define JPH_VERSION_FEATURE_BIT_3 0
27#endif
28#ifdef JPH_PROFILE_ENABLED
29 #define JPH_VERSION_FEATURE_BIT_4 1
30#else
31 #define JPH_VERSION_FEATURE_BIT_4 0
32#endif
33#ifdef JPH_EXTERNAL_PROFILE
34 #define JPH_VERSION_FEATURE_BIT_5 1
35#else
36 #define JPH_VERSION_FEATURE_BIT_5 0
37#endif
38#ifdef JPH_DEBUG_RENDERER
39 #define JPH_VERSION_FEATURE_BIT_6 1
40#else
41 #define JPH_VERSION_FEATURE_BIT_6 0
42#endif
43#ifdef JPH_DISABLE_TEMP_ALLOCATOR
44 #define JPH_VERSION_FEATURE_BIT_7 1
45#else
46 #define JPH_VERSION_FEATURE_BIT_7 0
47#endif
48#ifdef JPH_DISABLE_CUSTOM_ALLOCATOR
49 #define JPH_VERSION_FEATURE_BIT_8 1
50#else
51 #define JPH_VERSION_FEATURE_BIT_8 0
52#endif
53#if defined(JPH_OBJECT_LAYER_BITS) && JPH_OBJECT_LAYER_BITS == 32
54 #define JPH_VERSION_FEATURE_BIT_9 1
55#else
56 #define JPH_VERSION_FEATURE_BIT_9 0
57#endif
58#ifdef JPH_ENABLE_ASSERTS
59 #define JPH_VERSION_FEATURE_BIT_10 1
60#else
61 #define JPH_VERSION_FEATURE_BIT_10 0
62#endif
63#ifdef JPH_OBJECT_STREAM
64 #define JPH_VERSION_FEATURE_BIT_11 1
65#else
66 #define JPH_VERSION_FEATURE_BIT_11 0
67#endif
68#define JPH_VERSION_FEATURES (uint64(JPH_VERSION_FEATURE_BIT_1) | (JPH_VERSION_FEATURE_BIT_2 << 1) | (JPH_VERSION_FEATURE_BIT_3 << 2) | (JPH_VERSION_FEATURE_BIT_4 << 3) | (JPH_VERSION_FEATURE_BIT_5 << 4) | (JPH_VERSION_FEATURE_BIT_6 << 5) | (JPH_VERSION_FEATURE_BIT_7 << 6) | (JPH_VERSION_FEATURE_BIT_8 << 7) | (JPH_VERSION_FEATURE_BIT_9 << 8) | (JPH_VERSION_FEATURE_BIT_10 << 9) | (JPH_VERSION_FEATURE_BIT_11 << 10))
69
70// Combine the version and features in a single ID
71#define JPH_VERSION_ID ((JPH_VERSION_FEATURES << 24) | (JPH_VERSION_MAJOR << 16) | (JPH_VERSION_MINOR << 8) | JPH_VERSION_PATCH)
72
73// Determine platform
74#if defined(JPH_PLATFORM_BLUE)
75 // Correct define already defined, this overrides everything else
76#elif defined(_WIN32) || defined(_WIN64)
77 #include <winapifamily.h>
78 #if WINAPI_FAMILY == WINAPI_FAMILY_APP
79 #define JPH_PLATFORM_WINDOWS_UWP // Building for Universal Windows Platform
80 #endif
81 #define JPH_PLATFORM_WINDOWS
82#elif defined(__ANDROID__) // Android is linux too, so that's why we check it first
83 #define JPH_PLATFORM_ANDROID
84#elif defined(__linux__)
85 #define JPH_PLATFORM_LINUX
86#elif defined(__FreeBSD__)
87 #define JPH_PLATFORM_FREEBSD
88#elif defined(__APPLE__)
89 #include <TargetConditionals.h>
90 #if defined(TARGET_OS_IPHONE) && !TARGET_OS_IPHONE
91 #define JPH_PLATFORM_MACOS
92 #else
93 #define JPH_PLATFORM_IOS
94 #endif
95#elif defined(__EMSCRIPTEN__)
96 #define JPH_PLATFORM_WASM
97#endif
98
99// Platform helper macros
100#ifdef JPH_PLATFORM_ANDROID
101 #define JPH_IF_NOT_ANDROID(x)
102#else
103 #define JPH_IF_NOT_ANDROID(x) x
104#endif
105
106// Determine compiler
107#if defined(__clang__)
108 #define JPH_COMPILER_CLANG
109#elif defined(__GNUC__)
110 #define JPH_COMPILER_GCC
111#elif defined(_MSC_VER)
112 #define JPH_COMPILER_MSVC
113#endif
114
115#if defined(__MINGW64__) || defined (__MINGW32__)
116 #define JPH_COMPILER_MINGW
117#endif
118
119// Detect CPU architecture
120#if defined(__x86_64__) || defined(_M_X64) || defined(__i386__) || defined(_M_IX86)
121 // X86 CPU architecture
122 #define JPH_CPU_X86
123 #if defined(__x86_64__) || defined(_M_X64)
124 #define JPH_CPU_ADDRESS_BITS 64
125 #else
126 #define JPH_CPU_ADDRESS_BITS 32
127 #endif
128 #define JPH_USE_SSE
129 #define JPH_VECTOR_ALIGNMENT 16
130 #define JPH_DVECTOR_ALIGNMENT 32
131
132 // Detect enabled instruction sets
133 #if defined(__AVX512F__) && defined(__AVX512VL__) && defined(__AVX512DQ__) && !defined(JPH_USE_AVX512)
134 #define JPH_USE_AVX512
135 #endif
136 #if (defined(__AVX2__) || defined(JPH_USE_AVX512)) && !defined(JPH_USE_AVX2)
137 #define JPH_USE_AVX2
138 #endif
139 #if (defined(__AVX__) || defined(JPH_USE_AVX2)) && !defined(JPH_USE_AVX)
140 #define JPH_USE_AVX
141 #endif
142 #if (defined(__SSE4_2__) || defined(JPH_USE_AVX)) && !defined(JPH_USE_SSE4_2)
143 #define JPH_USE_SSE4_2
144 #endif
145 #if (defined(__SSE4_1__) || defined(JPH_USE_SSE4_2)) && !defined(JPH_USE_SSE4_1)
146 #define JPH_USE_SSE4_1
147 #endif
148 #if (defined(__F16C__) || defined(JPH_USE_AVX2)) && !defined(JPH_USE_F16C)
149 #define JPH_USE_F16C
150 #endif
151 #if (defined(__LZCNT__) || defined(JPH_USE_AVX2)) && !defined(JPH_USE_LZCNT)
152 #define JPH_USE_LZCNT
153 #endif
154 #if (defined(__BMI__) || defined(JPH_USE_AVX2)) && !defined(JPH_USE_TZCNT)
155 #define JPH_USE_TZCNT
156 #endif
157 #ifndef JPH_CROSS_PLATFORM_DETERMINISTIC // FMA is not compatible with cross platform determinism
158 #if defined(JPH_COMPILER_CLANG) || defined(JPH_COMPILER_GCC)
159 #if defined(__FMA__) && !defined(JPH_USE_FMADD)
160 #define JPH_USE_FMADD
161 #endif
162 #elif defined(JPH_COMPILER_MSVC)
163 #if defined(__AVX2__) && !defined(JPH_USE_FMADD) // AVX2 also enables fused multiply add
164 #define JPH_USE_FMADD
165 #endif
166 #else
167 #error Undefined compiler
168 #endif
169 #endif
170#elif defined(__aarch64__) || defined(_M_ARM64) || defined(__arm__) || defined(_M_ARM)
171 // ARM CPU architecture
172 #define JPH_CPU_ARM
173 #if defined(__aarch64__) || defined(_M_ARM64)
174 #define JPH_CPU_ADDRESS_BITS 64
175 #define JPH_USE_NEON
176 #define JPH_VECTOR_ALIGNMENT 16
177 #define JPH_DVECTOR_ALIGNMENT 32
178 #else
179 #define JPH_CPU_ADDRESS_BITS 32
180 #define JPH_VECTOR_ALIGNMENT 8 // 32-bit ARM does not support aligning on the stack on 16 byte boundaries
181 #define JPH_DVECTOR_ALIGNMENT 8
182 #endif
183#elif defined(JPH_PLATFORM_WASM)
184 // WebAssembly CPU architecture
185 #define JPH_CPU_WASM
186 #define JPH_CPU_ADDRESS_BITS 32
187 #define JPH_VECTOR_ALIGNMENT 16
188 #define JPH_DVECTOR_ALIGNMENT 32
189 #ifdef __wasm_simd128__
190 #define JPH_USE_SSE
191 #define JPH_USE_SSE4_1
192 #define JPH_USE_SSE4_2
193 #endif
194#elif defined(__e2k__)
195 // E2K CPU architecture (MCST Elbrus 2000)
196 #define JPH_CPU_E2K
197 #define JPH_CPU_ADDRESS_BITS 64
198 #define JPH_VECTOR_ALIGNMENT 16
199 #define JPH_DVECTOR_ALIGNMENT 32
200
201 // Compiler flags on e2k arch determine CPU features
202 #if defined(__SSE__) && !defined(JPH_USE_SSE)
203 #define JPH_USE_SSE
204 #endif
205#else
206 #error Unsupported CPU architecture
207#endif
208
209// If this define is set, Jolt is compiled as a shared library
210#ifdef JPH_SHARED_LIBRARY
211 #ifdef JPH_BUILD_SHARED_LIBRARY
212 // While building the shared library, we must export these symbols
213 #if defined(JPH_PLATFORM_WINDOWS) && !defined(JPH_COMPILER_MINGW)
214 #define JPH_EXPORT __declspec(dllexport)
215 #else
216 #define JPH_EXPORT __attribute__ ((visibility ("default")))
217 #if defined(JPH_COMPILER_GCC)
218 // Prevents an issue with GCC attribute parsing (see https://gcc.gnu.org/bugzilla/show_bug.cgi?id=69585)
219 #define JPH_EXPORT_GCC_BUG_WORKAROUND [[gnu::visibility("default")]]
220 #endif
221 #endif
222 #else
223 // When linking against Jolt, we must import these symbols
224 #if defined(JPH_PLATFORM_WINDOWS) && !defined(JPH_COMPILER_MINGW)
225 #define JPH_EXPORT __declspec(dllimport)
226 #else
227 #define JPH_EXPORT __attribute__ ((visibility ("default")))
228 #if defined(JPH_COMPILER_GCC)
229 // Prevents an issue with GCC attribute parsing (see https://gcc.gnu.org/bugzilla/show_bug.cgi?id=69585)
230 #define JPH_EXPORT_GCC_BUG_WORKAROUND [[gnu::visibility("default")]]
231 #endif
232 #endif
233 #endif
234#else
235 // If the define is not set, we use static linking and symbols don't need to be imported or exported
236 #define JPH_EXPORT
237#endif
238
239#ifndef JPH_EXPORT_GCC_BUG_WORKAROUND
240 #define JPH_EXPORT_GCC_BUG_WORKAROUND JPH_EXPORT
241#endif
242
243// Macro used by the RTTI macros to not export a function
244#define JPH_NO_EXPORT
245
246// Pragmas to store / restore the warning state and to disable individual warnings
247#ifdef JPH_COMPILER_CLANG
248#define JPH_PRAGMA(x) _Pragma(#x)
249#define JPH_SUPPRESS_WARNING_PUSH JPH_PRAGMA(clang diagnostic push)
250#define JPH_SUPPRESS_WARNING_POP JPH_PRAGMA(clang diagnostic pop)
251#define JPH_CLANG_SUPPRESS_WARNING(w) JPH_PRAGMA(clang diagnostic ignored w)
252#if __clang_major__ >= 13
253 #define JPH_CLANG_13_PLUS_SUPPRESS_WARNING(w) JPH_CLANG_SUPPRESS_WARNING(w)
254#else
255 #define JPH_CLANG_13_PLUS_SUPPRESS_WARNING(w)
256#endif
257#if __clang_major__ >= 16
258 #define JPH_CLANG_16_PLUS_SUPPRESS_WARNING(w) JPH_CLANG_SUPPRESS_WARNING(w)
259#else
260 #define JPH_CLANG_16_PLUS_SUPPRESS_WARNING(w)
261#endif
262#else
263#define JPH_CLANG_SUPPRESS_WARNING(w)
264#define JPH_CLANG_13_PLUS_SUPPRESS_WARNING(w)
265#define JPH_CLANG_16_PLUS_SUPPRESS_WARNING(w)
266#endif
267#ifdef JPH_COMPILER_GCC
268#define JPH_PRAGMA(x) _Pragma(#x)
269#define JPH_SUPPRESS_WARNING_PUSH JPH_PRAGMA(GCC diagnostic push)
270#define JPH_SUPPRESS_WARNING_POP JPH_PRAGMA(GCC diagnostic pop)
271#define JPH_GCC_SUPPRESS_WARNING(w) JPH_PRAGMA(GCC diagnostic ignored w)
272#else
273#define JPH_GCC_SUPPRESS_WARNING(w)
274#endif
275#ifdef JPH_COMPILER_MSVC
276#define JPH_PRAGMA(x) __pragma(x)
277#define JPH_SUPPRESS_WARNING_PUSH JPH_PRAGMA(warning (push))
278#define JPH_SUPPRESS_WARNING_POP JPH_PRAGMA(warning (pop))
279#define JPH_MSVC_SUPPRESS_WARNING(w) JPH_PRAGMA(warning (disable : w))
280#if _MSC_VER >= 1920 && _MSC_VER < 1930
281 #define JPH_MSVC2019_SUPPRESS_WARNING(w) JPH_MSVC_SUPPRESS_WARNING(w)
282#else
283 #define JPH_MSVC2019_SUPPRESS_WARNING(w)
284#endif
285#else
286#define JPH_MSVC_SUPPRESS_WARNING(w)
287#define JPH_MSVC2019_SUPPRESS_WARNING(w)
288#endif
289
290// Disable common warnings triggered by Jolt when compiling with -Wall
291#define JPH_SUPPRESS_WARNINGS \
292 JPH_CLANG_SUPPRESS_WARNING("-Wc++98-compat") \
293 JPH_CLANG_SUPPRESS_WARNING("-Wc++98-compat-pedantic") \
294 JPH_CLANG_SUPPRESS_WARNING("-Wfloat-equal") \
295 JPH_CLANG_SUPPRESS_WARNING("-Wsign-conversion") \
296 JPH_CLANG_SUPPRESS_WARNING("-Wold-style-cast") \
297 JPH_CLANG_SUPPRESS_WARNING("-Wgnu-anonymous-struct") \
298 JPH_CLANG_SUPPRESS_WARNING("-Wnested-anon-types") \
299 JPH_CLANG_SUPPRESS_WARNING("-Wglobal-constructors") \
300 JPH_CLANG_SUPPRESS_WARNING("-Wexit-time-destructors") \
301 JPH_CLANG_SUPPRESS_WARNING("-Wnonportable-system-include-path") \
302 JPH_CLANG_SUPPRESS_WARNING("-Wlanguage-extension-token") \
303 JPH_CLANG_SUPPRESS_WARNING("-Wunused-parameter") \
304 JPH_CLANG_SUPPRESS_WARNING("-Wformat-nonliteral") \
305 JPH_CLANG_SUPPRESS_WARNING("-Wcovered-switch-default") \
306 JPH_CLANG_SUPPRESS_WARNING("-Wcast-align") \
307 JPH_CLANG_SUPPRESS_WARNING("-Winvalid-offsetof") \
308 JPH_CLANG_SUPPRESS_WARNING("-Wgnu-zero-variadic-macro-arguments") \
309 JPH_CLANG_SUPPRESS_WARNING("-Wdocumentation-unknown-command") \
310 JPH_CLANG_SUPPRESS_WARNING("-Wctad-maybe-unsupported") \
311 JPH_CLANG_SUPPRESS_WARNING("-Wswitch-default") \
312 JPH_CLANG_13_PLUS_SUPPRESS_WARNING("-Wdeprecated-copy") \
313 JPH_CLANG_13_PLUS_SUPPRESS_WARNING("-Wdeprecated-copy-with-dtor") \
314 JPH_CLANG_16_PLUS_SUPPRESS_WARNING("-Wunsafe-buffer-usage") \
315 JPH_IF_NOT_ANDROID(JPH_CLANG_SUPPRESS_WARNING("-Wimplicit-int-float-conversion")) \
316 \
317 JPH_GCC_SUPPRESS_WARNING("-Wcomment") \
318 JPH_GCC_SUPPRESS_WARNING("-Winvalid-offsetof") \
319 JPH_GCC_SUPPRESS_WARNING("-Wclass-memaccess") \
320 JPH_GCC_SUPPRESS_WARNING("-Wpedantic") \
321 JPH_GCC_SUPPRESS_WARNING("-Wunused-parameter") \
322 JPH_GCC_SUPPRESS_WARNING("-Wmaybe-uninitialized") \
323 \
324 JPH_MSVC_SUPPRESS_WARNING(4619) /* #pragma warning: there is no warning number 'XXXX' */ \
325 JPH_MSVC_SUPPRESS_WARNING(4514) /* 'X' : unreferenced inline function has been removed */ \
326 JPH_MSVC_SUPPRESS_WARNING(4710) /* 'X' : function not inlined */ \
327 JPH_MSVC_SUPPRESS_WARNING(4711) /* function 'X' selected for automatic inline expansion */ \
328 JPH_MSVC_SUPPRESS_WARNING(4820) /* 'X': 'Y' bytes padding added after data member 'Z' */ \
329 JPH_MSVC_SUPPRESS_WARNING(4100) /* 'X' : unreferenced formal parameter */ \
330 JPH_MSVC_SUPPRESS_WARNING(4626) /* 'X' : assignment operator was implicitly defined as deleted because a base class assignment operator is inaccessible or deleted */ \
331 JPH_MSVC_SUPPRESS_WARNING(5027) /* 'X' : move assignment operator was implicitly defined as deleted because a base class move assignment operator is inaccessible or deleted */ \
332 JPH_MSVC_SUPPRESS_WARNING(4365) /* 'argument' : conversion from 'X' to 'Y', signed / unsigned mismatch */ \
333 JPH_MSVC_SUPPRESS_WARNING(4324) /* 'X' : structure was padded due to alignment specifier */ \
334 JPH_MSVC_SUPPRESS_WARNING(4625) /* 'X' : copy constructor was implicitly defined as deleted because a base class copy constructor is inaccessible or deleted */ \
335 JPH_MSVC_SUPPRESS_WARNING(5026) /* 'X': move constructor was implicitly defined as deleted because a base class move constructor is inaccessible or deleted */ \
336 JPH_MSVC_SUPPRESS_WARNING(4623) /* 'X' : default constructor was implicitly defined as deleted */ \
337 JPH_MSVC_SUPPRESS_WARNING(4201) /* nonstandard extension used: nameless struct/union */ \
338 JPH_MSVC_SUPPRESS_WARNING(4371) /* 'X': layout of class may have changed from a previous version of the compiler due to better packing of member 'Y' */ \
339 JPH_MSVC_SUPPRESS_WARNING(5045) /* Compiler will insert Spectre mitigation for memory load if /Qspectre switch specified */ \
340 JPH_MSVC_SUPPRESS_WARNING(4583) /* 'X': destructor is not implicitly called */ \
341 JPH_MSVC_SUPPRESS_WARNING(4582) /* 'X': constructor is not implicitly called */ \
342 JPH_MSVC_SUPPRESS_WARNING(5219) /* implicit conversion from 'X' to 'Y', possible loss of data */ \
343 JPH_MSVC_SUPPRESS_WARNING(4826) /* Conversion from 'X *' to 'JPH::uint64' is sign-extended. This may cause unexpected runtime behavior. (32-bit) */ \
344 JPH_MSVC_SUPPRESS_WARNING(5264) /* 'X': 'const' variable is not used */ \
345 JPH_MSVC_SUPPRESS_WARNING(4251) /* class 'X' needs to have DLL-interface to be used by clients of class 'Y' */ \
346 JPH_MSVC_SUPPRESS_WARNING(4738) /* storing 32-bit float result in memory, possible loss of performance */ \
347 JPH_MSVC2019_SUPPRESS_WARNING(5246) /* the initialization of a subobject should be wrapped in braces */
348
349// OS-specific includes
350#if defined(JPH_PLATFORM_WINDOWS)
351 #define JPH_BREAKPOINT __debugbreak()
352#elif defined(JPH_PLATFORM_BLUE)
353 // Configuration for a popular game console.
354 // This file is not distributed because it would violate an NDA.
355 // Creating one should only be a couple of minutes of work if you have the documentation for the platform
356 // (you only need to define JPH_BREAKPOINT, JPH_PLATFORM_BLUE_GET_TICKS, JPH_PLATFORM_BLUE_MUTEX*, JPH_PLATFORM_BLUE_RWLOCK* and include the right header).
357 #include <Jolt/Core/PlatformBlue.h>
358#elif defined(JPH_PLATFORM_LINUX) || defined(JPH_PLATFORM_ANDROID) || defined(JPH_PLATFORM_MACOS) || defined(JPH_PLATFORM_IOS) || defined(JPH_PLATFORM_FREEBSD)
359 #if defined(JPH_CPU_X86)
360 #define JPH_BREAKPOINT __asm volatile ("int $0x3")
361 #elif defined(JPH_CPU_ARM)
362 #define JPH_BREAKPOINT __builtin_trap()
363 #elif defined(JPH_CPU_E2K)
364 #define JPH_BREAKPOINT __builtin_trap()
365 #endif
366#elif defined(JPH_PLATFORM_WASM)
367 #define JPH_BREAKPOINT do { } while (false) // Not supported
368#else
369 #error Unknown platform
370#endif
371
372// Begin the JPH namespace
373#define JPH_NAMESPACE_BEGIN \
374 JPH_SUPPRESS_WARNING_PUSH \
375 JPH_SUPPRESS_WARNINGS \
376 namespace JPH {
377
378// End the JPH namespace
379#define JPH_NAMESPACE_END \
380 } \
381 JPH_SUPPRESS_WARNING_POP
382
383// Suppress warnings generated by the standard template library
384#define JPH_SUPPRESS_WARNINGS_STD_BEGIN \
385 JPH_SUPPRESS_WARNING_PUSH \
386 JPH_MSVC_SUPPRESS_WARNING(4365) \
387 JPH_MSVC_SUPPRESS_WARNING(4619) \
388 JPH_MSVC_SUPPRESS_WARNING(4710) \
389 JPH_MSVC_SUPPRESS_WARNING(4711) \
390 JPH_MSVC_SUPPRESS_WARNING(4820) \
391 JPH_MSVC_SUPPRESS_WARNING(4514) \
392 JPH_MSVC_SUPPRESS_WARNING(5262) \
393 JPH_MSVC_SUPPRESS_WARNING(5264) \
394 JPH_MSVC_SUPPRESS_WARNING(4738)
395
396#define JPH_SUPPRESS_WARNINGS_STD_END \
397 JPH_SUPPRESS_WARNING_POP
398
399// Standard C++ includes
401#include <float.h>
402#include <limits.h>
403#include <string.h>
404#include <utility>
405#include <cmath>
406#include <sstream>
407#include <functional>
408#include <algorithm>
409#include <cstdint>
410#ifdef JPH_COMPILER_MSVC
411 #include <malloc.h> // for alloca
412#endif
413#if defined(JPH_USE_SSE)
414 #include <immintrin.h>
415#elif defined(JPH_USE_NEON)
416 #ifdef JPH_COMPILER_MSVC
417 #include <intrin.h>
418 #include <arm64_neon.h>
419 #else
420 #include <arm_neon.h>
421 #endif
422#endif
424
426
427// Commonly used STL types
428using std::min;
429using std::max;
430using std::abs;
431using std::sqrt;
432using std::ceil;
433using std::floor;
434using std::trunc;
435using std::round;
436using std::fmod;
437using std::string_view;
438using std::function;
439using std::numeric_limits;
440using std::isfinite;
441using std::isnan;
442using std::ostream;
443using std::istream;
444
445// Standard types
446using uint = unsigned int;
447using uint8 = std::uint8_t;
448using uint16 = std::uint16_t;
449using uint32 = std::uint32_t;
450using uint64 = std::uint64_t;
451
452// Assert sizes of types
453static_assert(sizeof(uint) >= 4, "Invalid size of uint");
454static_assert(sizeof(uint8) == 1, "Invalid size of uint8");
455static_assert(sizeof(uint16) == 2, "Invalid size of uint16");
456static_assert(sizeof(uint32) == 4, "Invalid size of uint32");
457static_assert(sizeof(uint64) == 8, "Invalid size of uint64");
458static_assert(sizeof(void *) == (JPH_CPU_ADDRESS_BITS == 64? 8 : 4), "Invalid size of pointer" );
459
460// Determine if we want extra debugging code to be active
461#if !defined(NDEBUG) && !defined(JPH_NO_DEBUG)
462 #define JPH_DEBUG
463#endif
464
465// Define inline macro
466#if defined(JPH_NO_FORCE_INLINE)
467 #define JPH_INLINE inline
468#elif defined(JPH_COMPILER_CLANG)
469 #define JPH_INLINE __inline__ __attribute__((always_inline))
470#elif defined(JPH_COMPILER_GCC)
471 // On gcc 14 using always_inline in debug mode causes error: "inlining failed in call to 'always_inline' 'XXX': function not considered for inlining"
472 // See: https://github.com/jrouwe/JoltPhysics/issues/1096
473 #if __GNUC__ >= 14 && defined(JPH_DEBUG)
474 #define JPH_INLINE inline
475 #else
476 #define JPH_INLINE __inline__ __attribute__((always_inline))
477 #endif
478#elif defined(JPH_COMPILER_MSVC)
479 #define JPH_INLINE __forceinline
480#else
481 #error Undefined
482#endif
483
484// Cache line size (used for aligning to cache line)
485#ifndef JPH_CACHE_LINE_SIZE
486 #define JPH_CACHE_LINE_SIZE 64
487#endif
488
489// Define macro to get current function name
490#if defined(JPH_COMPILER_CLANG) || defined(JPH_COMPILER_GCC)
491 #define JPH_FUNCTION_NAME __PRETTY_FUNCTION__
492#elif defined(JPH_COMPILER_MSVC)
493 #define JPH_FUNCTION_NAME __FUNCTION__
494#else
495 #error Undefined
496#endif
497
498// Stack allocation
499#define JPH_STACK_ALLOC(n) alloca(n)
500
501// Shorthand for #ifdef JPH_DEBUG / #endif
502#ifdef JPH_DEBUG
503 #define JPH_IF_DEBUG(...) __VA_ARGS__
504 #define JPH_IF_NOT_DEBUG(...)
505#else
506 #define JPH_IF_DEBUG(...)
507 #define JPH_IF_NOT_DEBUG(...) __VA_ARGS__
508#endif
509
510// Shorthand for #ifdef JPH_FLOATING_POINT_EXCEPTIONS_ENABLED / #endif
511#ifdef JPH_FLOATING_POINT_EXCEPTIONS_ENABLED
512 #define JPH_IF_FLOATING_POINT_EXCEPTIONS_ENABLED(...) __VA_ARGS__
513#else
514 #define JPH_IF_FLOATING_POINT_EXCEPTIONS_ENABLED(...)
515#endif
516
517// Helper macros to detect if we're running in single or double precision mode
518#ifdef JPH_DOUBLE_PRECISION
519 #define JPH_IF_SINGLE_PRECISION(...)
520 #define JPH_IF_SINGLE_PRECISION_ELSE(s, d) d
521 #define JPH_IF_DOUBLE_PRECISION(...) __VA_ARGS__
522#else
523 #define JPH_IF_SINGLE_PRECISION(...) __VA_ARGS__
524 #define JPH_IF_SINGLE_PRECISION_ELSE(s, d) s
525 #define JPH_IF_DOUBLE_PRECISION(...)
526#endif
527
528// Helper macro to detect if the debug renderer is active
529#ifdef JPH_DEBUG_RENDERER
530 #define JPH_IF_DEBUG_RENDERER(...) __VA_ARGS__
531 #define JPH_IF_NOT_DEBUG_RENDERER(...)
532#else
533 #define JPH_IF_DEBUG_RENDERER(...)
534 #define JPH_IF_NOT_DEBUG_RENDERER(...) __VA_ARGS__
535#endif
536
537// Macro to indicate that a parameter / variable is unused
538#define JPH_UNUSED(x) (void)x
539
540// Macro to enable floating point precise mode and to disable fused multiply add instructions
541#if defined(JPH_COMPILER_GCC) || defined(JPH_CROSS_PLATFORM_DETERMINISTIC)
542 // We compile without -ffast-math and -ffp-contract=fast, so we don't need to disable anything
543 #define JPH_PRECISE_MATH_ON
544 #define JPH_PRECISE_MATH_OFF
545#elif defined(JPH_COMPILER_CLANG)
546 // We compile without -ffast-math because pragma float_control(precise, on) doesn't seem to actually negate all of the -ffast-math effects and causes the unit tests to fail (even if the pragma is added to all files)
547 // On clang 14 and later we can turn off float contraction through a pragma (before it was buggy), so if FMA is on we can disable it through this macro
548 #if (defined(JPH_CPU_ARM) && !defined(JPH_PLATFORM_ANDROID) && __clang_major__ >= 16) || (defined(JPH_CPU_X86) && __clang_major__ >= 14)
549 #define JPH_PRECISE_MATH_ON \
550 _Pragma("float_control(precise, on, push)") \
551 _Pragma("clang fp contract(off)")
552 #define JPH_PRECISE_MATH_OFF \
553 _Pragma("float_control(pop)")
554 #elif __clang_major__ >= 14 && (defined(JPH_USE_FMADD) || defined(FP_FAST_FMA))
555 #define JPH_PRECISE_MATH_ON \
556 _Pragma("clang fp contract(off)")
557 #define JPH_PRECISE_MATH_OFF \
558 _Pragma("clang fp contract(on)")
559 #else
560 #define JPH_PRECISE_MATH_ON
561 #define JPH_PRECISE_MATH_OFF
562 #endif
563#elif defined(JPH_COMPILER_MSVC)
564 // Unfortunately there is no way to push the state of fp_contract, so we have to assume it was turned on before JPH_PRECISE_MATH_ON
565 #define JPH_PRECISE_MATH_ON \
566 __pragma(float_control(precise, on, push)) \
567 __pragma(fp_contract(off))
568 #define JPH_PRECISE_MATH_OFF \
569 __pragma(fp_contract(on)) \
570 __pragma(float_control(pop))
571#else
572 #error Undefined
573#endif
574
575// Check if Thread Sanitizer is enabled
576#ifdef __has_feature
577 #if __has_feature(thread_sanitizer)
578 #define JPH_TSAN_ENABLED
579 #endif
580#else
581 #ifdef __SANITIZE_THREAD__
582 #define JPH_TSAN_ENABLED
583 #endif
584#endif
585
586// Attribute to disable Thread Sanitizer for a particular function
587#ifdef JPH_TSAN_ENABLED
588 #define JPH_TSAN_NO_SANITIZE __attribute__((no_sanitize("thread")))
589#else
590 #define JPH_TSAN_NO_SANITIZE
591#endif
592
std::uint8_t uint8
Definition Core.h:447
#define JPH_SUPPRESS_WARNINGS_STD_BEGIN
Definition Core.h:384
#define JPH_SUPPRESS_WARNINGS_STD_END
Definition Core.h:396
std::uint64_t uint64
Definition Core.h:450
unsigned int uint
Definition Core.h:446
#define JPH_NAMESPACE_END
Definition Core.h:379
std::uint32_t uint32
Definition Core.h:449
#define JPH_NAMESPACE_BEGIN
Definition Core.h:373
std::uint16_t uint16
Definition Core.h:448