Merge pull request #45 from Microsoft/develop

merge develop into master for 10/30 release

Author: bobbrow

README.md

@@ -1,5 +1,5 @@
 # DirectX-Graphics-Samples
-This repo contains the DirectX Graphics samples that demonstrate how to build graphics intensive applications for Windows 10.
+This repo contains the DirectX Graphics samples that demonstrate how to build graphics intensive applications for Windows 10. We also have a YouTube channel! Visit us here: https://www.youtube.com/MicrosoftDirectX12andGraphicsEducation
 
 ## API Samples
 In the Samples directory, you will find samples that attempt to break off specific features and specific usage scenarios into bite sized chunks. For example, the ExecuteIndirect sample will show you just enough about execute indirect to get started with that feature without diving too deep into multiengine whereas the nBodyGravity sample will delve into multiengine without touching on the execute indirect feature etc. By doing this, we hope to make it easier to get started with DirectX 12.
@@ -33,4 +33,5 @@ It came from a desire to quickly dive into graphics and performance experiments.
 ## Contributing
 We're always looking for your help to fix bugs and improve the samples.  File those pull requests and we'll be happy to take a look.
 
-Find more information on DirectX 12 on our blog: http://blogs.msdn.com/b/directx/
+Find more information on DirectX 12 on our blog: http://blogs.msdn.com/b/directx/
+

Samples/D3D1211On12/src/D3D1211On12.cpp

@@ -285,6 +285,10 @@ void D3D1211on12::LoadAssets()
 		ThrowIfFailed(m_textFormat->SetParagraphAlignment(DWRITE_PARAGRAPH_ALIGNMENT_CENTER));
 	}
 
+	// Note: ComPtr's are CPU objects but this resource needs to stay in scope until
+	// the command list that references it has finished executing on the GPU.
+	// We will flush the GPU at the end of this method to ensure the resource is not
+	// prematurely destroyed.
 	ComPtr<ID3D12Resource> vertexBufferUpload;
 
 	// Create the vertex buffer.
@@ -413,7 +417,8 @@ void D3D1211on12::RenderUI()
 
 void D3D1211on12::OnDestroy()
 {
-	// Wait for the GPU to be done with all resources.
+	// Ensure that the GPU is no longer referencing resources that are about to be
+	// cleaned up by the destructor.
 	WaitForGpu();
 
 	CloseHandle(m_fenceEvent);

Samples/D3D1211On12/src/D3D1211On12.h

@@ -14,7 +14,13 @@
 #include "DXSample.h"
 
 using namespace DirectX;
-using namespace Microsoft::WRL;
+
+// Note that while ComPtr is used to manage the lifetime of resources on the CPU,
+// it has no understanding of the lifetime of resources on the GPU. Apps must account
+// for the GPU lifetime of resources to avoid destroying objects that may still be
+// referenced by the GPU.
+// An example of this can be found in the class method: OnDestroy().
+using Microsoft::WRL::ComPtr;
 
 class D3D1211on12 : public DXSample
 {

Samples/D3D12Bundles/src/D3D12Bundles.cpp

@@ -156,7 +156,10 @@ void D3D12Bundles::LoadPipeline()
 // Load the sample assets.
 void D3D12Bundles::LoadAssets()
 {
-	// These upload heaps are only needed during loading.
+	// Note: ComPtr's are CPU objects but these resources need to stay in scope until
+	// the command list that references them has finished executing on the GPU.
+	// We will flush the GPU at the end of this method to ensure the resources are not
+	// prematurely destroyed.
 	ComPtr<ID3D12Resource> vertexBufferUploadHeap;
 	ComPtr<ID3D12Resource> indexBufferUploadHeap;
 	ComPtr<ID3D12Resource> textureUploadHeap;
@@ -496,7 +499,8 @@ void D3D12Bundles::OnRender()
 
 void D3D12Bundles::OnDestroy()
 {
-	// Wait for the GPU to be done with all resources.
+	// Ensure that the GPU is no longer referencing resources that are about to be
+	// cleaned up by the destructor.
 	{
 		const UINT64 fence = m_fenceValue;
 		const UINT64 lastCompletedFence = m_fence->GetCompletedValue();

Samples/D3D12Bundles/src/D3D12Bundles.h

@@ -17,8 +17,13 @@
 #include "SimpleCamera.h"
 
 using namespace DirectX;
-using namespace std;
-using namespace Microsoft::WRL;
+
+// Note that while ComPtr is used to manage the lifetime of resources on the CPU,
+// it has no understanding of the lifetime of resources on the GPU. Apps must account
+// for the GPU lifetime of resources to avoid destroying objects that may still be
+// referenced by the GPU.
+// An example of this can be found in the class method: OnDestroy().
+using Microsoft::WRL::ComPtr;
 
 class D3D12Bundles : public DXSample
 {
@@ -69,7 +74,7 @@ class D3D12Bundles : public DXSample
 	SimpleCamera m_camera;
 
 	// Frame resources.
-	vector<FrameResource*> m_frameResources;
+	std::vector<FrameResource*> m_frameResources;
 	FrameResource* m_pCurrentFrameResource;
 	UINT m_currentFrameResourceIndex;
 

Samples/D3D12Bundles/src/FrameResource.h

@@ -14,8 +14,7 @@
 #include "DXSampleHelper.h"
 
 using namespace DirectX;
-using namespace std;
-using namespace Microsoft::WRL;
+using Microsoft::WRL::ComPtr;
 
 class FrameResource
 {
@@ -36,7 +35,7 @@ class FrameResource
 	ConstantBuffer* m_pConstantBuffers;
 	UINT64 m_fenceValue;
 
-	vector<XMFLOAT4X4> m_modelMatrices;
+	std::vector<XMFLOAT4X4> m_modelMatrices;
 	UINT m_cityRowCount;
 	UINT m_cityColumnCount;
 

Samples/D3D12DynamicIndexing/src/D3D12DynamicIndexing.cpp

@@ -160,7 +160,10 @@ void D3D12DynamicIndexing::LoadPipeline()
 // Load the sample assets.
 void D3D12DynamicIndexing::LoadAssets()
 {
-	// These upload heaps are only needed during loading.
+	// Note: ComPtr's are CPU objects but these resources need to stay in scope until
+	// the command list that references them has finished executing on the GPU.
+	// We will flush the GPU at the end of this method to ensure the resources are not
+	// prematurely destroyed.
 	ComPtr<ID3D12Resource> vertexBufferUploadHeap;
 	ComPtr<ID3D12Resource> indexBufferUploadHeap;
 	ComPtr<ID3D12Resource> textureUploadHeap;
@@ -330,7 +333,7 @@ void D3D12DynamicIndexing::LoadAssets()
 			float materialGradStep = (1.0f / static_cast<float>(CityMaterialCount));
 
 			// Generate texture data.
-			vector<vector<unsigned char>> cityTextureData;
+			std::vector<std::vector<unsigned char>> cityTextureData;
 			cityTextureData.resize(CityMaterialCount);
 			for (int i = 0; i < CityMaterialCount; ++i)
 			{
@@ -594,7 +597,8 @@ void D3D12DynamicIndexing::OnRender()
 
 void D3D12DynamicIndexing::OnDestroy()
 {
-	// Wait for the GPU to be done with all resources.
+	// Ensure that the GPU is no longer referencing resources that are about to be
+	// cleaned up by the destructor.
 	{
 		const UINT64 fence = m_fenceValue;
 		const UINT64 lastCompletedFence = m_fence->GetCompletedValue();

Samples/D3D12DynamicIndexing/src/D3D12DynamicIndexing.h

@@ -17,8 +17,13 @@
 #include "SimpleCamera.h"
 
 using namespace DirectX;
-using namespace std;
-using namespace Microsoft::WRL;
+
+// Note that while ComPtr is used to manage the lifetime of resources on the CPU,
+// it has no understanding of the lifetime of resources on the GPU. Apps must account
+// for the GPU lifetime of resources to avoid destroying objects that may still be
+// referenced by the GPU.
+// An example of this can be found in the class method: OnDestroy().
+using Microsoft::WRL::ComPtr;
 
 class D3D12DynamicIndexing : public DXSample
 {
@@ -74,7 +79,7 @@ class D3D12DynamicIndexing : public DXSample
 	SimpleCamera m_camera;
 
 	// Frame resources.
-	vector<FrameResource*> m_frameResources;
+	std::vector<FrameResource*> m_frameResources;
 	FrameResource* m_pCurrentFrameResource;
 	UINT m_currentFrameResourceIndex;
 

Samples/D3D12DynamicIndexing/src/FrameResource.h

@@ -14,8 +14,7 @@
 #include "DXSampleHelper.h"
 
 using namespace DirectX;
-using namespace std;
-using namespace Microsoft::WRL;
+using Microsoft::WRL::ComPtr;
 
 class FrameResource
 {
@@ -36,7 +35,7 @@ class FrameResource
 	ConstantBuffer* m_pConstantBuffers;
 	UINT64 m_fenceValue;
 
-	vector<XMFLOAT4X4> m_modelMatrices;
+	std::vector<XMFLOAT4X4> m_modelMatrices;
 	UINT m_cityRowCount;
 	UINT m_cityColumnCount;
 	UINT m_cityMaterialCount;

Samples/D3D12ExecuteIndirect/src/D3D12ExecuteIndirect.cpp

@@ -266,6 +266,10 @@ void D3D12ExecuteIndirect::LoadAssets()
 	ThrowIfFailed(m_device->CreateCommandList(0, D3D12_COMMAND_LIST_TYPE_COMPUTE, m_computeCommandAllocators[m_frameIndex].Get(), m_computeState.Get(), IID_PPV_ARGS(&m_computeCommandList)));
 	ThrowIfFailed(m_computeCommandList->Close());
 
+	// Note: ComPtr's are CPU objects but these resources need to stay in scope until
+	// the command list that references them has finished executing on the GPU.
+	// We will flush the GPU at the end of this method to ensure the resources are not
+	// prematurely destroyed.
 	ComPtr<ID3D12Resource> vertexBufferUpload;
 	ComPtr<ID3D12Resource> commandBufferUpload;
 
@@ -603,7 +607,8 @@ void D3D12ExecuteIndirect::OnRender()
 
 void D3D12ExecuteIndirect::OnDestroy()
 {
-	// Wait for the GPU to be done with all resources.
+	// Ensure that the GPU is no longer referencing resources that are about to be
+	// cleaned up by the destructor.
 	WaitForGpu();
 
 	CloseHandle(m_fenceEvent);