Reworked Wait and Submit logic to use D3D11 Query objects as fences

Some minor stuff that's cropped up from the D3D11 work so far. This PR updates the Driver_Template with the latest API, and also fixes a crash in the Vulkan driver -- if you acquired a swapchain texture from a window that had been destroyed, there was no null check before de-referencing the WindowData.

Co-authored-by: Caleb Cornett <caleb.cornett@outlook.com>
Reviewed-on: MoonsideGames/Refresh#46
Co-authored-by: TheSpydog <thespydog@noreply.example.org>
Co-committed-by: TheSpydog <thespydog@noreply.example.org>

CMakeLists.txt

@@ -41,6 +41,12 @@ add_definitions(
 	-DREFRESH_DRIVER_VULKAN
 )
 
+if (WIN32)
+	add_definitions(
+		-DREFRESH_DRIVER_D3D11
+	)
+endif()
+
 # Source lists
 add_library(Refresh
 	# Public Headers
@@ -49,8 +55,10 @@ add_library(Refresh
 	# Internal Headers
 	src/Refresh_Driver.h
 	src/Refresh_Driver_Vulkan_vkfuncs.h
+	Refresh_Driver_D3D11_cdefines.h
 	# Source Files
 	src/Refresh.c
+	src/Refresh_Driver_D3D11.c
 	src/Refresh_Driver_Vulkan.c
 	src/Refresh_Image.c
 )

include/Refresh.h

@@ -330,6 +330,7 @@ typedef enum Refresh_Backend
 {
 	REFRESH_BACKEND_DONTCARE,
 	REFRESH_BACKEND_VULKAN,
+	REFRESH_BACKEND_D3D11,
 	REFRESH_BACKEND_PS5,
 	REFRESH_BACKEND_INVALID
 } Refresh_Backend;

src/Refresh.c

@@ -39,6 +39,12 @@
 	#define VULKAN_DRIVER NULL
 #endif
 
+#ifdef REFRESH_DRIVER_D3D11
+	#define D3D11_DRIVER &D3D11Driver
+#else
+	#define D3D11_DRIVER NULL
+#endif
+
 #ifdef REFRESH_DRIVER_PS5
 	#define PS5_DRIVER &PS5Driver
 #else
@@ -48,6 +54,7 @@
 static const Refresh_Driver *backends[] = {
 	NULL,
 	VULKAN_DRIVER,
+	D3D11_DRIVER,
 	PS5_DRIVER
 };
 

src/Refresh_Driver.h

@@ -597,6 +597,7 @@ typedef struct Refresh_Driver
 } Refresh_Driver;
 
 extern Refresh_Driver VulkanDriver;
+extern Refresh_Driver D3D11Driver;
 extern Refresh_Driver PS5Driver;
 
 #endif /* REFRESH_DRIVER_H */

src/Refresh_Driver_D3D11_cdefines.h

@@ -0,0 +1,215 @@
+/* Refresh - XNA-inspired 3D Graphics Library with modern capabilities
+ *
+ * Copyright (c) 2020 Evan Hemsley
+ *
+ * This software is provided 'as-is', without any express or implied warranty.
+ * In no event will the authors be held liable for any damages arising from
+ * the use of this software.
+ *
+ * Permission is granted to anyone to use this software for any purpose,
+ * including commercial applications, and to alter it and redistribute it
+ * freely, subject to the following restrictions:
+ *
+ * 1. The origin of this software must not be misrepresented; you must not
+ * claim that you wrote the original software. If you use this software in a
+ * product, an acknowledgment in the product documentation would be
+ * appreciated but is not required.
+ *
+ * 2. Altered source versions must be plainly marked as such, and must not be
+ * misrepresented as being the original software.
+ *
+ * 3. This notice may not be removed or altered from any source distribution.
+ *
+ * Evan "cosmonaut" Hemsley <evan@moonside.games>
+ *
+ */
+
+/* Function Pointer Signatures */
+typedef HRESULT(WINAPI* PFN_CREATE_DXGI_FACTORY1)(const GUID* riid, void** ppFactory);
+
+ /* IIDs (from https://magnumdb.com) */
+
+static const IID D3D_IID_IDXGIFactory1 = { 0x770aae78,0xf26f,0x4dba,{0xa8,0x29,0x25,0x3c,0x83,0xd1,0xb3,0x87} };
+static const IID D3D_IID_IDXGIFactory6 = { 0xc1b6694f,0xff09,0x44a9,{0xb0,0x3c,0x77,0x90,0x0a,0x0a,0x1d,0x17} };
+static const IID D3D_IID_IDXGIAdapter1 = { 0x29038f61,0x3839,0x4626,{0x91,0xfd,0x08,0x68,0x79,0x01,0x1a,0x05} };
+static const IID D3D_IID_ID3D11Texture2D = { 0x6f15aaf2,0xd208,0x4e89,{0x9a,0xb4,0x48,0x95,0x35,0xd3,0x4f,0x9c} };
+
+/* IDXGIFactory6 (taken from dxgi1_6.h, cleaned up a bit) */
+typedef enum
+{
+	DXGI_FEATURE_PRESENT_ALLOW_TEARING = 0
+} DXGI_FEATURE;
+
+typedef enum
+{
+	DXGI_GPU_PREFERENCE_UNSPECIFIED = 0,
+	DXGI_GPU_PREFERENCE_MINIMUM_POWER = (DXGI_GPU_PREFERENCE_UNSPECIFIED + 1),
+	DXGI_GPU_PREFERENCE_HIGH_PERFORMANCE = (DXGI_GPU_PREFERENCE_MINIMUM_POWER + 1)
+} DXGI_GPU_PREFERENCE;
+
+typedef struct IDXGIFactory6 IDXGIFactory6;
+typedef struct IDXGIFactory6Vtbl
+{
+	HRESULT(STDMETHODCALLTYPE* QueryInterface)(
+		IDXGIFactory6* This,
+		REFIID riid,
+		void** ppvObject);
+
+	ULONG(STDMETHODCALLTYPE* AddRef)(
+		IDXGIFactory6* This);
+
+	ULONG(STDMETHODCALLTYPE* Release)(
+		IDXGIFactory6* This);
+
+	HRESULT(STDMETHODCALLTYPE* SetPrivateData)(
+		IDXGIFactory6* This,
+		REFGUID Name,
+		UINT DataSize,
+		const void* pData);
+
+	HRESULT(STDMETHODCALLTYPE* SetPrivateDataInterface)(
+		IDXGIFactory6* This,
+		REFGUID Name,
+		const IUnknown* pUnknown);
+
+	HRESULT(STDMETHODCALLTYPE* GetPrivateData)(
+		IDXGIFactory6* This,
+		REFGUID Name,
+		UINT* pDataSize,
+		void* pData);
+
+	HRESULT(STDMETHODCALLTYPE* GetParent)(
+		IDXGIFactory6* This,
+		REFIID riid,
+		void** ppParent);
+
+	HRESULT(STDMETHODCALLTYPE* EnumAdapters)(
+		IDXGIFactory6* This,
+		UINT Adapter,
+		IDXGIAdapter** ppAdapter);
+
+	HRESULT(STDMETHODCALLTYPE* MakeWindowAssociation)(
+		IDXGIFactory6* This,
+		HWND WindowHandle,
+		UINT Flags);
+
+	HRESULT(STDMETHODCALLTYPE* GetWindowAssociation)(
+		IDXGIFactory6* This,
+		HWND* pWindowHandle);
+
+	HRESULT(STDMETHODCALLTYPE* CreateSwapChain)(
+		IDXGIFactory6* This,
+		IUnknown* pDevice,
+		DXGI_SWAP_CHAIN_DESC* pDesc,
+		IDXGISwapChain** ppSwapChain);
+
+	HRESULT(STDMETHODCALLTYPE* CreateSoftwareAdapter)(
+		IDXGIFactory6* This,
+		HMODULE Module,
+		IDXGIAdapter** ppAdapter);
+
+	HRESULT(STDMETHODCALLTYPE* EnumAdapters1)(
+		IDXGIFactory6* This,
+		UINT Adapter,
+		IDXGIAdapter1** ppAdapter);
+
+	BOOL(STDMETHODCALLTYPE* IsCurrent)(
+		IDXGIFactory6* This);
+
+	BOOL(STDMETHODCALLTYPE* IsWindowedStereoEnabled)(
+		IDXGIFactory6* This);
+
+	HRESULT(STDMETHODCALLTYPE* CreateSwapChainForHwnd)(
+		IDXGIFactory6* This,
+		IUnknown* pDevice,
+		HWND hWnd,
+		void* pDesc,
+		void* pFullscreenDesc,
+		void* pRestrictToOutput,
+		void** ppSwapChain);
+
+	HRESULT(STDMETHODCALLTYPE* CreateSwapChainForCoreWindow)(
+		IDXGIFactory6* This,
+		IUnknown* pDevice,
+		IUnknown* pWindow,
+		void* pDesc,
+		void* pRestrictToOutput,
+		void** ppSwapChain);
+
+	HRESULT(STDMETHODCALLTYPE* GetSharedResourceAdapterLuid)(
+		IDXGIFactory6* This,
+		HANDLE hResource,
+		LUID* pLuid);
+
+	HRESULT(STDMETHODCALLTYPE* RegisterStereoStatusWindow)(
+		IDXGIFactory6* This,
+		HWND WindowHandle,
+		UINT wMsg,
+		DWORD* pdwCookie);
+
+	HRESULT(STDMETHODCALLTYPE* RegisterStereoStatusEvent)(
+		IDXGIFactory6* This,
+		HANDLE hEvent,
+		DWORD* pdwCookie);
+
+	void (STDMETHODCALLTYPE* UnregisterStereoStatus)(
+		IDXGIFactory6* This,
+		DWORD dwCookie);
+
+	HRESULT(STDMETHODCALLTYPE* RegisterOcclusionStatusWindow)(
+		IDXGIFactory6* This,
+		HWND WindowHandle,
+		UINT wMsg,
+		DWORD* pdwCookie);
+
+	HRESULT(STDMETHODCALLTYPE* RegisterOcclusionStatusEvent)(
+		IDXGIFactory6* This,
+		HANDLE hEvent,
+		DWORD* pdwCookie);
+
+	void (STDMETHODCALLTYPE* UnregisterOcclusionStatus)(
+		IDXGIFactory6* This,
+		DWORD dwCookie);
+
+	HRESULT(STDMETHODCALLTYPE* CreateSwapChainForComposition)(
+		IDXGIFactory6* This,
+		IUnknown* pDevice,
+		void* pDesc,
+		void* pRestrictToOutput,
+		void** ppSwapChain);
+
+	UINT(STDMETHODCALLTYPE* GetCreationFlags)(
+		IDXGIFactory6* This);
+
+	HRESULT(STDMETHODCALLTYPE* EnumAdapterByLuid)(
+		IDXGIFactory6* This,
+		LUID AdapterLuid,
+		REFIID riid,
+		void** ppvAdapter);
+
+	HRESULT(STDMETHODCALLTYPE* EnumWarpAdapter)(
+		IDXGIFactory6* This,
+		REFIID riid,
+		void** ppvAdapter);
+
+	HRESULT(STDMETHODCALLTYPE* CheckFeatureSupport)(
+		IDXGIFactory6* This,
+		DXGI_FEATURE Feature,
+		void* pFeatureSupportData,
+		UINT FeatureSupportDataSize);
+
+	HRESULT(STDMETHODCALLTYPE* EnumAdapterByGpuPreference)(
+		IDXGIFactory6* This,
+		UINT Adapter,
+		DXGI_GPU_PREFERENCE GpuPreference,
+		REFIID riid,
+		void** ppvAdapter);
+} IDXGIFactory6Vtbl;
+
+struct IDXGIFactory6
+{
+	struct IDXGIFactory6Vtbl* lpVtbl;
+};
+
+#define IDXGIFactory6_EnumAdapterByGpuPreference(This,Adapter,GpuPreference,riid,ppvAdapter)	\
+	( (This)->lpVtbl -> EnumAdapterByGpuPreference(This,Adapter,GpuPreference,riid,ppvAdapter) ) 

src/Refresh_Driver_Template.txt

@@ -268,6 +268,19 @@ static void TEMPLATE_DrawPrimitives(
 	NOT_IMPLEMENTED
 }
 
+static void TEMPLATE_DrawPrimitivesIndirect(
+	Refresh_Renderer *driverData,
+	Refresh_CommandBuffer *commandBuffer,
+	Refresh_Buffer *buffer,
+	uint32_t offsetInBytes,
+	uint32_t drawCount,
+	uint32_t stride,
+	uint32_t vertexParamOffset,
+	uint32_t fragmentParamOffset
+) {
+	NOT_IMPLEMENTED
+}
+
 static void TEMPLATE_DispatchCompute(
 	Refresh_Renderer *device,
 	Refresh_CommandBuffer *commandBuffer,
@@ -347,8 +360,13 @@ static void TEMPLATE_SetTextureDataYUV(
 	uint32_t yHeight,
 	uint32_t uvWidth,
 	uint32_t uvHeight,
-	void* data,
+	void *yDataPtr,
-	uint32_t dataLength
+	void *uDataPtr,
+	void *vDataPtr,
+	uint32_t yDataLength,
+	uint32_t uvDataLength,
+	uint32_t yStride,
+	uint32_t uvStride
 ) {
 	NOT_IMPLEMENTED
 }
@@ -485,10 +503,15 @@ static void TEMPLATE_QueueDestroyGraphicsPipeline(
 
 /* Graphics State */
 
+static Refresh_CommandBuffer* TEMPLATE_AcquireCommandBuffer(
+	Refresh_Renderer *driverData
+) {
+	NOT_IMPLEMENTED
+}
+
 static void TEMPLATE_BeginRenderPass(
 	Refresh_Renderer *driverData,
 	Refresh_CommandBuffer *commandBuffer,
-	Refresh_Rect *renderArea,
 	Refresh_ColorAttachmentInfo *colorAttachmentInfos,
 	uint32_t colorAttachmentCount,
 	Refresh_DepthStencilAttachmentInfo *depthStencilAttachmentInfo
@@ -548,6 +571,8 @@ static void TEMPLATE_BindIndexBuffer(
 	NOT_IMPLEMENTED
 }
 
+/* Compute State */
+
 static void TEMPLATE_BindComputePipeline(
 	Refresh_Renderer *driverData,
 	Refresh_CommandBuffer *commandBuffer,
@@ -572,14 +597,24 @@ static void TEMPLATE_BindComputeTextures(
 	NOT_IMPLEMENTED
 }
 
-static Refresh_CommandBuffer* TEMPLATE_AcquireCommandBuffer(
+/* Window and Swapchain Management */
+
+static uint8_t TEMPLATE_ClaimWindow(
 	Refresh_Renderer *driverData,
-	uint8_t fixed
+	void *windowHandle,
+	Refresh_PresentMode presentMode
 ) {
 	NOT_IMPLEMENTED
 }
 
-Refresh_Texture* TEMPLATE_AcquireSwapchainTexture(
+static void TEMPLATE_UnclaimWindow(
+	Refresh_Renderer *driverData,
+	void *windowHandle
+) {
+	NOT_IMPLEMENTED
+}
+
+static Refresh_Texture* TEMPLATE_AcquireSwapchainTexture(
 	Refresh_Renderer *driverData,
 	Refresh_CommandBuffer *commandBuffer,
 	void *windowHandle,
@@ -589,17 +624,33 @@ Refresh_Texture* TEMPLATE_AcquireSwapchainTexture(
 	NOT_IMPLEMENTED
 }
 
-Refresh_TextureFormat TEMPLATE_GetSwapchainFormat(
+static Refresh_TextureFormat TEMPLATE_GetSwapchainFormat(
 	Refresh_Renderer *driverData,
 	void *windowHandle
 ) {
 	NOT_IMPLEMENTED
 }
 
+static void TEMPLATE_SetSwapchainPresentMode(
+	Refresh_Renderer *driverData,
+	void *windowHandle,
+	Refresh_PresentMode presentMode
+) {
+	NOT_IMPLEMENTED
+}
+
+/* Submission and Fences */
+
 static void TEMPLATE_Submit(
 	Refresh_Renderer *driverData,
-	uint32_t commandBufferCount,
+	Refresh_CommandBuffer *commandBuffer
-	Refresh_CommandBuffer **pCommandBuffers
+) {
+	NOT_IMPLEMENTED
+}
+
+static Refresh_Fence* TEMPLATE_SubmitAndAcquireFence(
+	Refresh_Renderer *driverData,
+	Refresh_CommandBuffer *commandBuffer
 ) {
 	NOT_IMPLEMENTED
 }
@@ -610,8 +661,38 @@ static void TEMPLATE_Wait(
 	NOT_IMPLEMENTED
 }
 
+static void TEMPLATE_WaitForFences(
+	Refresh_Renderer *driverData,
+	uint8_t waitAll,
+	uint32_t fenceCount,
+	Refresh_Fence **pFences
+) {
+	NOT_IMPLEMENTED
+}
+
+static int TEMPLATE_QueryFence(
+	Refresh_Renderer *driverData,
+	Refresh_Fence *fence
+) {
+	NOT_IMPLEMENTED
+}
+
+static void TEMPLATE_ReleaseFence(
+	Refresh_Renderer *driverData,
+	Refresh_Fence *fence
+) {
+	NOT_IMPLEMENTED
+}
+
+/* Device Creation */
+
+static uint8_t TEMPLATE_PrepareDriver(
+	uint32_t *flags
+) {
+	NOT_IMPLEMENTED
+}
+
 static Refresh_Device* TEMPLATE_CreateDevice(
-	Refresh_PresentationParameters *presentationParameters,
 	uint8_t debugMode
 ) {
 	NOT_IMPLEMENTED
@@ -619,6 +700,7 @@ static Refresh_Device* TEMPLATE_CreateDevice(
 
 Refresh_Driver TEMPLATEDriver = {
 	"TEMPLATE",
+	TEMPLATE_PrepareDriver,
 	TEMPLATE_CreateDevice
 };
 

src/Refresh_Driver_Vulkan.c

@@ -9756,6 +9756,11 @@ static Refresh_Texture* VULKAN_AcquireSwapchainTexture(
 	VulkanPresentData *presentData;
 
 	windowData = VULKAN_INTERNAL_FetchWindowData(windowHandle);
+	if (windowData == NULL)
+	{
+		return NULL;
+	}
+
 	swapchainData = windowData->swapchainData;
 
 	/* Window is claimed but swapchain is invalid! */

visualc/Refresh.vcxproj

@@ -61,7 +61,7 @@
     <ClCompile>
       <WarningLevel>Level3</WarningLevel>
       <Optimization>Disabled</Optimization>
-      <PreprocessorDefinitions>REFRESH_DRIVER_VULKAN;%(PreprocessorDefinitions)</PreprocessorDefinitions>
+      <PreprocessorDefinitions>REFRESH_DRIVER_VULKAN;REFRESH_DRIVER_D3D11;%(PreprocessorDefinitions)</PreprocessorDefinitions>
     </ClCompile>
     <Link>
       <GenerateDebugInformation>DebugFull</GenerateDebugInformation>
@@ -72,7 +72,7 @@
     <ClCompile>
       <WarningLevel>Level3</WarningLevel>
       <Optimization>MaxSpeed</Optimization>
-      <PreprocessorDefinitions>REFRESH_DRIVER_VULKAN;%(PreprocessorDefinitions)</PreprocessorDefinitions>
+      <PreprocessorDefinitions>REFRESH_DRIVER_VULKAN;REFRESH_DRIVER_D3D11;%(PreprocessorDefinitions)</PreprocessorDefinitions>
       <FunctionLevelLinking>true</FunctionLevelLinking>
       <IntrinsicFunctions>true</IntrinsicFunctions>
     </ClCompile>
@@ -84,6 +84,7 @@
   </ItemDefinitionGroup>
   <ItemGroup>
     <ClCompile Include="..\src\Refresh.c" />
+    <ClCompile Include="..\src\Refresh_Driver_D3D11.c" />
     <ClCompile Include="..\src\Refresh_Driver_Vulkan.c" />
     <ClCompile Include="..\src\Refresh_Image.c" />
   </ItemGroup>
@@ -91,6 +92,7 @@
     <ClInclude Include="..\include\Refresh.h" />
     <ClInclude Include="..\include\Refresh_Image.h" />
     <ClInclude Include="..\src\Refresh_Driver.h" />
+    <ClInclude Include="..\src\Refresh_Driver_D3D11_cdefines.h" />
     <ClInclude Include="..\src\Refresh_Driver_Vulkan_vkfuncs.h" />
   </ItemGroup>
   <Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />

visualc/Refresh.vcxproj.filters

@@ -10,6 +10,9 @@
     <ClCompile Include="..\src\Refresh_Image.c">
       <Filter>Source Files</Filter>
     </ClCompile>
+    <ClCompile Include="..\src\Refresh_Driver_D3D11.c">
+      <Filter>Source Files</Filter>
+    </ClCompile>
   </ItemGroup>
   <ItemGroup>
     <ClInclude Include="..\include\Refresh.h">
@@ -24,6 +27,9 @@
     <ClInclude Include="..\include\Refresh_Image.h">
       <Filter>Header Files</Filter>
     </ClInclude>
+    <ClInclude Include="..\src\Refresh_Driver_D3D11_cdefines.h">
+      <Filter>Header Files</Filter>
+    </ClInclude>
   </ItemGroup>
   <ItemGroup>
     <Filter Include="Header Files">