1
0
mirror of https://github.com/microsoft/DirectXMath synced 2024-09-19 14:49:54 +00:00

Updated Home (markdown)

Chuck Walbourn 2021-09-18 16:17:03 -07:00
parent be21fa9da1
commit 4289b269d4

18
Home.md

@ -108,9 +108,9 @@ The DirectXMath library make use of two commonly implemented extensions to Stand
> Because of these, DirectXMath is not compatible with Visual C++'s ``/Za`` switch which enforces ISO C89 / C++11. It does work with ``/permissive-``.
## Compiler support
# Compiler support
In addition to Microsoft Visual C++, the library has been compiled with the Intel C++ 18.0 compiler and clang/LLVM v9 to verify conformance. It should also work with GCC and MinGW.
In addition to Microsoft Visual C++, the library has been compiled with the Intel C++ 18.0 compiler, clang/LLVM v9, and GNUC 9 to verify conformance. It should also work with MinGW.
When building with clang/LLVM or other GNU C compilers, the ``_XM_NO_XMVECTOR_OVERLOADS_`` control define is set because these compilers do not support creating operator overloads for the ``XMVECTOR`` type. You can choose to enable this preprocessor define explicitly to do the same thing with Visual C++ for improved portability.
@ -148,6 +148,18 @@ For the x86/x64 platform, enabling the SVML makes the following DirectXMath func
# Related
See the _DirectX Tool Kit_'s [SimpleMath](https://github.com/Microsoft/DirectXTK/wiki/SimpleMath) wrapper for DirectXMath.
# Contributing
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
# Trademarks
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow [Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general). Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.
# Credits
The xboxmath library was originated by Matt Bronder with contributions from Sakphong Chanbai and David Hefner for the Xbox 360.
@ -163,5 +175,3 @@ Thanks to Bruce Dawson for his help with the rounding functions.
Thanks to Andrew Farrier for the fixes to ``XMVerifyCPUSupport`` to properly support clang.
Thanks to Scott Matloff for his help in getting the library updated to use Intel SVML for VS 2019.
Special thanks to Andy Glaister and Shawn Hargreaves for their on-going support and sponsorship.