Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 29 additions & 3 deletions .github/copilot-instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -335,11 +335,37 @@ When reviewing documentation, do the following:
- Don't fix pre-existing issues unrelated to your task. However, if you discover bugs directly caused by or tightly coupled to the code you're changing, fix those too.
- Update documentation if it is directly related to the changes you are making.
- Always validate that your changes don't break existing behavior.
- Only run linters, builds and tests that already exist. Do not add new linting, building or testing tools unless necessary.
- Use the smallest targeted test, build, or lint command that covers the changed behavior.

### Linting, Building, Testing

- Only run linters, builds and tests that already exist. Do not add new linting, building or testing tools unless necessary for the task.
- Use the smallest targeted test, build, or lint command that covers the changed behavior. When related targeted selectors use the same runner, include them in one invocation; escalate to full-suite or baseline runs only when targeted validation shows they are needed.
- Documentation changes do not need to be linted, built or tested unless there are specific tests for documentation.

### Using Ecosystem Tools

- Prefer ecosystem tools (package managers, scaffolding, refactoring tools, linters) over manual changes.
- Only comment code that needs clarification. Do not comment otherwise.
- Install packages only when changing dependencies or after a missing-dependency failure.

### Code Commenting Style

- Only comment code that needs a bit of clarification. Do not comment otherwise.

## Release Process

The release process is documented in the [release skill](.github/skills/release/SKILL.md). Invoke the `release` skill for step-by-step guidance when performing a release.

## CoPilot Skills

The project includes published CoPilot skills for developers:

- **Release-Process**: Guide for performing the DirectX Tool Kit release process. Invoked when asked to help with releasing a new version, publishing packages, or updating ports. See [Release Process skill](.github/skills/release/SKILL.md) for details.
- **directxtk12-usage**: Provides usage guidance for the DirectX Tool Kit for DX12 library. Located in the `skills/directxtk12-usage/` directory.
- **directxtk12-tutorial**: Provides an interactive tutorial which can create a project, add the toolkit, and implement features in a step-by-step fashion. Located in the `skills/directxtk12-tutorial` directory.

To use these skills in the Copilot CLI:

```bash
/skills list
/skills search directxtk12
```
2 changes: 2 additions & 0 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,7 @@ set(LIBRARY_SOURCES
Src/ModelLoadSDKMESH.cpp
Src/ModelLoadVBO.cpp
Src/NormalMapEffect.cpp
Src/NPREffect.cpp
Src/PBREffect.cpp
Src/PBREffectFactory.cpp
Src/pch.h
Expand All @@ -172,6 +173,7 @@ set(SHADER_SOURCES
Src/Shaders/EnvironmentMapEffect.fx
Src/Shaders/GenerateMips.hlsl
Src/Shaders/NormalMapEffect.fx
Src/Shaders/NPREffect.fx
Src/Shaders/PBREffect.fx
Src/Shaders/PostProcess.fx
Src/Shaders/RootSig.fxh
Expand Down
6 changes: 6 additions & 0 deletions DirectXTK_Desktop_2022_Win10.vcxproj
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,7 @@
<ClCompile Include="Src\Mouse.cpp" />
<ClCompile Include="Src\GraphicsMemory.cpp" />
<ClCompile Include="Src\NormalMapEffect.cpp" />
<ClCompile Include="Src\NPREffect.cpp" />
<ClCompile Include="Src\PBREffect.cpp" />
<ClCompile Include="Src\PBREffectFactory.cpp" />
<ClCompile Include="Src\pch.cpp">
Expand Down Expand Up @@ -193,6 +194,11 @@
<FileType>Document</FileType>
</None>
</ItemGroup>
<ItemGroup>
<None Include="Src\Shaders\NPREffect.fx">
<FileType>Document</FileType>
</None>
</ItemGroup>
<PropertyGroup Label="Globals">
<ProjectGuid>{3E0E8608-CD9B-4C76-AF33-29CA38F2C9F0}</ProjectGuid>
<Keyword>Win32Proj</Keyword>
Expand Down
6 changes: 6 additions & 0 deletions DirectXTK_Desktop_2022_Win10.vcxproj.filters
Original file line number Diff line number Diff line change
Expand Up @@ -281,6 +281,9 @@
<ClCompile Include="Src\NormalMapEffect.cpp">
<Filter>Src</Filter>
</ClCompile>
<ClCompile Include="Src\NPREffect.cpp">
<Filter>Src</Filter>
</ClCompile>
<ClCompile Include="Src\EffectPipelineStateDescription.cpp">
<Filter>Src</Filter>
</ClCompile>
Expand Down Expand Up @@ -376,6 +379,9 @@
<None Include="Src\Shaders\DebugEffect.fx">
<Filter>Src\Shaders</Filter>
</None>
<None Include="Src\Shaders\NPREffect.fx">
<Filter>Src\Shaders</Filter>
</None>
<None Include="README.md" />
<None Include="Src\Shaders\Skinning.fxh">
<Filter>Src\Shaders\Shared</Filter>
Expand Down
6 changes: 6 additions & 0 deletions DirectXTK_Desktop_2026.vcxproj
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,7 @@
<ClCompile Include="Src\Mouse.cpp" />
<ClCompile Include="Src\GraphicsMemory.cpp" />
<ClCompile Include="Src\NormalMapEffect.cpp" />
<ClCompile Include="Src\NPREffect.cpp" />
<ClCompile Include="Src\PBREffect.cpp" />
<ClCompile Include="Src\PBREffectFactory.cpp" />
<ClCompile Include="Src\pch.cpp">
Expand Down Expand Up @@ -193,6 +194,11 @@
<FileType>Document</FileType>
</None>
</ItemGroup>
<ItemGroup>
<None Include="Src\Shaders\NPREffect.fx">
<FileType>Document</FileType>
</None>
</ItemGroup>
<PropertyGroup Label="Globals">
<ProjectGuid>{3E0E8608-CD9B-4C76-AF33-29CA38F2C9F0}</ProjectGuid>
<Keyword>Win32Proj</Keyword>
Expand Down
6 changes: 6 additions & 0 deletions DirectXTK_Desktop_2026.vcxproj.filters
Original file line number Diff line number Diff line change
Expand Up @@ -281,6 +281,9 @@
<ClCompile Include="Src\NormalMapEffect.cpp">
<Filter>Src</Filter>
</ClCompile>
<ClCompile Include="Src\NPREffect.cpp">
<Filter>Src</Filter>
</ClCompile>
<ClCompile Include="Src\EffectPipelineStateDescription.cpp">
<Filter>Src</Filter>
</ClCompile>
Expand Down Expand Up @@ -376,6 +379,9 @@
<None Include="Src\Shaders\DebugEffect.fx">
<Filter>Src\Shaders</Filter>
</None>
<None Include="Src\Shaders\NPREffect.fx">
<Filter>Src\Shaders</Filter>
</None>
<None Include="README.md" />
<None Include="Src\Shaders\Skinning.fxh">
<Filter>Src\Shaders\Shared</Filter>
Expand Down
6 changes: 6 additions & 0 deletions DirectXTK_GDKW_2022.vcxproj
Original file line number Diff line number Diff line change
Expand Up @@ -438,6 +438,7 @@
<ClCompile Include="Src\ModelLoadVBO.cpp" />
<ClCompile Include="Src\Mouse.cpp" />
<ClCompile Include="Src\NormalMapEffect.cpp" />
<ClCompile Include="Src\NPREffect.cpp" />
<ClCompile Include="Src\PBREffect.cpp" />
<ClCompile Include="Src\PBREffectFactory.cpp" />
<ClCompile Include="Src\pch.cpp">
Expand Down Expand Up @@ -511,6 +512,11 @@
<FileType>Document</FileType>
</None>
</ItemGroup>
<ItemGroup>
<None Include="Src\Shaders\NPREffect.fx">
<FileType>Document</FileType>
</None>
</ItemGroup>
<Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
<ImportGroup Label="ExtensionTargets" />
<Target Name="GDKEditionCheck" BeforeTargets="PrepareForBuild" Condition="'$(GDKCrossPlatform)'=='true'">
Expand Down
6 changes: 6 additions & 0 deletions DirectXTK_GDKW_2022.vcxproj.filters
Original file line number Diff line number Diff line change
Expand Up @@ -260,6 +260,9 @@
<ClCompile Include="Src\NormalMapEffect.cpp">
<Filter>Src</Filter>
</ClCompile>
<ClCompile Include="Src\NPREffect.cpp">
<Filter>Src</Filter>
</ClCompile>
<ClCompile Include="Src\PBREffect.cpp">
<Filter>Src</Filter>
</ClCompile>
Expand Down Expand Up @@ -346,6 +349,9 @@
<None Include="Src\Shaders\DebugEffect.fx">
<Filter>Src\Shaders</Filter>
</None>
<None Include="Src\Shaders\NPREffect.fx">
<Filter>Src\Shaders</Filter>
</None>
<None Include="Src\Shaders\DualTextureEffect.fx">
<Filter>Src\Shaders</Filter>
</None>
Expand Down
6 changes: 6 additions & 0 deletions DirectXTK_GDKX_2022.vcxproj
Original file line number Diff line number Diff line change
Expand Up @@ -612,6 +612,7 @@
<ClCompile Include="Src\ModelLoadVBO.cpp" />
<ClCompile Include="Src\Mouse.cpp" />
<ClCompile Include="Src\NormalMapEffect.cpp" />
<ClCompile Include="Src\NPREffect.cpp" />
<ClCompile Include="Src\PBREffect.cpp" />
<ClCompile Include="Src\PBREffectFactory.cpp" />
<ClCompile Include="Src\pch.cpp">
Expand Down Expand Up @@ -693,6 +694,11 @@
<FileType>Document</FileType>
</None>
</ItemGroup>
<ItemGroup>
<None Include="Src\Shaders\NPREffect.fx">
<FileType>Document</FileType>
</None>
</ItemGroup>
<Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
<ImportGroup Label="ExtensionTargets" />
<Target Name="GDKEditionCheck" BeforeTargets="PrepareForBuild" Condition="'$(GDKCrossPlatform)'=='true' AND '$(Platform)'=='x64'">
Expand Down
6 changes: 6 additions & 0 deletions DirectXTK_GDKX_2022.vcxproj.filters
Original file line number Diff line number Diff line change
Expand Up @@ -266,6 +266,9 @@
<ClCompile Include="Src\NormalMapEffect.cpp">
<Filter>Src</Filter>
</ClCompile>
<ClCompile Include="Src\NPREffect.cpp">
<Filter>Src</Filter>
</ClCompile>
<ClCompile Include="Src\PBREffect.cpp">
<Filter>Src</Filter>
</ClCompile>
Expand Down Expand Up @@ -355,6 +358,9 @@
<None Include="Src\Shaders\DebugEffect.fx">
<Filter>Src\Shaders</Filter>
</None>
<None Include="Src\Shaders\NPREffect.fx">
<Filter>Src\Shaders</Filter>
</None>
<None Include="Src\Shaders\DualTextureEffect.fx">
<Filter>Src\Shaders</Filter>
</None>
Expand Down
6 changes: 6 additions & 0 deletions DirectXTK_GDKX_2026.vcxproj
Original file line number Diff line number Diff line change
Expand Up @@ -612,6 +612,7 @@
<ClCompile Include="Src\ModelLoadVBO.cpp" />
<ClCompile Include="Src\Mouse.cpp" />
<ClCompile Include="Src\NormalMapEffect.cpp" />
<ClCompile Include="Src\NPREffect.cpp" />
<ClCompile Include="Src\PBREffect.cpp" />
<ClCompile Include="Src\PBREffectFactory.cpp" />
<ClCompile Include="Src\pch.cpp">
Expand Down Expand Up @@ -693,6 +694,11 @@
<FileType>Document</FileType>
</None>
</ItemGroup>
<ItemGroup>
<None Include="Src\Shaders\NPREffect.fx">
<FileType>Document</FileType>
</None>
</ItemGroup>
<Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
<ImportGroup Label="ExtensionTargets" />
<Target Name="GDKEditionCheck" BeforeTargets="PrepareForBuild" Condition="'$(GDKCrossPlatform)'=='true' AND '$(Platform)'=='x64'">
Expand Down
6 changes: 6 additions & 0 deletions DirectXTK_GDKX_2026.vcxproj.filters
Original file line number Diff line number Diff line change
Expand Up @@ -266,6 +266,9 @@
<ClCompile Include="Src\NormalMapEffect.cpp">
<Filter>Src</Filter>
</ClCompile>
<ClCompile Include="Src\NPREffect.cpp">
<Filter>Src</Filter>
</ClCompile>
<ClCompile Include="Src\PBREffect.cpp">
<Filter>Src</Filter>
</ClCompile>
Expand Down Expand Up @@ -355,6 +358,9 @@
<None Include="Src\Shaders\DebugEffect.fx">
<Filter>Src\Shaders</Filter>
</None>
<None Include="Src\Shaders\NPREffect.fx">
<Filter>Src\Shaders</Filter>
</None>
<None Include="Src\Shaders\DualTextureEffect.fx">
<Filter>Src\Shaders</Filter>
</None>
Expand Down
6 changes: 6 additions & 0 deletions DirectXTK_GDK_2022.vcxproj
Original file line number Diff line number Diff line change
Expand Up @@ -597,6 +597,7 @@
<ClCompile Include="Src\ModelLoadVBO.cpp" />
<ClCompile Include="Src\Mouse.cpp" />
<ClCompile Include="Src\NormalMapEffect.cpp" />
<ClCompile Include="Src\NPREffect.cpp" />
<ClCompile Include="Src\PBREffect.cpp" />
<ClCompile Include="Src\PBREffectFactory.cpp" />
<ClCompile Include="Src\pch.cpp">
Expand Down Expand Up @@ -678,6 +679,11 @@
<FileType>Document</FileType>
</None>
</ItemGroup>
<ItemGroup>
<None Include="Src\Shaders\NPREffect.fx">
<FileType>Document</FileType>
</None>
</ItemGroup>
<Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
<ImportGroup Label="ExtensionTargets" />
<Target Name="EnsureGDK" BeforeTargets="_CheckForInvalidConfigurationAndPlatform" Condition="$([System.Text.RegularExpressions.Regex]::IsMatch('$(Platform)', 'Gaming\..+\.x64'))">
Expand Down
6 changes: 6 additions & 0 deletions DirectXTK_GDK_2022.vcxproj.filters
Original file line number Diff line number Diff line change
Expand Up @@ -266,6 +266,9 @@
<ClCompile Include="Src\NormalMapEffect.cpp">
<Filter>Src</Filter>
</ClCompile>
<ClCompile Include="Src\NPREffect.cpp">
<Filter>Src</Filter>
</ClCompile>
<ClCompile Include="Src\PBREffect.cpp">
<Filter>Src</Filter>
</ClCompile>
Expand Down Expand Up @@ -355,6 +358,9 @@
<None Include="Src\Shaders\DebugEffect.fx">
<Filter>Src\Shaders</Filter>
</None>
<None Include="Src\Shaders\NPREffect.fx">
<Filter>Src\Shaders</Filter>
</None>
<None Include="Src\Shaders\DualTextureEffect.fx">
<Filter>Src\Shaders</Filter>
</None>
Expand Down
6 changes: 6 additions & 0 deletions DirectXTK_Windows10_2022.vcxproj
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,7 @@
<ClCompile Include="Src\ModelLoadVBO.cpp" />
<ClCompile Include="Src\Mouse.cpp" />
<ClCompile Include="Src\NormalMapEffect.cpp" />
<ClCompile Include="Src\NPREffect.cpp" />
<ClCompile Include="Src\PBREffect.cpp" />
<ClCompile Include="Src\PBREffectFactory.cpp" />
<ClCompile Include="Src\pch.cpp">
Expand Down Expand Up @@ -195,6 +196,11 @@
<FileType>Document</FileType>
</None>
</ItemGroup>
<ItemGroup>
<None Include="Src\Shaders\NPREffect.fx">
<FileType>Document</FileType>
</None>
</ItemGroup>
<PropertyGroup Label="Globals">
<ProjectGuid>{945B8F0E-AE5F-447C-933A-9D069532D3E4}</ProjectGuid>
<Keyword>StaticLibrary</Keyword>
Expand Down
6 changes: 6 additions & 0 deletions DirectXTK_Windows10_2022.vcxproj.filters
Original file line number Diff line number Diff line change
Expand Up @@ -221,6 +221,9 @@
<None Include="Src\Shaders\DebugEffect.fx">
<Filter>Src\Shaders</Filter>
</None>
<None Include="Src\Shaders\NPREffect.fx">
<Filter>Src\Shaders</Filter>
</None>
<None Include="README.md" />
<None Include="Src\Shaders\Skinning.fxh">
<Filter>Src\Shaders\Shared</Filter>
Expand Down Expand Up @@ -350,6 +353,9 @@
<ClCompile Include="Src\NormalMapEffect.cpp">
<Filter>Src</Filter>
</ClCompile>
<ClCompile Include="Src\NPREffect.cpp">
<Filter>Src</Filter>
</ClCompile>
<ClCompile Include="Src\EffectPipelineStateDescription.cpp">
<Filter>Src</Filter>
</ClCompile>
Expand Down
Loading
Loading