The prize set. display_ps is the per-frame hot shader - every
frame goes through this on its way to the host display, so cold-
flip cost matters here more than anywhere else in the GPU
pipeline. This commit pre-bakes 54 variants covering the full
runtime configuration matrix and replaces the shadergen +
m_shader_cache.GetPixelShader path in GetDisplayPipeline with
indexed-lookup into two static arrays of D3D12_SHADER_BYTECODE.
Variant axes (4 axes, 54 unique blobs):
* DEPTH_24BIT (2 values): 16-bit framebuffer (the common case;
every game's standard scanout) vs 24-bit (FMV cutscenes,
games that opt into true-colour framebuffers).
* interlace_mode (3 values): InterlacedRenderMode enum from
gpu_hw.h. Mapped to a (INTERLACED, INTERLEAVED) bool pair
in the variant /D defines:
i=0 (None): (INTERLACED=0, INTERLEAVED=0)
i=1 (InterleavedFields): (INTERLACED=1, INTERLEAVED=1)
i=2 (SeparateFields): (INTERLACED=1, INTERLEAVED=0)
* SMOOTH_CHROMA (2 values): chroma-plane smoothing in the
24-bit path. Heavy when active - SampleVRAM24Smoothed runs
9 SampleVRAM24 calls per output pixel (1 centre + 4 x 2x2
averages), each of which is 2 LoadVRAM calls. Dead code
when DEPTH_24BIT=0; the variant table omits the c=1 entry
for d=0 (54 = 18 + 36, not 72 = 2 x 3 x 2 x 6).
* MULTISAMPLES (6 values: 1, 2, 4, 8, 16, 32): MSAA sample
count. Same cardinality axis as vram_read_ps (
|
||
|---|---|---|
| .. | ||
| copy.ps.hlsl | ||
| display.ps.hlsl | ||
| fullscreen_quad.vs.hlsl | ||
| README.md | ||
| vram_copy.ps.hlsl | ||
| vram_fill.ps.hlsl | ||
| vram_read.ps.hlsl | ||
| vram_update_depth.ps.hlsl | ||
| vram_write.ps.hlsl | ||
D3D12 shader sources (pre-baked DXBC)
This directory holds the HLSL sources for shaders used by the D3D12 backend
that have been moved off the runtime ShaderGen path. Each .hlsl file here
has a matching pre-compiled DXBC blob checked in to
src/common/d3d12/embedded_dxbc/.
Why this exists
Historically the D3D12 backend generated HLSL at runtime via
src/core/shadergen.cpp and src/core/gpu_hw_shadergen.cpp, then handed the
text to D3DCompile (the in-process HLSL -> DXBC compiler from d3dcompiler_47.dll)
to produce a DXBC blob for each PSO. On a cold shader cache, walking the
1164-cell batch pipeline matrix in precompile_sync mode takes on the order
of one minute, which is the worst entry in the post-dim-cache cost matrix
(see the cost-matrix comments in 10c53b8, 57ac62e, and the patches that
followed). The runtime cache hides this on warm boots, but cold boots and
shader cache invalidations re-pay the full per-cell D3DCompile cost every
time the user changes a setting that hits the full-flush branch.
Pre-baking the DXBC removes:
- per-launch HLSL compilation stall on shader cache misses,
- a class of "stale cache after
d3dcompiler_47.dllversion drift" failures, - the implicit dependency on
D3DCompilebeing available at runtime for the cells that have been pre-baked.
The OpenGL / OpenGL ES / D3D11 / Vulkan backends still use the runtime
ShaderGen path; only the D3D12 backend reads from the embedded DXBC. (The
Vulkan equivalent of this infrastructure lives at data/shaders/vulkan/ /
src/common/vulkan/embedded_spirv/ / tools/regen_vulkan_spirv.py; this
directory is the mirror.)
Build-time constraint
The core build (Makefile.libretro and src/common/CMakeLists.txt) must
never invoke fxc.exe or any other external shader compiler. The .inc
files under src/common/d3d12/embedded_dxbc/ are checked into the
repository and compiled like any other C++ source. The
tools/regen_d3d12_dxbc.py helper exists for contributors who edit the
.hlsl sources in this directory; it is not part of the build.
Regenerating the DXBC blobs
After editing a .hlsl file here, run:
python3 tools/regen_d3d12_dxbc.py
This invokes fxc.exe (Shader Model 5.0, /O3, /E main) on each .hlsl
file and rewrites the matching .inc under src/common/d3d12/embedded_dxbc/.
Both the .hlsl and the regenerated .inc must be committed together so the
two stay in sync.
Microsoft fxc.exe is required
The regen script will refuse to write .inc files produced by any compiler
other than Microsoft's fxc.exe. The check parses the DXBC RDEF chunk and
matches the creator string against a Microsoft-prefix allowlist.
The reason is empirical: Wine ships its own d3dcompiler_47.dll
implementation (vkd3d-shader), and that compiler's output, while a valid
DXBC container, doesn't pass the Microsoft D3D12 runtime's
CreateGraphicsPipelineState validation for non-trivial shaders. The
failure mode is E_FAIL (0x80004005) at PSO-creation time with no
useful diagnostic from Log_ErrorPrintf. Commit cd971cd shipped a
vkd3d-shader-compiled vram_copy_ps.inc and broke the entire D3D12
backend on launch; da20f5b reverts it. The script's creator-string
validator exists to prevent that mistake from recurring.
Installing Microsoft fxc.exe
Windows: Install the Windows 10 or 11 SDK from Microsoft. fxc.exe
ends up at
C:\Program Files (x86)\Windows Kits\10\bin\<version>\x64\fxc.exe (or
the same path under \Program Files\ if the 64-bit SDK is installed).
The regen script auto-detects it there.
Linux: Microsoft's fxc.exe is a Windows x86 PE binary and runs
fine under Wine - the trick is just to get the SDK installed inside a
Wine prefix. Two options:
- Run the Windows SDK installer (
winsdksetup.exefrom Microsoft) underwineand select the Windows SDK Signing Tools / SDK component that shipsfxc.exe. The default install puts it at<prefix>/drive_c/Program Files (x86)/Windows Kits/10/bin/<version>/x64/fxc.exe, which the regen script picks up automatically. - Or extract
fxc.exe+d3dcompiler_47.dlldirectly from the SDK MSI usingmsiextractfrommsitools, drop both in any directory, and pass--fxc PATH/TO/fxc.exeto the regen script. Both files must live in the same directory so Wine's loader finds Microsoft'sd3dcompiler_47.dllbefore falling back to its bundled vkd3d-shader version.
The script searches for fxc.exe in: $WINEPREFIX (if set), ~/.wine,
and any subdirectory under ~/.local/share/wineprefixes/ that has a
drive_c tree. Set WINEPREFIX to your prefix path if it lives
elsewhere.
The --wine PATH flag lets you point at a specific wine binary if
wine isn't on $PATH.
Filename convention
Stage is encoded in the suffix:
.vs.hlsl-> vertex shader (compiled asvs_5_0).ps.hlsl-> pixel shader (compiled asps_5_0).cs.hlsl-> compute shader (compiled ascs_5_0).gs.hlsl-> geometry shader (compiled asgs_5_0)
The _5_0 shader model targets D3D_FEATURE_LEVEL_11_0, matching the
runtime baseline of the D3D12 backend (see the shared compile path in
src/common/d3d11/shader_compiler.cpp which both D3D11 and D3D12 used
prior to the pre-bake migration).
Template variants
Shaders that need multiple pre-baked variants (e.g. one per BatchRenderMode
or per GPUTextureFilter) are listed in the TEMPLATE_VARIANTS dict at the
top of tools/regen_d3d12_dxbc.py. Each entry maps an .hlsl filename to
the list of (variant_suffix, [/D defines]) tuples that the regen script
should produce.
If you add a template variant to the dict, add the matching extern
declaration to src/common/d3d12/embedded_shaders.h AND the matching slot
lookup to src/common/d3d12/embedded_shaders.cpp - the index ordering at
the runtime call site must match the order in the dict so the correct
blob gets bound at PSO-creation time.