[ionGraphics] [ionGraphicsD3D11] Add support for graphics event annot…

…ation, used by graphics debugger
iondune · Jun 15, 2020 · c749808 · c749808
1 parent 1f5ecac
commit c749808
Show file tree

Hide file tree

Showing 6 changed files with 60 additions and 5 deletions.
diff --git a/Libraries/ionGraphics/IGraphicsImplementation.h b/Libraries/ionGraphics/IGraphicsImplementation.h
@@ -51,6 +51,8 @@ namespace ion
 
 		virtual void DiagnosticCaptureBegin() = 0;
 		virtual void DiagnosticCaptureEnd() = 0;
+		virtual void AnnotateBeginEvent(string const & eventName) = 0;
+		virtual void AnnotateEndEvent(string const & eventName) = 0;
 
 	};
 

diff --git a/Libraries/ionGraphicsD3D11/CD3D11Implementation.cpp b/Libraries/ionGraphicsD3D11/CD3D11Implementation.cpp
@@ -21,6 +21,7 @@
 #include <ionWindow/CWindow.h>
 
 #include <d3d11.h>
+#include <d3d11_1.h>
 #include <dxgi.h>
 #include <d3dcompiler.h>
 
@@ -89,6 +90,8 @@ namespace ion
 			CheckedDXCall( Device->CreateRasterizerState(& RasterizerDesc, & RasterizerState) );
 			ImmediateContext->RSSetState(RasterizerState);
 
+			CheckedDXCall( ImmediateContext->QueryInterface(IID_PPV_ARGS(& UserDefinedAnnotation)) );
+
 			// Depth Settings
 
 			D3D11_DEPTH_STENCIL_DESC DepthDesc;
@@ -240,5 +243,31 @@ namespace ion
 			}
 		}
 
+		void CD3D11Implementation::AnnotateBeginEvent(string const & eventName)
+		{
+			if (UserDefinedAnnotation)
+			{
+				std::wstring temp = std::wstring(eventName.begin(), eventName.end());
+				UserDefinedAnnotation->BeginEvent(temp.c_str());
+				EventStack.push_back(eventName);
+			}
+		}
+
+		void CD3D11Implementation::AnnotateEndEvent(string const & eventName)
+		{
+			if (UserDefinedAnnotation)
+			{
+				UserDefinedAnnotation->EndEvent();
+
+				string const stackTop = EventStack.back();
+				EventStack.pop_back();
+
+				if (stackTop != eventName)
+				{
+					Log::Warn("CD3D11Implementation: Popped '%s' from the event stack, but ended '%s' event.");
+				}
+			}
+		}
+
 	}
 }
diff --git a/Libraries/ionGraphicsD3D11/CD3D11Implementation.h b/Libraries/ionGraphicsD3D11/CD3D11Implementation.h
@@ -11,6 +11,7 @@ struct ID3D11Device;
 struct ID3D11DeviceContext;
 struct ID3D11Debug;
 struct IDXGraphicsAnalysis;
+struct ID3DUserDefinedAnnotation;
 
 namespace ion
 {
@@ -60,6 +61,8 @@ namespace ion
 			void UseReverseDepth(bool const reverseDepth = true) {}
 			void DiagnosticCaptureBegin();
 			void DiagnosticCaptureEnd();
+			void AnnotateBeginEvent(string const & eventName);
+			void AnnotateEndEvent(string const & eventName);
 
 		protected:
 
@@ -70,7 +73,9 @@ namespace ion
 			ID3D11DeviceContext * ImmediateContext = nullptr;
 			ID3D11Debug * DebugDevice = nullptr;
 
-			IDXGraphicsAnalysis * GraphicsAnalysis;
+			IDXGraphicsAnalysis * GraphicsAnalysis = nullptr;
+			ID3DUserDefinedAnnotation * UserDefinedAnnotation = nullptr;
+			vector<string> EventStack;
 
 			D3D11::CDrawContext * DrawContext = nullptr;
 

diff --git a/Libraries/ionScene/CRenderPass.cpp b/Libraries/ionScene/CRenderPass.cpp
@@ -25,6 +25,11 @@ namespace ion
 			this->RenderTarget = RenderTarget;
 		}
 
+		void CRenderPass::SetName(string const & name)
+		{
+			Name = name;
+		}
+
 		string const & CRenderPass::GetName() const
 		{
 			return Name;

diff --git a/Libraries/ionScene/CRenderPass.h b/Libraries/ionScene/CRenderPass.h
@@ -24,6 +24,7 @@ namespace ion
 			virtual void SetGraphicsContext(SharedPointer<Graphics::IGraphicsContext> GraphicsContext);
 			virtual void SetRenderTarget(SharedPointer<Graphics::IRenderTarget> RenderTarget);
 
+			virtual void SetName(string const & name);
 			virtual string const & GetName() const;
 			virtual CGraphicsAPI * GetGraphicsAPI();
 			virtual SharedPointer<Graphics::IGraphicsContext> GetGraphicsContext();

diff --git a/Libraries/ionScene/CSceneManager.cpp b/Libraries/ionScene/CSceneManager.cpp
@@ -10,11 +10,24 @@ namespace ion
 
 	void CSceneManager::DrawAll()
 	{
-		std::for_each(RenderPasses.begin(), RenderPasses.end(), [](Scene::CRenderPass * RenderPass)
+		SingletonPointer<CGraphicsAPI> GraphicsAPI;
+
+		int i = 0;
+		for (Scene::CRenderPass * pass : RenderPasses)
 		{
-			RenderPass->Load();
-			RenderPass->Draw();
-		});
+			string passName = pass->GetName();
+			if (passName == "")
+			{
+				passName = String::Build("RenderPass%d", i);
+			}
+
+			GraphicsAPI->GetImplementation()->AnnotateBeginEvent(passName);
+			pass->Load();
+			pass->Draw();
+			GraphicsAPI->GetImplementation()->AnnotateEndEvent(passName);
+
+			i ++;
+		}
 	}
 
 	void CSceneManager::AddRenderPass(Scene::CRenderPass * RenderPass)