BlackMATov/vmath.hpp
1
0
Fork 0
mirror of https://github.com/BlackMATov/vmath.hpp.git synced 2025-12-14 20:31:25 +07:00
Code Issues Packages Projects Releases Wiki Activity

add disclaimer to readme

Browse Source
This commit is contained in:
BlackMATov
2020-11-28 06:35:11 +07:00
parent e58befe4d7
commit 10bc8e6b92
1 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -46,6 +46,12 @@ add_subdirectory(external/vmath.hpp)
target_link_libraries(your_project_target vmath.hpp)
```
## Disclaimer
The [vmath.hpp][vmath] is a tiny vector math library mainly for games, game engines, and other graphics software. It will never be mathematically strict (e.g. the vector class has operator plus for adding scalars to a vector, which is convenient for developing CG applications but makes no sense in "real" math). For the same reason, the library does not provide flexible vector and matrix sizes. The library functions follow the same principles.
Most functions and types are based on the HLSL ([High-Level Shading Language for DirectX](https://docs.microsoft.com/en-us/windows/win32/direct3dhlsl/dx-graphics-hlsl)) specification. Matrices are row-major, which implies that vector, matrix multiplication is: v * M, not M * v.
## API
- [Vector Types](#Vector-Types)