omar/panopainter
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add renderer depth state contract

Browse Source
This commit is contained in:
omigamedev
2026-06-02 15:50:59 +02:00
parent 9a7e1c4def
commit b68ddc42c6
9 changed files with 243 additions and 58 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
tests/CMakeLists.txt
View File

@@ -365,7 +365,7 @@ if(TARGET pano_cli)
COMMAND pano_cli record-render --width 32 --height 16)
set_tests_properties(pano_cli_record_render_smoke PROPERTIES
LABELS "renderer;integration;desktop-fast"
PASS_REGULAR_EXPRESSION "\"backend\":\"recording\".*\"width\":32.*\"height\":16.*\"commands\":14.*\"drawCommands\":1.*\"scissorCommands\":1.*\"blendCommands\":1.*\"bindTextureCommands\":1.*\"boundTextureBytes\":2048.*\"uploadCommands\":1.*\"uploadBytes\":4.*\"readbackCommands\":1.*\"readbackBytes\":2048.*\"captureCommands\":1.*\"captureBytes\":2048.*\"blitCommands\":1.*\"blitSourceBytes\":2048.*\"blitDestinationBytes\":2048")
PASS_REGULAR_EXPRESSION "\"backend\":\"recording\".*\"width\":32.*\"height\":16.*\"commands\":15.*\"drawCommands\":1.*\"scissorCommands\":1.*\"blendCommands\":1.*\"depthCommands\":1.*\"bindTextureCommands\":1.*\"boundTextureBytes\":2048.*\"uploadCommands\":1.*\"uploadBytes\":4.*\"readbackCommands\":1.*\"readbackBytes\":2048.*\"captureCommands\":1.*\"captureBytes\":2048.*\"blitCommands\":1.*\"blitSourceBytes\":2048.*\"blitDestinationBytes\":2048")
add_test(NAME pano_cli_record_render_rejects_oversized_target
COMMAND "${CMAKE_COMMAND}"

164
tests/renderer_api/renderer_api_tests.cpp
View File

@@ -16,6 +16,9 @@ using pp::renderer::BlendOp;
using pp::renderer::blend_op_name;
using pp::renderer::BlendState;
using pp::renderer::ClearColor;
using pp::renderer::CompareOp;
using pp::renderer::compare_op_name;
using pp::renderer::DepthState;
using pp::renderer::Extent2D;
using pp::renderer::frame_capture_byte_size;
using pp::renderer::ICommandContext;
@@ -56,6 +59,8 @@ using pp::renderer::validate_blit_filter;
using pp::renderer::validate_blend_factor;
using pp::renderer::validate_blend_op;
using pp::renderer::validate_blend_state;
using pp::renderer::validate_compare_op;
using pp::renderer::validate_depth_state;
using pp::renderer::validate_mesh_desc;
using pp::renderer::validate_readback_region;
using pp::renderer::validate_scissor;
@@ -184,6 +189,19 @@ public:
return pp::foundation::Status::success();
}
[[nodiscard]] pp::foundation::Status set_depth_state(DepthState state) noexcept override
{
if (!in_render_pass) {
return pp::foundation::Status::invalid_argument("render pass has not begun");
}
const auto status = validate_depth_state(state);
if (!status.ok()) {
return status;
}
last_depth_state = state;
return pp::foundation::Status::success();
}
[[nodiscard]] pp::foundation::Status bind_texture(
std::uint32_t slot,
pp::renderer::ITexture2D& texture) noexcept override
@@ -303,6 +321,7 @@ public:
const char* shader_name = nullptr;
ScissorRect last_scissor {};
BlendState last_blend_state {};
DepthState last_depth_state {};
std::uint32_t last_texture_slot = 0;
std::uint64_t last_texture_bytes = 0;
std::uint64_t last_upload_bytes = 0;
@@ -510,6 +529,27 @@ void validates_blend_contract(pp::tests::Harness& h)
PP_EXPECT(h, blend_op_name(static_cast<BlendOp>(255)) == std::string_view("unknown"));
}
void validates_depth_contract(pp::tests::Harness& h)
{
const DepthState read_write_depth {
.test_enabled = true,
.write_enabled = true,
.compare = CompareOp::less_or_equal,
};
PP_EXPECT(h, validate_depth_state(read_write_depth).ok());
PP_EXPECT(h, validate_compare_op(CompareOp::always).ok());
PP_EXPECT(h, compare_op_name(CompareOp::greater_or_equal) == std::string_view("greater_or_equal"));
auto bad_compare = read_write_depth;
bad_compare.compare = static_cast<CompareOp>(255);
const auto bad_compare_status = validate_depth_state(bad_compare);
PP_EXPECT(h, !bad_compare_status.ok());
PP_EXPECT(h, bad_compare_status.code == StatusCode::invalid_argument);
PP_EXPECT(h, compare_op_name(static_cast<CompareOp>(255)) == std::string_view("unknown"));
}
void validates_viewports_and_mesh_descriptors(pp::tests::Harness& h)
{
const Extent2D target { .width = 64, .height = 32 };
@@ -692,6 +732,12 @@ void renderer_interfaces_support_backend_neutral_dispatch(pp::tests::Harness& h)
.destination_color = BlendFactor::one_minus_source_alpha,
})
.ok());
PP_EXPECT(h, context.set_depth_state(DepthState {
.test_enabled = true,
.write_enabled = true,
.compare = CompareOp::less_or_equal,
})
.ok());
PP_EXPECT(h, context.bind_shader(shader).ok());
PP_EXPECT(h, context.bind_texture(2, texture).ok());
PP_EXPECT(h, context.bind_mesh(mesh).ok());
@@ -726,6 +772,9 @@ void renderer_interfaces_support_backend_neutral_dispatch(pp::tests::Harness& h)
PP_EXPECT(h, device.context.last_blend_state.enabled);
PP_EXPECT(h, device.context.last_blend_state.source_color == BlendFactor::source_alpha);
PP_EXPECT(h, device.context.last_blend_state.destination_color == BlendFactor::one_minus_source_alpha);
PP_EXPECT(h, device.context.last_depth_state.test_enabled);
PP_EXPECT(h, device.context.last_depth_state.write_enabled);
PP_EXPECT(h, device.context.last_depth_state.compare == CompareOp::less_or_equal);
PP_EXPECT(h, device.context.last_texture_slot == 2U);
PP_EXPECT(h, device.context.last_texture_bytes == 8192U);
PP_EXPECT(h, device.context.last_upload_bytes == 80U);
@@ -774,6 +823,12 @@ void recording_renderer_records_valid_command_sequences(pp::tests::Harness& h)
.destination_alpha = BlendFactor::one_minus_source_alpha,
})
.ok());
PP_EXPECT(h, context.set_depth_state(DepthState {
.test_enabled = true,
.write_enabled = true,
.compare = CompareOp::less_or_equal,
})
.ok());
PP_EXPECT(h, context.bind_shader(shader).ok());
PP_EXPECT(h, context.bind_texture(1, texture).ok());
PP_EXPECT(h, context.bind_mesh(mesh).ok());
@@ -781,7 +836,7 @@ void recording_renderer_records_valid_command_sequences(pp::tests::Harness& h)
context.end_render_pass();
const auto commands = device.commands();
PP_EXPECT(h, commands.size() == 10U);
PP_EXPECT(h, commands.size() == 11U);
PP_EXPECT(h, commands[0].kind == RecordedRenderCommandKind::trace_marker);
PP_EXPECT(h, commands[0].component == std::string_view("renderer"));
PP_EXPECT(h, commands[0].name == std::string_view("frame"));
@@ -799,17 +854,22 @@ void recording_renderer_records_valid_command_sequences(pp::tests::Harness& h)
PP_EXPECT(h, commands[4].blend_state.enabled);
PP_EXPECT(h, commands[4].blend_state.destination_color == BlendFactor::one_minus_source_alpha);
PP_EXPECT(h, recorded_render_command_kind_name(commands[4].kind) == std::string_view("set_blend_state"));
PP_EXPECT(h, commands[5].kind == RecordedRenderCommandKind::bind_shader);
PP_EXPECT(h, commands[5].name == std::string_view("recorded-shader"));
PP_EXPECT(h, commands[6].kind == RecordedRenderCommandKind::bind_texture);
PP_EXPECT(h, commands[6].texture_slot == 1U);
PP_EXPECT(h, commands[6].texture_desc.extent.height == 32U);
PP_EXPECT(h, recorded_render_command_kind_name(commands[6].kind) == std::string_view("bind_texture"));
PP_EXPECT(h, commands[7].kind == RecordedRenderCommandKind::bind_mesh);
PP_EXPECT(h, commands[7].mesh_desc.vertex_count == 3U);
PP_EXPECT(h, commands[8].kind == RecordedRenderCommandKind::draw);
PP_EXPECT(h, commands[9].kind == RecordedRenderCommandKind::end_render_pass);
PP_EXPECT(h, recorded_render_command_kind_name(commands[8].kind) == std::string_view("draw"));
PP_EXPECT(h, commands[5].kind == RecordedRenderCommandKind::set_depth_state);
PP_EXPECT(h, commands[5].depth_state.test_enabled);
PP_EXPECT(h, commands[5].depth_state.write_enabled);
PP_EXPECT(h, commands[5].depth_state.compare == CompareOp::less_or_equal);
PP_EXPECT(h, recorded_render_command_kind_name(commands[5].kind) == std::string_view("set_depth_state"));
PP_EXPECT(h, commands[6].kind == RecordedRenderCommandKind::bind_shader);
PP_EXPECT(h, commands[6].name == std::string_view("recorded-shader"));
PP_EXPECT(h, commands[7].kind == RecordedRenderCommandKind::bind_texture);
PP_EXPECT(h, commands[7].texture_slot == 1U);
PP_EXPECT(h, commands[7].texture_desc.extent.height == 32U);
PP_EXPECT(h, recorded_render_command_kind_name(commands[7].kind) == std::string_view("bind_texture"));
PP_EXPECT(h, commands[8].kind == RecordedRenderCommandKind::bind_mesh);
PP_EXPECT(h, commands[8].mesh_desc.vertex_count == 3U);
PP_EXPECT(h, commands[9].kind == RecordedRenderCommandKind::draw);
PP_EXPECT(h, commands[10].kind == RecordedRenderCommandKind::end_render_pass);
PP_EXPECT(h, recorded_render_command_kind_name(commands[9].kind) == std::string_view("draw"));
PP_EXPECT(h, context.upload_texture(
texture,
@@ -817,12 +877,12 @@ void recording_renderer_records_valid_command_sequences(pp::tests::Harness& h)
upload_bytes)
.ok());
const auto commands_after_upload = device.commands();
PP_EXPECT(h, commands_after_upload.size() == 11U);
PP_EXPECT(h, commands_after_upload[10].kind == RecordedRenderCommandKind::upload_texture);
PP_EXPECT(h, commands_after_upload[10].texture_desc.extent.width == 64U);
PP_EXPECT(h, commands_after_upload[10].readback_region.x == 4U);
PP_EXPECT(h, commands_after_upload[10].upload_bytes == 96U);
PP_EXPECT(h, recorded_render_command_kind_name(commands_after_upload[10].kind) == std::string_view("upload_texture"));
PP_EXPECT(h, commands_after_upload.size() == 12U);
PP_EXPECT(h, commands_after_upload[11].kind == RecordedRenderCommandKind::upload_texture);
PP_EXPECT(h, commands_after_upload[11].texture_desc.extent.width == 64U);
PP_EXPECT(h, commands_after_upload[11].readback_region.x == 4U);
PP_EXPECT(h, commands_after_upload[11].upload_bytes == 96U);
PP_EXPECT(h, recorded_render_command_kind_name(commands_after_upload[11].kind) == std::string_view("upload_texture"));
PP_EXPECT(h, context.read_texture(
texture,
@@ -830,22 +890,22 @@ void recording_renderer_records_valid_command_sequences(pp::tests::Harness& h)
readback_buffer)
.ok());
const auto commands_after_readback = device.commands();
PP_EXPECT(h, commands_after_readback.size() == 12U);
PP_EXPECT(h, commands_after_readback[11].kind == RecordedRenderCommandKind::read_texture);
PP_EXPECT(h, commands_after_readback[11].texture_desc.extent.width == 64U);
PP_EXPECT(h, commands_after_readback[11].readback_region.x == 4U);
PP_EXPECT(h, commands_after_readback[11].readback_region.height == 3U);
PP_EXPECT(h, commands_after_readback[11].readback_bytes == 96U);
PP_EXPECT(h, recorded_render_command_kind_name(commands_after_readback[11].kind) == std::string_view("read_texture"));
PP_EXPECT(h, commands_after_readback.size() == 13U);
PP_EXPECT(h, commands_after_readback[12].kind == RecordedRenderCommandKind::read_texture);
PP_EXPECT(h, commands_after_readback[12].texture_desc.extent.width == 64U);
PP_EXPECT(h, commands_after_readback[12].readback_region.x == 4U);
PP_EXPECT(h, commands_after_readback[12].readback_region.height == 3U);
PP_EXPECT(h, commands_after_readback[12].readback_bytes == 96U);
PP_EXPECT(h, recorded_render_command_kind_name(commands_after_readback[12].kind) == std::string_view("read_texture"));
PP_EXPECT(h, context.capture_frame(target, readback_buffer).ok());
const auto commands_after_capture = device.commands();
PP_EXPECT(h, commands_after_capture.size() == 13U);
PP_EXPECT(h, commands_after_capture[12].kind == RecordedRenderCommandKind::capture_frame);
PP_EXPECT(h, commands_after_capture[12].target_desc.extent.width == 64U);
PP_EXPECT(h, commands_after_capture[12].target_desc.extent.height == 32U);
PP_EXPECT(h, commands_after_capture[12].capture_bytes == 8192U);
PP_EXPECT(h, recorded_render_command_kind_name(commands_after_capture[12].kind) == std::string_view("capture_frame"));
PP_EXPECT(h, commands_after_capture.size() == 14U);
PP_EXPECT(h, commands_after_capture[13].kind == RecordedRenderCommandKind::capture_frame);
PP_EXPECT(h, commands_after_capture[13].target_desc.extent.width == 64U);
PP_EXPECT(h, commands_after_capture[13].target_desc.extent.height == 32U);
PP_EXPECT(h, commands_after_capture[13].capture_bytes == 8192U);
PP_EXPECT(h, recorded_render_command_kind_name(commands_after_capture[13].kind) == std::string_view("capture_frame"));
PP_EXPECT(h, context.blit_render_target(
target,
@@ -855,16 +915,16 @@ void recording_renderer_records_valid_command_sequences(pp::tests::Harness& h)
BlitFilter::linear)
.ok());
const auto commands_after_blit = device.commands();
PP_EXPECT(h, commands_after_blit.size() == 14U);
PP_EXPECT(h, commands_after_blit[13].kind == RecordedRenderCommandKind::blit_render_target);
PP_EXPECT(h, commands_after_blit[13].source_desc.extent.width == 64U);
PP_EXPECT(h, commands_after_blit[13].destination_desc.extent.height == 32U);
PP_EXPECT(h, commands_after_blit[13].source_region.width == 16U);
PP_EXPECT(h, commands_after_blit[13].destination_region.x == 2U);
PP_EXPECT(h, commands_after_blit[13].blit_filter == BlitFilter::linear);
PP_EXPECT(h, commands_after_blit[13].blit_source_bytes == 512U);
PP_EXPECT(h, commands_after_blit[13].blit_destination_bytes == 128U);
PP_EXPECT(h, recorded_render_command_kind_name(commands_after_blit[13].kind) == std::string_view("blit_render_target"));
PP_EXPECT(h, commands_after_blit.size() == 15U);
PP_EXPECT(h, commands_after_blit[14].kind == RecordedRenderCommandKind::blit_render_target);
PP_EXPECT(h, commands_after_blit[14].source_desc.extent.width == 64U);
PP_EXPECT(h, commands_after_blit[14].destination_desc.extent.height == 32U);
PP_EXPECT(h, commands_after_blit[14].source_region.width == 16U);
PP_EXPECT(h, commands_after_blit[14].destination_region.x == 2U);
PP_EXPECT(h, commands_after_blit[14].blit_filter == BlitFilter::linear);
PP_EXPECT(h, commands_after_blit[14].blit_source_bytes == 512U);
PP_EXPECT(h, commands_after_blit[14].blit_destination_bytes == 128U);
PP_EXPECT(h, recorded_render_command_kind_name(commands_after_blit[14].kind) == std::string_view("blit_render_target"));
device.clear();
PP_EXPECT(h, device.commands().empty());
@@ -914,6 +974,10 @@ void recording_renderer_rejects_invalid_command_order_and_targets(pp::tests::Har
PP_EXPECT(h, !scissor_before_begin.ok());
PP_EXPECT(h, scissor_before_begin.code == StatusCode::invalid_argument);
const auto depth_before_begin = context.set_depth_state(DepthState {});
PP_EXPECT(h, !depth_before_begin.ok());
PP_EXPECT(h, depth_before_begin.code == StatusCode::invalid_argument);
const auto invalid_target = context.begin_render_pass(non_render_target, ClearColor {});
PP_EXPECT(h, !invalid_target.ok());
PP_EXPECT(h, invalid_target.code == StatusCode::invalid_argument);
@@ -982,6 +1046,19 @@ void recording_renderer_rejects_invalid_command_order_and_targets(pp::tests::Har
PP_EXPECT(h, !invalid_scissor.ok());
PP_EXPECT(h, invalid_scissor.code == StatusCode::out_of_range);
auto invalid_depth = DepthState {};
invalid_depth.compare = static_cast<CompareOp>(255);
const auto invalid_depth_state = context.set_depth_state(invalid_depth);
PP_EXPECT(h, !invalid_depth_state.ok());
PP_EXPECT(h, invalid_depth_state.code == StatusCode::invalid_argument);
PP_EXPECT(h, context.set_depth_state(DepthState {
.test_enabled = true,
.write_enabled = true,
.compare = CompareOp::less_or_equal,
})
.ok());
const auto draw_without_bindings = context.draw();
PP_EXPECT(h, !draw_without_bindings.ok());
PP_EXPECT(h, draw_without_bindings.code == StatusCode::invalid_argument);
@@ -1016,6 +1093,10 @@ void recording_renderer_rejects_invalid_command_order_and_targets(pp::tests::Har
PP_EXPECT(h, !scissor_after_end.ok());
PP_EXPECT(h, scissor_after_end.code == StatusCode::invalid_argument);
const auto depth_after_end = context.set_depth_state(DepthState {});
PP_EXPECT(h, !depth_after_end.ok());
PP_EXPECT(h, depth_after_end.code == StatusCode::invalid_argument);
const auto bind_texture_after_end = context.bind_texture(0, texture);
PP_EXPECT(h, !bind_texture_after_end.ok());
PP_EXPECT(h, bind_texture_after_end.code == StatusCode::invalid_argument);
@@ -1105,6 +1186,7 @@ int main()
harness.run("computes_frame_capture_byte_sizes", computes_frame_capture_byte_sizes);
harness.run("validates_blit_contract", validates_blit_contract);
harness.run("validates_blend_contract", validates_blend_contract);
harness.run("validates_depth_contract", validates_depth_contract);
harness.run("validates_viewports_and_mesh_descriptors", validates_viewports_and_mesh_descriptors);
harness.run("validates_shader_program_descriptors", validates_shader_program_descriptors);
harness.run("validates_panopainter_shader_catalog", validates_panopainter_shader_catalog);