Update README.md

Fully inlined HandmadeMath.h (#139 )
* Fully inlined HandmadeMath.h, renamed test.bat to run_test_msvc.bat, and introduced run_test_clang.bat * General Cleanup
2025-12-28 15:44:33 +00:00 · 2021-08-31 17:11:42 -07:00 · 2021-08-31 17:10:46 -07:00 · 2021-08-31 09:28:02 -07:00 · 2021-08-31 09:22:29 -07:00 · 2021-08-31 09:37:54 -05:00
8 changed files with 817 additions and 790 deletions
--- a/HandmadeMath.h
+++ b/HandmadeMath.h
--- a/README.md
+++ b/README.md
@@ -10,6 +10,11 @@ To get started, go download [the latest release](https://github.com/HandmadeMath

 Version         | Changes        |
 ----------------|----------------|
+**1.13.0** | Fully inlined HandmadeMath.h. No need for HANDMADE_MATH_IMPLEMENTATION anymore |
+**1.12.1** | Added extra parentheses around some macros |
+**1.12.0** | Added Unary Minus operator for `HMM_Vec2`, `HMM_Vec3`, and `HMM_Vec4`. |
+**1.11.1** | Added HMM_PREFIX macro to a few functions that were missing it. |
+**1.11.0** | Added ability to customize or remove the default `HMM_` prefix on function names by defining a macro called `HMM_PREFIX(name)`. |
 **1.10.1** | Removed stdint.h, this doesn't exist on some really old compilers and we didn't really use it anyways. |
 **1.10.0** | Made HMM_Perspective use vertical FOV instead of horizontal FOV for consistency with other graphics APIs. |
 **1.9.0** | Added SSE versions of quaternion operations. |
@@ -36,7 +41,7 @@ Version         | Changes        |
 **0.5**     | Added scalar operations on vectors and matrices, added += and -= for hmm_mat4, reconciled headers and implementations, tidied up in general |
 **0.4**     | Added SSE Optimized HMM_SqrtF, HMM_RSqrtF, Removed use of C Runtime | 
 **0.3**     | Added +=,-=, *=, /= for hmm_vec2, hmm_vec3, hmm_vec4 | 
-**0.2b**    | Disabled warning C4201 on MSVC, Added 64bit percision on HMM_PI | 
+**0.2b**    | Disabled warning C4201 on MSVC, Added 64bit precision on HMM_PI | 
 **0.2a**    | Prefixed Macros | 
 **0.2**     | Updated Documentation, Fixed C Compliance, Prefixed all functions, and added better operator overloading | 
 **0.1**     | Initial Version | 
--- a/test/HandmadeMathDifferentPrefix.cpp
+++ b/test/HandmadeMathDifferentPrefix.cpp
@@ -0,0 +1,12 @@
+#define HMM_PREFIX(name) WOW_##name
+
+#define HANDMADE_MATH_IMPLEMENTATION
+#define HANDMADE_MATH_NO_INLINE
+#include "../HandmadeMath.h"
+
+int main() {
+    hmm_vec4 a = WOW_Vec4(1, 2, 3, 4);
+    hmm_vec4 b = WOW_Vec4(5, 6, 7, 8);
+
+    WOW_Add(a, b);
+}
--- a/test/Makefile
+++ b/test/Makefile
@@ -1,8 +1,8 @@
 BUILD_DIR=./build

-CXXFLAGS+=-g -Wall -Wextra -pthread -Wno-missing-braces -Wno-missing-field-initializers
+CXXFLAGS+=-g -Wall -Wextra -pthread -Wno-missing-braces -Wno-missing-field-initializers -Wfloat-equal

-all: c c_no_sse cpp cpp_no_sse build_c_without_coverage build_cpp_without_coverage
+all: c c_no_sse cpp cpp_no_sse build_c_without_coverage build_cpp_without_coverage build_cpp_different_prefix

 build_all: build_c build_c_no_sse build_cpp build_cpp_no_sse

@@ -58,7 +58,7 @@ build_cpp_no_sse: HandmadeMath.cpp test_impl

 test_impl: hmm_test.cpp hmm_test.c

-build_c_without_coverage: HandmadeMath.c
+build_c_without_coverage: HandmadeMath.c test_impl
 	@echo "\nCompiling in C mode"
 	mkdir -p $(BUILD_DIR)
 	cd $(BUILD_DIR)\
@@ -75,3 +75,11 @@ build_cpp_without_coverage: HandmadeMath.cpp test_impl
 		&& $(CXX) $(CPPFLAGS) $(CXXFLAGS) -ohmm_test_cpp_no_sse \
 			-DHANDMADE_MATH_CPP_MODE -DWITHOUT_COVERAGE \
 			../HandmadeMath.cpp ../hmm_test.cpp
+
+build_cpp_different_prefix: HandmadeMath.cpp
+	@echo "\nCompiling C++ with different prefix"
+	mkdir -p $(BUILD_DIR)
+	cd $(BUILD_DIR) \
+		&& $(CXX) $(CPPFLAGS) $(CXXFLAGS) -ohmm_test_cpp_different_prefix \
+			-DHANDMADE_MATH_CPP_MODE -DDIFFERENT_PREFIX \
+			../HandmadeMathDifferentPrefix.cpp
--- a/test/categories/ScalarMath.h
+++ b/test/categories/ScalarMath.h
@@ -74,9 +74,9 @@ TEST(ScalarMath, Power)

 TEST(ScalarMath, PowerF)
 {
-    EXPECT_FLOAT_EQ(HMM_PowerF(2.0f, 0), 1.0f);
-    EXPECT_NEAR(HMM_PowerF(2.0f, 4.1), 17.148376f, 0.0001f);
-    EXPECT_NEAR(HMM_PowerF(2.0f, -2.5), 0.176777f, 0.0001f);
+    EXPECT_FLOAT_EQ(HMM_PowerF(2.0f, 0.0f), 1.0f);
+    EXPECT_NEAR(HMM_PowerF(2.0f, 4.1f), 17.148376f, 0.0001f);
+    EXPECT_NEAR(HMM_PowerF(2.0f, -2.5f), 0.176777f, 0.0001f);
 }

 TEST(ScalarMath, Lerp)
--- a/test/categories/Subtraction.h
+++ b/test/categories/Subtraction.h
@@ -199,3 +199,32 @@ TEST(Subtraction, Quaternion)
    EXPECT_FLOAT_EQ(q1.W, -4.0f);
 #endif
 }
+
+#ifdef __cplusplus
+TEST(UnaryMinus, Vec2)
+{
+    hmm_vec2 VectorOne = {1.0f, 2.0f};
+    hmm_vec2 Result = -VectorOne;
+    EXPECT_FLOAT_EQ(Result.X, -1.0f);
+    EXPECT_FLOAT_EQ(Result.Y, -2.0f);
+}
+
+TEST(UnaryMinus, Vec3)
+{
+    hmm_vec3 VectorOne = {1.0f, 2.0f, 3.0f};
+    hmm_vec3 Result = -VectorOne;
+    EXPECT_FLOAT_EQ(Result.X, -1.0f);
+    EXPECT_FLOAT_EQ(Result.Y, -2.0f);
+    EXPECT_FLOAT_EQ(Result.Z, -3.0f);
+}
+
+TEST(UnaryMinus, Vec4)
+{
+    hmm_vec4 VectorOne = {1.0f, 2.0f, 3.0f, 4.0f};
+    hmm_vec4 Result = -VectorOne;
+    EXPECT_FLOAT_EQ(Result.X, -1.0f);
+    EXPECT_FLOAT_EQ(Result.Y, -2.0f);
+    EXPECT_FLOAT_EQ(Result.Z, -3.0f);
+    EXPECT_FLOAT_EQ(Result.W, -4.0f);
+}
+#endif
--- a/test/run_test_clang.bat
+++ b/test/run_test_clang.bat
@@ -0,0 +1,18 @@
+@echo off
+
+if not exist "build" mkdir build
+pushd build
+
+clang-cl /Fehmm_test_c.exe ..\HandmadeMath.c ..\hmm_test.c
+hmm_test_c
+
+clang-cl /Fehmm_test_c_no_sse.exe /DHANDMADE_MATH_NO_SSE ..\HandmadeMath.c ..\hmm_test.c
+hmm_test_c_no_sse
+
+clang-cl /Fehmm_test_cpp.exe ..\HandmadeMath.cpp ..\hmm_test.cpp
+hmm_test_cpp
+
+clang-cl /Fehmm_test_cpp_no_sse.exe /DHANDMADE_MATH_NO_SSE ..\HandmadeMath.cpp ..\hmm_test.cpp
+hmm_test_cpp_no_sse
+
+popd
--- a/test/run_test_msvc.bat
+++ b/test/run_test_msvc.bat
@@ -1,27 +1,27 @@
-@echo off
-
-if "%1%"=="travis" (
-    call "C:\Program Files (x86)\Microsoft Visual Studio\2017\BuildTools\Common7\Tools\VsDevCmd.bat" -host_arch=amd64 -arch=amd64
-) else (
-    where /q cl
-    if ERRORLEVEL 1 (
-        for /f "delims=" %%a in ('"%ProgramFiles(x86)%\Microsoft Visual Studio\Installer\vswhere.exe" -find VC\Auxiliary\Build\vcvarsall.bat') do (%%a x64)
-    )
-)
-
-if not exist "build" mkdir build
-pushd build
-
-cl /Fehmm_test_c.exe ..\HandmadeMath.c ..\hmm_test.c
-hmm_test_c
-
-cl /Fehmm_test_c_no_sse.exe /DHANDMADE_MATH_NO_SSE ..\HandmadeMath.c ..\hmm_test.c
-hmm_test_c_no_sse
-
-cl /Fehmm_test_cpp.exe ..\HandmadeMath.cpp ..\hmm_test.cpp
-hmm_test_cpp
-
-cl /Fehmm_test_cpp_no_sse.exe /DHANDMADE_MATH_NO_SSE ..\HandmadeMath.cpp ..\hmm_test.cpp
-hmm_test_cpp_no_sse
-
-popd
+@echo off
+
+if "%1%"=="travis" (
+    call "C:\Program Files (x86)\Microsoft Visual Studio\2017\BuildTools\Common7\Tools\VsDevCmd.bat" -host_arch=amd64 -arch=amd64
+) else (
+    where /q cl
+    if ERRORLEVEL 1 (
+        for /f "delims=" %%a in ('"%ProgramFiles(x86)%\Microsoft Visual Studio\Installer\vswhere.exe" -find VC\Auxiliary\Build\vcvarsall.bat') do (%%a x64)
+    )
+)
+
+if not exist "build" mkdir build
+pushd build
+
+cl /Fehmm_test_c.exe ..\HandmadeMath.c ..\hmm_test.c
+hmm_test_c
+
+cl /Fehmm_test_c_no_sse.exe /DHANDMADE_MATH_NO_SSE ..\HandmadeMath.c ..\hmm_test.c
+hmm_test_c_no_sse
+
+cl /Fehmm_test_cpp.exe ..\HandmadeMath.cpp ..\hmm_test.cpp
+hmm_test_cpp
+
+cl /Fehmm_test_cpp_no_sse.exe /DHANDMADE_MATH_NO_SSE ..\HandmadeMath.cpp ..\hmm_test.cpp
+hmm_test_cpp_no_sse
+
+popd
Author	SHA1	Message	Date
Zak Strange	ba5405ac0f	Update README.md	2021-08-31 17:11:42 -07:00
Zak Strange	d69a859d73	Fully inlined HandmadeMath.h (#139 ) * Fully inlined HandmadeMath.h, renamed test.bat to run_test_msvc.bat, and introduced run_test_clang.bat * General Cleanup	2021-08-31 17:10:46 -07:00
strangezak	8c18186b3b	Removed Unnecessary Square Root from InverseQuaternion. Closes #136	2021-08-31 09:28:02 -07:00
Tim Gates	5f816bf9b3	docs: fix simple typo, percision -> precision (#137 ) There is a small typo in README.md. Should read `precision` rather than `percision`.	2021-08-31 09:22:29 -07:00
Jørgen P. Tjernø	c5bc802042	Suppress two warnings on clang 12 (#138 ) Building with clang 12 with -Wextra, the following two warnings are generated: ``` HandmadeMath.h:1167:25: warning: missing field 'Y' initializer [-Wmissing-field-initializers] hmm_vec2 Result = {0}; ^ HandmadeMath.h:1167:24: warning: suggest braces around initialization of subobject [-Wmissing-braces] ``` This expands the `-Wmissing-braces` ignore to also target clang, and adds an ignore for `-Wmissing-field-initializers`	2021-08-31 09:37:54 -05:00
Ben Visness	43afc87fa7	Remove non-functioning issue link	2021-03-24 10:04:17 -05:00
Ben Visness	5bbac2167e	Update version and changelog	2021-03-24 10:02:08 -05:00
Wayde Reitsma	655c662528	Add brackets around HMM_MIN, HMM_MAX, and HMM_MOD (#133 ) * Add brackets around HMM_MIN and HMM_MAX * Add brackets around HMM_MOD	2021-03-24 09:54:13 -05:00
Zak Strange	1f0c6ba493	Update Docs.	2021-03-09 16:37:00 -08:00
Zak Strange	1d82b4f0bc	Unary minus vectors (#130 ) * Unary Minus operator for vec2, vec3, and vec4 * Update README.md Co-authored-by: zak <zak@DESKTOP-V1AQ0IT>	2021-03-06 18:39:17 -06:00
Zak Strange	2fa0b36715	Add HMM_STATIC option to statically link instead of extern (#127 ) Co-authored-by: zak <zak@DESKTOP-V1AQ0IT>	2021-02-17 19:36:05 -08:00
Ben Visness	ad169e649c	Make HMM_Clamp branchless in optimized builds (#122 )	2020-12-22 11:19:58 -06:00
Zak Strange	1900cc9275	Updated email in HandmadeMath.h	2020-07-09 18:22:22 -07:00
Ben Visness	ddb9971e71	Update README	2020-07-09 08:51:53 -05:00
GsxCasper	341a376a17	Added HMM_PREFIX macro to function implementations (#120 )	2020-07-08 16:32:29 -05:00
Ben Visness	c825fe48cf	Update version and release notes	2020-04-06 10:02:16 -05:00
Ben Visness	15bef820db	Add ability to customize HMM_ prefix (#114 ) * Add prefix macro and use it everywhere * Add lightweight test for prefix * Add a little doc blurb	2020-04-06 09:57:10 -05:00
Ben Visness	fe32f081f2	Suppress float equality warnings (#113 ) * Add a macro to help with deprecations * Suppress warnings about float equality	2020-04-06 09:55:40 -05:00