lee/renderdoc
1
0
Fork 0
mirror of https://github.com/baldurk/renderdoc.git synced 2026-05-29 21:30:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

Remove primitive ID usage from pixel shader debugging when invalid

Browse Source 
SV_PrimitiveID is only valid as a pixel shader input if there's either
no geometry shader, or the geometry shader emits SV_PrimitiveID. With
D3D11, the debug layer will complain but rendering will proceed. With
D3D12, the PSO fails to compile. For both APIs, pixel shader debugging
now checks whether this is true, and disables its usage if it isn't.
Added tests for various valid scenarios with SV_PrimitiveID.
This commit is contained in:
Steve Karolewics
2020-02-19 19:41:10 -08:00
committed by Baldur Karlsson
parent 6f1818e91c
commit dfbe7fb6bf
8 changed files with 607 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
util/test/demos/d3d11/d3d11_primitiveid.cpp
+191
View File
@@ -0,0 +1,191 @@
/******************************************************************************
* The MIT License (MIT)
*
* Copyright (c) 2020 Baldur Karlsson
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
******************************************************************************/
#include "d3d11_test.h"
RD_TEST(D3D11_PrimitiveID, D3D11GraphicsTest)
{
static constexpr const char *Description =
"Exercises pixel shader debugging with various primitive ID scenarios.";
std::string common = R"EOSHADER(
struct v2f
{
float4 pos : SV_POSITION;
float4 col : COLOR0;
float2 uv : TEXCOORD0;
};
struct prim2f
{
v2f data;
uint prim : SV_PrimitiveID;
};
)EOSHADER";
std::string geomNoPrim = R"EOSHADER(
[maxvertexcount(6)]
void main(triangle v2f input[3], inout TriangleStream<v2f> TriStream)
{
// Output the original triangle
int i;
for(i = 0; i < 3; i++)
{
v2f output = input[i];
TriStream.Append(output);
}
TriStream.RestartStrip();
// Output the original triangle, shifted to the right
for(i = 0; i < 3; i++)
{
v2f output = input[i];
output.pos.x += 0.5f;
TriStream.Append(output);
}
TriStream.RestartStrip();
}
)EOSHADER";
std::string geomPrim = R"EOSHADER(
[maxvertexcount(6)]
void main(triangle v2f input[3], inout TriangleStream<prim2f> TriStream)
{
// Output the original triangle
int i;
for(i = 0; i < 3; i++)
{
prim2f output;
output.prim = 2;
output.data = input[i];
TriStream.Append(output);
}
TriStream.RestartStrip();
// Output the original triangle, shifted to the right
for(i = 0; i < 3; i++)
{
prim2f output;
output.prim = 3;
output.data = input[i];
output.data.pos.x += 0.5f;
TriStream.Append(output);
}
TriStream.RestartStrip();
}
)EOSHADER";
std::string pixelNoPrim = R"EOSHADER(
float4 main(in v2f IN) : SV_Target0
{
return float4(0.0f, 1.0f, 0.0f, 1.0f);
}
)EOSHADER";
std::string pixelPrim = R"EOSHADER(
float4 main(in prim2f IN) : SV_Target0
{
return float4(IN.prim / 4.0f, 1.0f, 0.0f, 1.0f);
}
)EOSHADER";
int main()
{
// initialise, create window, create device, etc
if(!Init())
return 3;
ID3DBlobPtr vsBlob = Compile(D3DDefaultVertex, "main", "vs_4_0");
ID3DBlobPtr gsNoPrimBlob = Compile(common + geomNoPrim, "main", "gs_5_0");
ID3DBlobPtr gsPrimBlob = Compile(common + geomPrim, "main", "gs_5_0");
ID3DBlobPtr psNoPrimBlob = Compile(common + pixelNoPrim, "main", "ps_5_0");
ID3DBlobPtr psPrimBlob = Compile(common + pixelPrim, "main", "ps_5_0");
CreateDefaultInputLayout(vsBlob);
ID3D11BufferPtr vb = MakeBuffer().Vertex().Data(DefaultTri);
ID3D11VertexShaderPtr vs = CreateVS(vsBlob);
ID3D11GeometryShaderPtr gsNoPrim = CreateGS(gsNoPrimBlob);
ID3D11GeometryShaderPtr gsPrim = CreateGS(gsPrimBlob);
ID3D11PixelShaderPtr psNoPrim = CreatePS(psNoPrimBlob);
ID3D11PixelShaderPtr psPrim = CreatePS(psPrimBlob);
float halfWidth = (float)screenWidth * 0.5f;
float halfHeight = (float)screenHeight * 0.5f;
D3D11_VIEWPORT views[4] = {{0.0f, 0.0f, halfWidth, halfHeight, 0.0f, 1.0f},
{halfWidth, 0.0f, halfWidth, halfHeight, 0.0f, 1.0f},
{0.0f, halfHeight, halfWidth, halfHeight, 0.0f, 1.0f},
{halfWidth, halfHeight, halfWidth, halfHeight, 0.0f, 1.0f}};
while(Running())
{
ctx->OMSetRenderTargets(1, &bbRTV.GetInterfacePtr(), NULL);
ClearRenderTargetView(bbRTV, {0.2f, 0.2f, 0.2f, 1.0f});
IASetVertexBuffer(vb, sizeof(DefaultA2V), 0);
ctx->IASetPrimitiveTopology(D3D11_PRIMITIVE_TOPOLOGY_TRIANGLELIST);
ctx->IASetInputLayout(defaultLayout);
annot->SetMarker(L"Test");
// Draw with no GS, PS without prim
RSSetViewport(views[0]);
ctx->VSSetShader(vs, NULL, 0);
ctx->GSSetShader(NULL, NULL, 0);
ctx->PSSetShader(psNoPrim, NULL, 0);
ctx->Draw(3, 0);
// Draw with no GS, PS with prim
RSSetViewport(views[1]);
ctx->PSSetShader(psPrim, NULL, 0);
ctx->Draw(3, 0);
// Draw with GS, PS both without prim
RSSetViewport(views[2]);
ctx->GSSetShader(gsNoPrim, NULL, 0);
ctx->PSSetShader(psNoPrim, NULL, 0);
ctx->Draw(3, 0);
// Draw with GS, PS both with prim
RSSetViewport(views[3]);
ctx->GSSetShader(gsPrim, NULL, 0);
ctx->PSSetShader(psPrim, NULL, 0);
ctx->Draw(3, 0);
Present();
}
return 0;
}
};
REGISTER_TEST();
util/test/demos/d3d12/d3d12_primitiveid.cpp
+188
View File
@@ -0,0 +1,188 @@
/******************************************************************************
* The MIT License (MIT)
*
* Copyright (c) 2020 Baldur Karlsson
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
******************************************************************************/
#include "d3d12_test.h"
RD_TEST(D3D12_PrimitiveID, D3D12GraphicsTest)
{
static constexpr const char *Description =
"Exercises pixel shader debugging with various primitive ID scenarios.";
std::string common = R"EOSHADER(
struct v2f
{
float4 pos : SV_POSITION;
float4 col : COLOR0;
float2 uv : TEXCOORD0;
};
struct prim2f
{
v2f data;
uint prim : SV_PrimitiveID;
};
)EOSHADER";
std::string geomNoPrim = R"EOSHADER(
[maxvertexcount(6)]
void main(triangle v2f input[3], inout TriangleStream<v2f> TriStream)
{
// Output the original triangle
int i;
for(i = 0; i < 3; i++)
{
v2f output = input[i];
TriStream.Append(output);
}
TriStream.RestartStrip();
// Output the original triangle, shifted to the right
for(i = 0; i < 3; i++)
{
v2f output = input[i];
output.pos.x += 0.5f;
TriStream.Append(output);
}
TriStream.RestartStrip();
}
)EOSHADER";
std::string geomPrim = R"EOSHADER(
[maxvertexcount(6)]
void main(triangle v2f input[3], inout TriangleStream<prim2f> TriStream)
{
// Output the original triangle
int i;
for(i = 0; i < 3; i++)
{
prim2f output;
output.prim = 2;
output.data = input[i];
TriStream.Append(output);
}
TriStream.RestartStrip();
// Output the original triangle, shifted to the right
for(i = 0; i < 3; i++)
{
prim2f output;
output.prim = 3;
output.data = input[i];
output.data.pos.x += 0.5f;
TriStream.Append(output);
}
TriStream.RestartStrip();
}
)EOSHADER";
std::string pixelNoPrim = R"EOSHADER(
float4 main(in v2f IN) : SV_Target0
{
float3 color = IN.col.bgr;
color.r *= 0.5f;
return float4(color.bgr, 1.0f);
}
)EOSHADER";
std::string pixelPrim = R"EOSHADER(
float4 main(in prim2f IN) : SV_Target0
{
float r = IN.prim;
return float4(r / 4.0f, 1.0f, 0.0f, 1.0f);
}
)EOSHADER";
int main()
{
// initialise, create window, create device, etc
if(!Init())
return 3;
ID3DBlobPtr vsBlob = Compile(D3DDefaultVertex, "main", "vs_4_0");
ID3DBlobPtr gsNoPrimBlob = Compile(common + geomNoPrim, "main", "gs_5_0");
ID3DBlobPtr gsPrimBlob = Compile(common + geomPrim, "main", "gs_5_0");
ID3DBlobPtr psNoPrimBlob = Compile(common + pixelNoPrim, "main", "ps_5_0");
ID3DBlobPtr psPrimBlob = Compile(common + pixelPrim, "main", "ps_5_0");
ID3D12ResourcePtr vb = MakeBuffer().Data(DefaultTri);
ID3D12RootSignaturePtr sig = MakeSig({});
ID3D12PipelineStatePtr pso[4] = {
MakePSO().RootSig(sig).InputLayout().VS(vsBlob).PS(psNoPrimBlob),
MakePSO().RootSig(sig).InputLayout().VS(vsBlob).PS(psPrimBlob),
MakePSO().RootSig(sig).InputLayout().VS(vsBlob).GS(gsNoPrimBlob).PS(psNoPrimBlob),
MakePSO().RootSig(sig).InputLayout().VS(vsBlob).GS(gsPrimBlob).PS(psPrimBlob)};
ResourceBarrier(vb, D3D12_RESOURCE_STATE_COMMON, D3D12_RESOURCE_STATE_VERTEX_AND_CONSTANT_BUFFER);
float halfWidth = (float)screenWidth * 0.5f;
float halfHeight = (float)screenHeight * 0.5f;
D3D12_VIEWPORT views[4] = {{0.0f, 0.0f, halfWidth, halfHeight, 0.0f, 1.0f},
{halfWidth, 0.0f, halfWidth, halfHeight, 0.0f, 1.0f},
{0.0f, halfHeight, halfWidth, halfHeight, 0.0f, 1.0f},
{halfWidth, halfHeight, halfWidth, halfHeight, 0.0f, 1.0f}};
while(Running())
{
ID3D12GraphicsCommandListPtr cmd = GetCommandBuffer();
Reset(cmd);
ID3D12ResourcePtr bb = StartUsingBackbuffer(cmd, D3D12_RESOURCE_STATE_RENDER_TARGET);
D3D12_CPU_DESCRIPTOR_HANDLE rtv =
MakeRTV(bb).Format(DXGI_FORMAT_R8G8B8A8_UNORM_SRGB).CreateCPU(0);
cmd->IASetPrimitiveTopology(D3D_PRIMITIVE_TOPOLOGY_TRIANGLELIST);
IASetVertexBuffer(cmd, vb, sizeof(DefaultA2V), 0);
cmd->SetGraphicsRootSignature(sig);
OMSetRenderTargets(cmd, {rtv}, {});
ClearRenderTargetView(cmd, rtv, {0.2f, 0.2f, 0.2f, 1.0f});
RSSetScissorRect(cmd, {0, 0, screenWidth, screenHeight});
cmd->SetMarker(1, "Test", (UINT)strlen("Test"));
for(int i = 0; i < 4; ++i)
{
RSSetViewport(cmd, views[i]);
cmd->SetPipelineState(pso[i]);
cmd->DrawInstanced(3, 1, 0, 0);
}
FinishUsingBackbuffer(cmd, D3D12_RESOURCE_STATE_RENDER_TARGET);
cmd->Close();
Submit({cmd});
Present();
}
return 0;
}
};
REGISTER_TEST();
util/test/demos/demos.vcxproj
+2
View File
@@ -139,6 +139,7 @@
<ClCompile Include="d3d11\d3d11_mip_gen_rt.cpp" />
<ClCompile Include="d3d11\d3d11_mip_rtv.cpp" />
<ClCompile Include="d3d11\d3d11_overdraw_stress.cpp" />
<ClCompile Include="d3d11\d3d11_primitiveid.cpp" />
<ClCompile Include="d3d11\d3d11_shader_debug_zoo.cpp" />
<ClCompile Include="d3d11\d3d11_overlay_test.cpp" />
<ClCompile Include="d3d11\d3d11_primitive_restart.cpp" />
@@ -166,6 +167,7 @@
<ClCompile Include="d3d12\d3d12_mesh_zoo.cpp" />
<ClCompile Include="d3d12\d3d12_overlay_test.cpp" />
<ClCompile Include="d3d12\d3d12_parameter_zoo.cpp" />
<ClCompile Include="d3d12\d3d12_primitiveid.cpp" />
<ClCompile Include="d3d12\d3d12_render_pass.cpp" />
<ClCompile Include="d3d12\d3d12_resource_lifetimes.cpp" />
<ClCompile Include="d3d12\d3d12_resource_mapping_zoo.cpp" />
util/test/demos/demos.vcxproj.filters
+6
View File
@@ -427,6 +427,12 @@
<ClCompile Include="d3d12\d3d12_resource_mapping_zoo.cpp">
<Filter>D3D12\demos</Filter>
</ClCompile>
<ClCompile Include="d3d11\d3d11_primitiveid.cpp">
<Filter>D3D11\demos</Filter>
</ClCompile>
<ClCompile Include="d3d12\d3d12_primitiveid.cpp">
<Filter>D3D12\demos</Filter>
</ClCompile>
</ItemGroup>
<ItemGroup>
<Filter Include="D3D11">
util/test/tests/D3D11/D3D11_PrimitiveID.py
+76
View File
@@ -0,0 +1,76 @@
import renderdoc as rd
from typing import List
import rdtest
class D3D11_PrimitiveID(rdtest.TestCase):
demos_test_name = 'D3D11_PrimitiveID'
def test_draw(self, draw: rd.DrawcallDescription, x, y, prim, expected_prim, expected_output):
self.controller.SetFrameEvent(draw.eventId, True)
pipe: rd.PipeState = self.controller.GetPipelineState()
trace: rd.ShaderDebugTrace = self.controller.DebugPixel(x, y, rd.ReplayController.NoPreference, prim)
sourceVars: List[rd.SourceVariableMapping] = list(trace.sourceVars)
cycles, variables = self.process_trace(trace)
# Find the SV_PrimitiveID variable
primInput = [var for var in sourceVars if var.builtin == rd.ShaderBuiltin.PrimitiveIndex]
if primInput == []:
# If we didn't find it, then we should be expecting a 0
if len(expected_prim) > 1 or expected_prim[0] is not 0:
rdtest.log.error("Expected prim {} at {},{} did not match actual prim {}.".format(
str(expected_prim), x, y, prim))
return False
else:
# Look up the matching register in the inputs, and see if the expected value matches
inputs: List[rd.ShaderVariable] = list(trace.inputs)
primValue = [var for var in inputs if var.name == primInput[0].variables[0].name][0]
if primValue.value.uv[0] not in expected_prim:
rdtest.log.error("Expected prim {} at {},{} did not match actual prim {}.".format(
str(expected_prim), x, y, primValue.value.uv[0]))
return False
# Compare shader debug output against an expected value instead of the RT's output,
# since we're testing overlapping primitives in a single draw
if expected_output is not None:
output = [var for var in sourceVars if var.builtin == rd.ShaderBuiltin.ColorOutput and var.offset == 0][0]
debugged = self.evalute_source_var(output, variables)
if debugged.value.fv[0:4] != expected_output:
rdtest.log.error("Expected value {} at {},{} did not match actual {}.".format(
expected_output, x, y, debugged.value.fv[0:4]))
return False
rdtest.log.success("Test at {},{} matched as expected".format(x, y))
return True
def check_capture(self):
success = True
# Jump to the draw
test_marker: rd.DrawcallDescription = self.find_draw("Test")
# Draw 1: No GS, PS without prim
draw = test_marker.next
success &= self.test_draw(draw, 100, 80, rd.ReplayController.NoPreference, [0], [0, 1, 0, 1])
# Draw 2: No GS, PS with prim
draw = draw.next
success &= self.test_draw(draw, 300, 80, rd.ReplayController.NoPreference, [0], [0, 1, 0, 1])
# Draw 3: GS, PS without prim
draw = draw.next
success &= self.test_draw(draw, 125, 250, rd.ReplayController.NoPreference, [0], [0, 1, 0, 1])
# Draw 4: GS, PS with prim
draw = draw.next
success &= self.test_draw(draw, 325, 250, 2, [2], [0.5, 1, 0, 1])
success &= self.test_draw(draw, 325, 250, 3, [3], [0.75, 1, 0, 1])
# No expected output here, since it's nondeterministic which primitive gets selected
success &= self.test_draw(draw, 325, 250, rd.ReplayController.NoPreference, [2, 3], None)
if not success:
raise rdtest.TestFailureException("Some tests were not as expected")
rdtest.log.success("All tests matched")
util/test/tests/D3D12/D3D12_PrimitiveID.py
+79
View File
@@ -0,0 +1,79 @@
import renderdoc as rd
from typing import List
import rdtest
class D3D12_PrimitiveID(rdtest.TestCase):
demos_test_name = 'D3D12_PrimitiveID'
def check_support(self):
return False, 'shader debugging is not yet enabled for D3D12'
def test_draw(self, draw: rd.DrawcallDescription, x, y, prim, expected_prim, expected_output):
self.controller.SetFrameEvent(draw.eventId, True)
pipe: rd.PipeState = self.controller.GetPipelineState()
trace: rd.ShaderDebugTrace = self.controller.DebugPixel(x, y, rd.ReplayController.NoPreference, prim)
sourceVars: List[rd.SourceVariableMapping] = list(trace.sourceVars)
cycles, variables = self.process_trace(trace)
# Find the SV_PrimitiveID variable
primInput = [var for var in sourceVars if var.builtin == rd.ShaderBuiltin.PrimitiveIndex]
if primInput == []:
# If we didn't find it, then we should be expecting a 0
if len(expected_prim) > 1 or expected_prim[0] is not 0:
rdtest.log.error("Expected prim {} at {},{} did not match actual prim {}.".format(
str(expected_prim), x, y, prim))
return False
else:
# Look up the matching register in the inputs, and see if the expected value matches
inputs: List[rd.ShaderVariable] = list(trace.inputs)
primValue = [var for var in inputs if var.name == primInput[0].variables[0].name][0]
if primValue.value.uv[0] not in expected_prim:
rdtest.log.error("Expected prim {} at {},{} did not match actual prim {}.".format(
str(expected_prim), x, y, primValue.value.uv[0]))
return False
# Compare shader debug output against an expected value instead of the RT's output,
# since we're testing overlapping primitives in a single draw
if expected_output is not None:
output = [var for var in sourceVars if var.builtin == rd.ShaderBuiltin.ColorOutput and var.offset == 0][0]
debugged = self.evalute_source_var(output, variables)
if debugged.value.fv[0:4] != expected_output:
rdtest.log.error("Expected value {} at {},{} did not match actual {}.".format(
expected_output, x, y, debugged.value.fv[0:4]))
return False
rdtest.log.success("Test at {},{} matched as expected".format(x, y))
return True
def check_capture(self):
success = True
# Jump to the draw
test_marker: rd.DrawcallDescription = self.find_draw("Test")
# Draw 1: No GS, PS without prim
draw = test_marker.next
success &= self.test_draw(draw, 100, 80, rd.ReplayController.NoPreference, [0], [0, 1, 0, 1])
# Draw 2: No GS, PS with prim
draw = draw.next
success &= self.test_draw(draw, 300, 80, rd.ReplayController.NoPreference, [0], [0, 1, 0, 1])
# Draw 3: GS, PS without prim
draw = draw.next
success &= self.test_draw(draw, 125, 250, rd.ReplayController.NoPreference, [0], [0, 1, 0, 1])
# Draw 4: GS, PS with prim
draw = draw.next
success &= self.test_draw(draw, 325, 250, 2, [2], [0.5, 1, 0, 1])
success &= self.test_draw(draw, 325, 250, 3, [3], [0.75, 1, 0, 1])
# No expected output here, since it's nondeterministic which primitive gets selected
success &= self.test_draw(draw, 325, 250, rd.ReplayController.NoPreference, [2, 3], None)
if not success:
raise rdtest.TestFailureException("Some tests were not as expected")
rdtest.log.success("All tests matched")