Commit debd423c authored by Chuck Walbourn's avatar Chuck Walbourn
Browse files

Updated readme

parent 21a43b62
Loading
Loading
Loading
Loading
+128 −0
Original line number Diff line number Diff line
@@ -13,12 +13,140 @@ This repo contains game development samples written by the Microsoft Xbox Advanc
* ``PCSamples`` contains samples for the classic Win32 desktop PC platform
  * ``IntroGraphics``

## Samples by category

### Audio

<table>
 <tr>
  <td>Spatial audio</td>
  <td><a href="UWPSamples/Audio/SimpleSpatialPlaySoundUWP">Simple playback</a></td>
  <td><a href="UWPSamples/Audio/SimplePlay3DSpatialSoundUWP">3D playback</a></td>
  <td><a href="UWPSamples/Audio/AdvancedSpatialSoundsUWP">Advanced audio</a></td>
 </tr>
 <tr>
  <td>XAudio2</td>
  <td><a href="UWPSamples/Audio/SimplePlaySoundUWP">Basic audio playback</a></td>
  <td><a href="UWPSamples/Audio/SimplePlay3DSoundUWP">3D playback</a></td>
 </tr>
 <tr>
  <td>WASAPI</td>
  <td><a href="UWPSamples/Audio/SimpleWASAPIPlaySoundUWP">Playback</a></td>
  <td><a href="UWPSamples/Audio/SimpleWASAPICaptureUWP">Capture</a></td>
 </tr>
</table>

### Introductory Graphics

<table>
 <tr>
  <td>Basic drawing</td>
  <td><a href="UWPSamples/IntroGraphics/SimpleTriangleUWP">UWP DX11</a></td>
  <td><a href="UWPSamples/IntroGraphics/SimpleTriangleUWP12">UWP DX12</a></td>
  <td><a href="PCSamples/IntroGraphics/SimpleTrianglePC">PC DX11</a></td>
  <td><a href="PCSamples/IntroGraphics/SimpleTrianglePC12">PC DX12</a></td>
 </tr>
 <tr>
  <td>Basic texturing</td>
  <td><a href="UWPSamples/IntroGraphics/SimpleTextureUWP">UWP DX11</a></td>
  <td><a href="UWPSamples/IntroGraphics/SimpleTextureUWP12">UWP DX12</a></td>
  <td><a href="PCSamples/IntroGraphics/SimpleTexturePC">PC DX11</a></td>
  <td><a href="PCSamples/IntroGraphics/SimpleTexturePC12">PC DX12</a></td>
 </tr>
 <tr>
  <td>Basic lighting</td>
  <td><a href="UWPSamples/IntroGraphics/SimpleLightingUWP">UWP DX11</a></td>
  <td><a href="UWPSamples/IntroGraphics/SimpleLightingUWP12">UWP DX12</a></td>
 </tr>
 <tr>
  <td>Bezier</td>
  <td><a href="UWPSamples/IntroGraphics/SimpleBezierUWP">UWP DX11</a></td>
  <td><a href="UWPSamples/IntroGraphics/SimpleBezierUWP12">UWP DX12</a></td>
 </tr>
 <tr>
  <td>DirectCompute</td>
  <td><a href="UWPSamples/IntroGraphics/SimpleComputeUWP">UWP DX11</a></td>
  <td><a href="UWPSamples/IntroGraphics/SimpleComputeUWP12">UWP DX12</a></td>
 </tr>
 <tr>
  <td>DirectX Tool Kit</td>
  <td><a href="UWPSamples/IntroGraphics/DirectXTKSimpleSampleUWP">UWP DX11</a></td>
  <td><a href="UWPSamples/IntroGraphics/DirectXTKSimpleSampleUWP12">UWP DX12</a></td>
  <td><a href="PCSamples/IntroGraphics/DirectXTKSimpleSamplePC">PC DX11</a></td>
  <td><a href="PCSamples/IntroGraphics/DirectXTKSimpleSamplePC12">PC DX12</a></td>
 </tr>
 <tr>
  <td>Instancing</td>
  <td><a href="UWPSamples/IntroGraphics/SimpleInstancingUWP">UWP DX11</a></td>
  <td><a href="UWPSamples/IntroGraphics/SimpleInstancingUWP12">UWP DX12</a></td>
 </tr>
 <tr>
  <td>Multisample Antialiasing</td>
  <td><a href="UWPSamples/IntroGraphics/SimpleMSAA_UWP">UWP DX11</a></td>
  <td><a href="UWPSamples/IntroGraphics/SimpleMSAA_UWP12">UWP DX12</a></td>
 </tr>
</table>

### Graphics

<table>
 <tr>
  <td><a href="UWPSamples/Graphics/SimplePBR12_UWP">Physically Based Rendering</a></td>
 </tr>
</table>

### System

<table>
 <tr>
  <td><a href="UWPSamples/System/CPUSets">CPU Sets</a></td>
  <td><a href="UWPSamples/System/MemoryStatisticsUWP">Memory Statistics</a></td>
  <td><a href="UWPSamples/System/SystemInfoUWP">System Information</a></td>
  <td><a href="UWPSamples/System/CollisionUWP">DirectXMath</a></td>
 </tr>
</table>

<table>
 <tr>
  <td>Gamepad</td>
  <td><a href="UWPSamples/System/GamepadUWP">C++/CX</a></td>
  <td><a href="UWPSamples/System/GamepadCppWinRT_UWP">C++/WinRT</a></td>
  <td><a href="UWPSamples/System/GamepadVibrationUWP">Vibration</a></td>
  <td><a href="UWPSamples/System/RawGameControllerUWP">Raw</a></td>
 </tr>
 <tr>
  <td>Input</td>
  <td><a href="UWPSamples/System/InputInterfacingUWP">Interfacing</a></td>
  <td><a href="UWPSamples/System/MouseCursor">Mouse</a></td>
  <td><a href="UWPSamples/System/UserGamepadPairingUWP">User-pairing</a></td>
 </tr>
 <tr>
  <td>Process Lifetime Management</td>
  <td><a href="UWPSamples/System/SimplePLM_UWP">PLM</a></td>
  <td><a href="UWPSamples/System/ExtendedExecutionUWP">Extended Execution</a></td>
 </tr>
 <tr>
  <td>Localization</td>
  <td><a href="UWPSamples/System/NLSAndLocalizationUWP">NLS</a></td>
 </tr>
</table>

### Tools

<table>
 <tr>
  <td><a href="UWPSamples/Tools/errorlookup/errorlookup">Error lookup</a></td>
 </tr>
</table>

# Requirements

## UWP apps
* Windows 10 Creators Update (Build 15063)
* Visual Studio 2017 with the *Universal Windows Platform development* workload, the *C++ Universal Windows Platform tools* component, *Windows 10 SDK (10.0.15063.0)*, and *Windows 10 SDK (10.0.14393.0)*.

Use of the Visual Studio 2017 update v15.3 is recommended.

> The *Windows 10 SDK (10.0.14393.0)* is required to support ``WindowsTargetPlatformMinVersion`` set the Windows 10 Anniversary Update in many of the samples that work on both versions of Windows 10.

## PC apps