Minor code review and CoPilot instructions update (#243)

Author: walbourn

.azuredevops/pipelines/DirectXMesh-GitHub-CMake-Dev17.yml

@@ -57,7 +57,7 @@ variables:
   Codeql.Enabled: false
   VS_GENERATOR: 'Visual Studio 17 2022'
   WIN10_SDK: '10.0.19041.0'
-  WIN11_SDK: '10.0.22000.0'
+  WIN11_SDK: '10.0.26100.0'
 
 pool:
   vmImage: windows-2022

.azuredevops/pipelines/DirectXMesh-GitHub-CMake.yml

@@ -57,7 +57,7 @@ variables:
   Codeql.Enabled: false
   VS_GENERATOR: 'Visual Studio 17 2022'
   WIN10_SDK: '10.0.19041.0'
-  WIN11_SDK: '10.0.22000.0'
+  WIN11_SDK: '10.0.26100.0'
 
 pool:
   vmImage: windows-2022

.azuredevops/pipelines/DirectXMesh-OneFuzz.yml

@@ -32,7 +32,7 @@ name: $(Year:yyyy).$(Month).$(DayOfMonth)$(Rev:.r)
 variables:
   Codeql.Enabled: false
   VS_GENERATOR: 'Visual Studio 17 2022'
-  WIN11_SDK: '10.0.22000.0'
+  WIN11_SDK: '10.0.26100.0'
 
 pool:
   vmImage: windows-2022

.github/copilot-instructions.md

@@ -23,7 +23,7 @@ These instructions define how GitHub Copilot should assist with this project. Th
 - **Documentation**: The project provides documentation in the form of wiki pages available at [Documentation](https://github.com/microsoft/DirectXMesh/wiki/).
 - **Error Handling**: Use C++ exceptions for error handling and uses RAII smart pointers to ensure resources are properly managed. For some functions that return HRESULT error codes, they are marked `noexcept`, use `std::nothrow` for memory allocation, and should not throw exceptions.
 - **Testing**: Unit tests for this project are implemented in this repository [Test Suite](https://github.com/walbourn/directxmeshtest/) and can be run using CTest per the instructions at [Test Documentation](https://github.com/walbourn/directxmeshtest/wiki).
-- **Security**: This project uses secure coding practices from the Microsoft Secure Coding Guidelines, and is subject to the `SECURITY.md` file in the root of the repository. Functions that read input from geometry files are subject to OneFuzz testing to ensure they are secure against malformed files.
+- **Security**: This project uses secure coding practices from the Microsoft Secure Coding Guidelines, and is subject to the `SECURITY.md` file in the root of the repository. Functions that read input from geometry files are subject to OneFuzz fuzz testing to ensure they are secure against malformed files.
 - **Dependencies**: The project uses CMake and VCPKG for managing dependencies, making optional use of DirectXMath and DirectX-Headers. The project can be built without these dependencies, relying on the Windows SDK for core functionality.
 - **Continuous Integration**: This project implements GitHub Actions for continuous integration, ensuring that all code changes are tested and validated before merging. This includes building the project for a number of configurations and toolsets, running a subset of unit tests, and static code analysis including GitHub super-linter, CodeQL, and MSVC Code Analysis.
 - **Code of Conduct**: The project adheres to the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). All contributors are expected to follow this code of conduct in all interactions related to the project.
@@ -61,11 +61,13 @@ Tests/        # Tests are designed to be cloned from a separate repository at th
 
 ## References
 
+- [Source git repository on GitHub](https://github.com/microsoft/DirectXMesh.git)
+- [DirectXMesh documentation git repository on GitHub](https://github.com/microsoft/DirectXMesh.wiki.git)
+- [DirectXMesh test suite git repository on GitHub](https://github.com/walbourn/directxmeshtest.wiki.git).
 - [C++ Core Guidelines](https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines)
 - [Microsoft Secure Coding Guidelines](https://learn.microsoft.com/en-us/security/develop/secure-coding-guidelines)
 - [CMake Documentation](https://cmake.org/documentation/)
-- [VCPK Documentation](https://learn.microsoft.com/vcpkg/)
-- [DirectXMesh Wiki](https://github.com/microsoft/DirectXMesh/wiki/)
+- [VCPKG Documentation](https://learn.microsoft.com/vcpkg/)
 - [Games for Windows and the DirectX SDK blog - June 2014](https://walbourn.github.io/directxmesh/)
 - [Games for Windows and the DirectX SDK blog - April 2025](https://walbourn.github.io/github-project-updates-2025/)
 
@@ -96,3 +98,41 @@ When creating documentation:
 - Review each documented item against source code whenever related to the task.
 - Remove any speculative content.
 - Ensure all documentation is verifiable against the current state of the codebase.
+
+## Cross-platform Support Notes
+
+- The code supports building for Windows and Linux.
+- Portability and conformance of the code is validated by building with Visual C++, clang/LLVM for Windows, MinGW, and GCC for Linux.
+
+The following symbols are not custom error codes, but aliases for `HRESULT_FROM_WIN32` error values.
+
+| Symbol | Standard Win32 HRESULT |
+|--------|-------------|
+| `HRESULT_E_ARITHMETIC_OVERFLOW` | `HRESULT_FROM_WIN32(ERROR_ARITHMETIC_OVERFLOW)` |
+| `HRESULT_E_NOT_SUPPORTED` | `HRESULT_FROM_WIN32(ERROR_NOT_SUPPORTED)` |
+| `HRESULT_E_INVALID_NAME` | `HRESULT_FROM_WIN32(ERROR_INVALID_NAME)` |
+
+## Code Review Instructions
+
+When reviewing code, focus on the following aspects:
+
+- Adherence to coding standards defined in `.editorconfig` and on the [wiki](https://github.com/microsoft/DirectXTK/wiki/Implementation).
+- Make coding recommendations based on the *C++ Core Guidelines*.
+- Proper use of RAII and smart pointers.
+- Correct error handling practices and C++ Exception safety.
+- Clarity and maintainability of the code.
+- Adequate comments where necessary.
+- Public interfaces located in `DirectXMesh.h` should be clearly defined and documented on the GitHub wiki.
+- Compliance with the project's architecture and design patterns.
+- Ensure that all public functions and classes are covered by unit tests located on [GitHub](https://github.com/walbourn/directxmeshtest.git) where applicable. Report any gaps in test coverage.
+- Check for performance implications, especially in geometry processing algorithms.
+- Provide brutally honest feedback on code quality, design, and potential improvements as needed.
+
+## Documentation Review Instructions
+
+When reviewing documentation, do the following:
+
+- Read the code located in [this git repository](https://github.com/microsoft/DirectXMesh.git) in the main branch.
+- Review the public interface defined in `DirectXMesh.h`, as well as the headers in the `Utilities` folder.
+- Read the documentation on the wiki located in [this git repository](https://github.com/microsoft/DirectXMesh.wiki.git).
+- Report any specific gaps in the documentation compared to the public interface.

.gitignore

@@ -18,6 +18,7 @@
 *.VC.db
 *.nupkg
 .vs
+.vscode
 [Bb]in
 /ipch
 Debug

CMakeLists.txt

@@ -31,6 +31,8 @@ option(ENABLE_CODE_ANALYSIS "Use Static Code Analysis on build" OFF)
 
 option(ENABLE_CODE_COVERAGE "Build with code-coverage" OFF)
 
+option(ENABLE_CODE_PROFILING "Build for profiling" OFF)
+
 option(BUILD_FUZZING "Build for fuzz testing" OFF)
 
 set(CMAKE_CXX_STANDARD 17)
@@ -286,6 +288,13 @@ elseif(CMAKE_CXX_COMPILER_ID MATCHES "MSVC")
       endforeach()
     endif()
 
+    if(ENABLE_CODE_PROFILING)
+      message(STATUS "Building with /PROFILE")
+      foreach(t IN LISTS TOOL_EXES ITEMS ${PROJECT_NAME})
+        target_link_options(${t} PRIVATE /profile)
+      endforeach()
+    endif()
+
     if(ENABLE_SPECTRE_MITIGATION
        AND (CMAKE_CXX_COMPILER_VERSION VERSION_GREATER_EQUAL 19.13)
        AND (NOT WINDOWS_STORE))

DirectXMesh/DirectXMeshUtil.cpp

@@ -270,6 +270,9 @@ void DirectX::ComputeInputLayout(
 {
     assert(IsValid(vbDecl, nDecl));
 
+    if (!vbDecl || !nDecl)
+        return;
+
     if (offsets)
         memset(offsets, 0, sizeof(uint32_t) * nDecl);
 
@@ -334,6 +337,9 @@ void DirectX::ComputeInputLayout(const D3D12_INPUT_LAYOUT_DESC& vbDecl,
 {
     assert(IsValid(vbDecl));
 
+    if (!vbDecl.pInputElementDescs || !vbDecl.NumElements)
+        return;
+
     if (offsets)
         memset(offsets, 0, sizeof(uint32_t) * vbDecl.NumElements);
 

Utilities/FlexibleVertexFormat.h

@@ -42,7 +42,7 @@ namespace FVF
 
     static_assert(std::size(g_declTypeSizes) == D3DDECLTYPE_UNUSED, "Mismatch of array size");
 
-    inline size_t ComputeVertexSize(uint32_t fvfCode)
+    inline size_t ComputeVertexSize(uint32_t fvfCode) noexcept
     {
         if ((fvfCode & ((D3DFVF_RESERVED0 | D3DFVF_RESERVED2) & ~D3DFVF_POSITION_MASK)) != 0)
             return 0;
@@ -109,7 +109,7 @@ namespace FVF
         return vertexSize;
     }
 
-    inline size_t ComputeVertexSize(const D3DVERTEXELEMENT9* pDecl, uint32_t stream)
+    inline size_t ComputeVertexSize(const D3DVERTEXELEMENT9* pDecl, uint32_t stream) noexcept
     {
         if (!pDecl || stream >= 16u /*D3D10_IA_VERTEX_INPUT_RESOURCE_SLOT_COUNT*/)
             return 0;
@@ -145,7 +145,7 @@ namespace FVF
 
     // More secure version
     inline size_t ComputeVertexSize(
-        _In_reads_(maxDeclLength) const D3DVERTEXELEMENT9* pDecl, size_t maxDeclLength, uint32_t stream)
+        _In_reads_(maxDeclLength) const D3DVERTEXELEMENT9* pDecl, size_t maxDeclLength, uint32_t stream) noexcept
     {
         if (!pDecl || stream >= 16u /*D3D10_IA_VERTEX_INPUT_RESOURCE_SLOT_COUNT*/)
             return 0;
@@ -182,7 +182,7 @@ namespace FVF
         return currentSize;
     }
 
-    inline size_t GetDeclLength(const D3DVERTEXELEMENT9* pDecl)
+    inline size_t GetDeclLength(const D3DVERTEXELEMENT9* pDecl) noexcept
     {
         if (!pDecl)
             return 0;
@@ -639,7 +639,7 @@ namespace FVF
     }
 #endif // __d3d12_h__
 
-    inline uint32_t ComputeFVF(const D3DVERTEXELEMENT9* pDecl)
+    inline uint32_t ComputeFVF(const D3DVERTEXELEMENT9* pDecl) noexcept
     {
         if (!pDecl)
             return 0;
@@ -832,7 +832,7 @@ namespace FVF
 
     // More secure version
     inline uint32_t ComputeFVF(
-        _In_reads_(maxDeclLength) const D3DVERTEXELEMENT9* pDecl, size_t maxDeclLength)
+        _In_reads_(maxDeclLength) const D3DVERTEXELEMENT9* pDecl, size_t maxDeclLength) noexcept
     {
         if (!pDecl)
             return 0;