mirrors/SDL
1
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2026-02-13 15:23:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

Change how WinPixEventRuntime.dll is used under D3D12/Windows. (#14600)

Browse Source 
* GPU: D3D12: Missing WinPixEventRuntime.dll now logs warning at device creation time.
* GPU: D3D12: Debug label functions are now a no-op when WinPixEventRuntime.dll is missing.
* Docs: GPU: Debug function documentation now notes WinPixEventRuntime.dll is required under D3D12.
This commit is contained in:
Jakub Wasilewski
2025-12-05 18:40:57 +01:00
committed by GitHub
parent a3992f504c
commit f5ea8805e1
2 changed files with 24 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
include/SDL3/SDL_gpu.h
View File

@@ -2945,9 +2945,9 @@ extern SDL_DECLSPEC void SDLCALL SDL_SetGPUTextureName(
*
* Useful for debugging.
*
* On Direct3D 12, using SDL_InsertGPUDebugLabel will cause validation errors
* unless you have WinPixEventRuntime.dll in your PATH. See
* [here](https://devblogs.microsoft.com/pix/winpixeventruntime/)
* On Direct3D 12, using SDL_InsertGPUDebugLabel requires WinPixEventRuntime.dll
* to be in your PATH or in the same directory as your executable.
* See [here](https://devblogs.microsoft.com/pix/winpixeventruntime/)
* for instructions on how to obtain it.
*
* \param command_buffer a command buffer.
@@ -2968,9 +2968,9 @@ extern SDL_DECLSPEC void SDLCALL SDL_InsertGPUDebugLabel(
* Each call to SDL_PushGPUDebugGroup must have a corresponding call to
* SDL_PopGPUDebugGroup.
*
* On Direct3D 12, using SDL_PushGPUDebugGroup will cause validation errors
* unless you have WinPixEventRuntime.dll in your PATH. See
* [here](https://devblogs.microsoft.com/pix/winpixeventruntime/)
* On Direct3D 12, using SDL_PushGPUDebugGroup requires WinPixEventRuntime.dll
* to be in your PATH or in the same directory as your executable.
* See [here](https://devblogs.microsoft.com/pix/winpixeventruntime/)
* for instructions on how to obtain it.
*
* On some backends (e.g. Metal), pushing a debug group during a
@@ -2992,9 +2992,9 @@ extern SDL_DECLSPEC void SDLCALL SDL_PushGPUDebugGroup(
/**
* Ends the most-recently pushed debug group.
*
* On Direct3D 12, using SDL_PopGPUDebugGroup will cause validation errors
* unless you have WinPixEventRuntime.dll in your PATH. See
* [here](https://devblogs.microsoft.com/pix/winpixeventruntime/)
* On Direct3D 12, using SDL_PopGPUDebugGroup requires WinPixEventRuntime.dll
* to be in your PATH or in the same directory as your executable.
* See [here](https://devblogs.microsoft.com/pix/winpixeventruntime/)
* for instructions on how to obtain it.
*
* \param command_buffer a command buffer.

44
src/gpu/d3d12/SDL_gpu_d3d12.c
View File

@@ -2133,9 +2133,8 @@ static void D3D12_SetTextureName(
}
}
/* These debug functions now use the PIX runtime where available to avoid validation
* layer errors. They still fall back to calling internal functions if WinPixEventRuntime.dll
* is not present, but with a warning explaining the problem.
/* These debug functions now require the PIX runtime under Windows to avoid validation
* layer errors. Calling them without the PIX runtime in your path is a no-op.
*/
static void D3D12_InsertDebugLabel(
@@ -2144,18 +2143,12 @@ static void D3D12_InsertDebugLabel(
{
D3D12CommandBuffer *d3d12CommandBuffer = (D3D12CommandBuffer *)commandBuffer;
#ifdef USE_PIX_RUNTIME
// Prefer using PIX runtime, but fallthrough with a warning if not available.
// Requires PIX runtime under Windows, no-op if DLL unavailable.
WinPixEventRuntimeFns *fns = &d3d12CommandBuffer->renderer->winpixeventruntimeFns;
if (fns->pSetMarkerOnCommandList) {
fns->pSetMarkerOnCommandList(d3d12CommandBuffer->graphicsCommandList, 0 /*default color*/, text);
return;
} else {
SDL_LogWarn(SDL_LOG_CATEGORY_GPU,
"WinPixEventRuntime.dll needs to be in your PATH for debug functions like SDL_Push/PopGPUDebugGroup() and SDL_InsertGPUDebugLabel() to function correctly. "
"Otherwise, these functions will cause D3D12 validation errors. "
"See https://devblogs.microsoft.com/pix/winpixeventruntime/ for information on obtaining the DLL.");
}
#endif
#else
WCHAR *wchar_text = WIN_UTF8ToStringW(text);
ID3D12GraphicsCommandList_SetMarker(
@@ -2165,6 +2158,7 @@ static void D3D12_InsertDebugLabel(
(UINT)SDL_wcslen(wchar_text) * sizeof(WCHAR));
SDL_free(wchar_text);
#endif
}
static void D3D12_PushDebugGroup(
@@ -2173,18 +2167,12 @@ static void D3D12_PushDebugGroup(
{
D3D12CommandBuffer *d3d12CommandBuffer = (D3D12CommandBuffer *)commandBuffer;
#ifdef USE_PIX_RUNTIME
// Prefer using PIX runtime, but fallthrough with a warning if not available.
// Requires PIX runtime under Windows, no-op if DLL unavailable.
WinPixEventRuntimeFns *fns = &d3d12CommandBuffer->renderer->winpixeventruntimeFns;
if (fns->pBeginEventOnCommandList) {
fns->pBeginEventOnCommandList(d3d12CommandBuffer->graphicsCommandList, 0 /*default color*/, name);
return;
} else {
SDL_LogWarn(SDL_LOG_CATEGORY_GPU,
"WinPixEventRuntime.dll needs to be in your PATH for debug functions like SDL_Push/PopGPUDebugGroup() and SDL_InsertGPUDebugLabel() to function correctly. "
"Otherwise, these functions will cause D3D12 validation errors. "
"See https://devblogs.microsoft.com/pix/winpixeventruntime/ for information on obtaining the DLL.");
}
#endif
#else
WCHAR *wchar_text = WIN_UTF8ToStringW(name);
ID3D12GraphicsCommandList_BeginEvent(
@@ -2194,6 +2182,7 @@ static void D3D12_PushDebugGroup(
(UINT)SDL_wcslen(wchar_text) * sizeof(WCHAR));
SDL_free(wchar_text);
#endif
}
static void D3D12_PopDebugGroup(
@@ -2201,19 +2190,14 @@ static void D3D12_PopDebugGroup(
{
D3D12CommandBuffer *d3d12CommandBuffer = (D3D12CommandBuffer *)commandBuffer;
#ifdef USE_PIX_RUNTIME
// Prefer using PIX runtime, but fallthrough with a warning if not available.
// Requires PIX runtime under Windows, no-op if DLL unavailable.
WinPixEventRuntimeFns *fns = &d3d12CommandBuffer->renderer->winpixeventruntimeFns;
if (fns->pEndEventOnCommandList) {
fns->pEndEventOnCommandList(d3d12CommandBuffer->graphicsCommandList);
return;
} else {
SDL_LogWarn(SDL_LOG_CATEGORY_GPU,
"WinPixEventRuntime.dll needs to be in your PATH for debug functions like SDL_Push/PopGPUDebugGroup() and SDL_InsertGPUDebugLabel() to function correctly. "
"Otherwise, these functions will cause D3D12 validation errors. "
"See https://devblogs.microsoft.com/pix/winpixeventruntime/ for information on obtaining the DLL.");
}
#endif
#else
ID3D12GraphicsCommandList_EndEvent(d3d12CommandBuffer->graphicsCommandList);
#endif
}
// State Creation
@@ -8881,8 +8865,10 @@ static SDL_GPUDevice *D3D12_CreateDevice(bool debugMode, bool preferLowPower, SD
renderer->winpixeventruntime_dll,
PIX_SET_MARKER_ON_COMMAND_LIST_FUNC);
} else {
// Not having the PIX runtime is not a critical error itself, but will cause warnings
// when using SDL_Push/PopGPUDebugGroup and SDL_InsertGPUDebugLabel.
SDL_LogWarn(SDL_LOG_CATEGORY_GPU,
"WinPixEventRuntime.dll is not available. "
"It is required for SDL_Push/PopGPUDebugGroup and SDL_InsertGPUDebugLabel to function correctly. "
"See here for instructions on how to obtain it: https://devblogs.microsoft.com/pix/winpixeventruntime/");
fns->pBeginEventOnCommandList = NULL;
fns->pEndEventOnCommandList = NULL;
fns->pSetMarkerOnCommandList = NULL;