Skip to content

Commit

Permalink
docs: build_flags.md
Browse files Browse the repository at this point in the history
  • Loading branch information
maihd committed Mar 28, 2024
1 parent 4a4a129 commit fe4becb
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ so other languages you should use the libraries written specifily for thoses lan
- Why Unlicense? Mostly source codes were re-written from The-Forge's VectorMath library, so I don't own the code. (I found the code with the same design with this library, but older: https://github.com/zauonlok/renderer/blob/master/renderer/core/maths.h)
- Where the functions docs, and tutorials? WIP.
- Advance usages, configs, build flags docs? Find out in [build_flags](docs/build_flags.md).
- More examples on some popular renderers (bgfx, The-Forge)? Learning.
- I want to use it with Raylib? replace struct definition of VectorX with typedef and it will work, Matrix must be do more work.
- More about performance? Not the fastest, but enough to use with small project.
Expand Down
14 changes: 14 additions & 0 deletions docs/build_flags.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Build flags and config details
- `VECTORMATH_ENABLE_CLANG_EXT`:
- Compiler options: `-DVECTORMATH_ENABLE_CLANG_EXT`
- Use clang vector extensions, only work with clang compiler.
- Clang vector extensions support swizzle syntaxes.

- `VECTORMATH_SIMD_ENABLE`:
- Compiler options: `-DVECTORMATH_SIMD_ENABLE`
- Prefer to use SIMD if available, autoconfig to use SSE or NEON based on target platform.

- `VECTORMATH_USE_EXACT_PRECISION`:
- Compiler options: `-DVECTORMATH_USE_EXACT_PRECISION`
- Prefer good precision over fast math (currently use idSoftware FastInvSqrt)
- Planning to do some fast trigonometric with simd instructions

0 comments on commit fe4becb

Please sign in to comment.