AuroraMiddleware/DirectXMath
1
0
Fork 0
mirror of https://github.com/microsoft/DirectXMath synced 2024-11-24 21:20:13 +00:00
Code Issues Releases Wiki Activity

Updated Implementation (markdown)

Chuck Walbourn 2024-10-06 09:28:12 -07:00
parent 4203e5e7f4
commit a3a4a07972
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Implementation.md

@ -22,3 +22,10 @@ The DirectXMath library make use of two commonly implemented extensions to Stand
* UPPERCASE for preprocessor defines (and nameless enums)
The library does not generally make use of [Hungarian notation](https://wikipedia.org/wiki/Hungarian_notation) which as been deprecated for Win32 C++ APIs for many years, with the exception of a few uses of ``p`` for pointers and ``sz`` for strings.
# Type usage
The use of Standard C++ types is preferred including the fundamental types supplied by the language (i.e. ``int``, ``unsigned int``, ``size_t``, ``ptrdiff_t``, ``bool``, ``true``/``false``, ``char``, ``wchar_t``) with the addition of the C99 fixed width types (i.e. ``uint32_t``, ``uint64_t``, ``intptr_t``, ``uintptr_t``, etc.)
Avoid using Windows "portability" types except when dealing directly with Win32 APIs: ``VOID``, ``UINT``, ``INT``, ``DWORD``, ``FLOAT``, ``BOOL``, ``TRUE``/``FALSE``, ``WCHAR``, ``CONST``, etc.