AuroraMiddleware/DirectXMath
1
0
Fork 0
mirror of https://github.com/microsoft/DirectXMath synced 2024-11-23 12:50:05 +00:00
Code Issues Releases Wiki Activity

Updated Home (markdown)

Chuck Walbourn 2024-10-06 09:23:57 -07:00
parent 5482c66b83
commit 90d59be644
1 changed files with 3 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
Home.md

@ -108,17 +108,6 @@ See [this blog post](https://seanmiddleditch.github.io/matrices-handedness-pre-a
Be sure to read the [Microsoft Docs](https://docs.microsoft.com/windows/win32/dxmath/pg-xnamath-internals#calling-conventions) details on the calling convention types which are designed to deal with the various architectures and vector calling conventions. The best way to ensure you have them correct is to attempt to build your code with x86, x64, and ARM.
# Language extensions
DirectXMath is written using standard Intel-style intrinsics, which should be portable to other compilers. The ARM and ARM64 codepaths use ARM-style intrinsics (earlier versions of the library used Visual C++ specific ``__n64`` and ``__n128``), so these are also portable.
The DirectXMath library make use of two commonly implemented extensions to Standard C++:
* **anonymous structs**, which are widely supported and are part of the C11 standard. Note that the library also uses [anonymous unions](https://wikipedia.org/wiki/Union_type#Anonymous_union), but these are part of the C++ and C99 standard.
* **#pragma once** rather than old-style #define based guards, but are [widely supported](https://en.m.wikipedia.org/wiki/Pragma_once)
> 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
Officially the library is supported with Microsoft Visual C++ 2017 or later, clang/LLVM v9 or later, and GCC 9 or later. It should also compile with the Intel C++ and MinGW compilers.
@ -165,6 +154,7 @@ For the x86/x64 platform, enabling the SVML makes the following DirectXMath func
# Additional content
[[Implementation]] - Information on the DirectXMath coding style
[[Extensions]] - Advanced instruction set variants for DirectXMath
[[SHMath]] - Spherical Harmonics math
[[XDSP]] - Digital Signal Processing helper functions
@ -189,6 +179,8 @@ When you submit a pull request, a CLA bot will automatically determine whether y
Tests for new features should also be submitted as a PR to the [Test Suite](https://github.com/walbourn/directxmathtest/wiki) repository.
Information on coding-style can be found [[here|Implementation]].
# Code of Conduct
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.