Add renderer blend state contract

This commit is contained in:
2026-06-02 15:40:43 +02:00
parent 5dbeb0504d
commit 5226746c1a
9 changed files with 326 additions and 60 deletions

View File

@@ -10,6 +10,11 @@
using pp::foundation::StatusCode;
using pp::renderer::BlitFilter;
using pp::renderer::blit_filter_name;
using pp::renderer::BlendFactor;
using pp::renderer::blend_factor_name;
using pp::renderer::BlendOp;
using pp::renderer::blend_op_name;
using pp::renderer::BlendState;
using pp::renderer::ClearColor;
using pp::renderer::Extent2D;
using pp::renderer::frame_capture_byte_size;
@@ -47,6 +52,9 @@ using pp::renderer::texture_format_name;
using pp::renderer::validate_extent;
using pp::renderer::validate_blit_descs;
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_mesh_desc;
using pp::renderer::validate_readback_region;
using pp::renderer::validate_shader_catalog;
@@ -148,6 +156,19 @@ public:
return pp::foundation::Status::success();
}
[[nodiscard]] pp::foundation::Status set_blend_state(BlendState state) noexcept override
{
if (!in_render_pass) {
return pp::foundation::Status::invalid_argument("render pass has not begun");
}
const auto status = validate_blend_state(state);
if (!status.ok()) {
return status;
}
last_blend_state = state;
return pp::foundation::Status::success();
}
[[nodiscard]] pp::foundation::Status bind_texture(
std::uint32_t slot,
pp::renderer::ITexture2D& texture) noexcept override
@@ -265,6 +286,7 @@ public:
bool in_render_pass = false;
const char* shader_name = nullptr;
BlendState last_blend_state {};
std::uint32_t last_texture_slot = 0;
std::uint64_t last_texture_bytes = 0;
std::uint64_t last_upload_bytes = 0;
@@ -437,6 +459,41 @@ void validates_blit_contract(pp::tests::Harness& h)
PP_EXPECT(h, blit_filter_name(static_cast<BlitFilter>(255)) == std::string_view("unknown"));
}
void validates_blend_contract(pp::tests::Harness& h)
{
const BlendState alpha_blend {
.enabled = true,
.source_color = BlendFactor::source_alpha,
.destination_color = BlendFactor::one_minus_source_alpha,
.color_op = BlendOp::add,
.source_alpha = BlendFactor::one,
.destination_alpha = BlendFactor::one_minus_source_alpha,
.alpha_op = BlendOp::add,
};
PP_EXPECT(h, validate_blend_state(alpha_blend).ok());
PP_EXPECT(h, validate_blend_factor(BlendFactor::destination_alpha).ok());
PP_EXPECT(h, validate_blend_op(BlendOp::reverse_subtract).ok());
PP_EXPECT(h, blend_factor_name(BlendFactor::one_minus_destination_alpha)
== std::string_view("one_minus_destination_alpha"));
PP_EXPECT(h, blend_op_name(BlendOp::subtract) == std::string_view("subtract"));
auto bad_source = alpha_blend;
bad_source.source_color = static_cast<BlendFactor>(255);
auto bad_op = alpha_blend;
bad_op.alpha_op = static_cast<BlendOp>(255);
const auto bad_source_status = validate_blend_state(bad_source);
const auto bad_op_status = validate_blend_state(bad_op);
PP_EXPECT(h, !bad_source_status.ok());
PP_EXPECT(h, bad_source_status.code == StatusCode::invalid_argument);
PP_EXPECT(h, !bad_op_status.ok());
PP_EXPECT(h, bad_op_status.code == StatusCode::invalid_argument);
PP_EXPECT(h, blend_factor_name(static_cast<BlendFactor>(255)) == std::string_view("unknown"));
PP_EXPECT(h, blend_op_name(static_cast<BlendOp>(255)) == std::string_view("unknown"));
}
void validates_viewports_and_mesh_descriptors(pp::tests::Harness& h)
{
const Extent2D target { .width = 64, .height = 32 };
@@ -598,6 +655,12 @@ void renderer_interfaces_support_backend_neutral_dispatch(pp::tests::Harness& h)
auto& context = device.immediate_context();
PP_EXPECT(h, context.begin_render_pass(target, ClearColor { .r = 0.1F, .g = 0.2F, .b = 0.3F, .a = 1.0F }).ok());
PP_EXPECT(h, context.set_viewport(Viewport { .x = 0, .y = 0, .width = 64, .height = 32 }).ok());
PP_EXPECT(h, context.set_blend_state(BlendState {
.enabled = true,
.source_color = BlendFactor::source_alpha,
.destination_color = BlendFactor::one_minus_source_alpha,
})
.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());
@@ -626,6 +689,9 @@ void renderer_interfaces_support_backend_neutral_dispatch(pp::tests::Harness& h)
BlitFilter::linear)
.ok());
PP_EXPECT(h, device.context.shader_name == std::string_view("fake-shader"));
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_texture_slot == 2U);
PP_EXPECT(h, device.context.last_texture_bytes == 8192U);
PP_EXPECT(h, device.context.last_upload_bytes == 80U);
@@ -665,6 +731,14 @@ void recording_renderer_records_valid_command_sequences(pp::tests::Harness& h)
auto& context = device.immediate_context();
PP_EXPECT(h, context.begin_render_pass(target, ClearColor { .r = 0.2F, .g = 0.3F, .b = 0.4F, .a = 1.0F }).ok());
PP_EXPECT(h, context.set_viewport(Viewport { .x = 0, .y = 0, .width = 64, .height = 32 }).ok());
PP_EXPECT(h, context.set_blend_state(BlendState {
.enabled = true,
.source_color = BlendFactor::source_alpha,
.destination_color = BlendFactor::one_minus_source_alpha,
.source_alpha = BlendFactor::one,
.destination_alpha = BlendFactor::one_minus_source_alpha,
})
.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());
@@ -672,7 +746,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() == 8U);
PP_EXPECT(h, commands.size() == 9U);
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"));
@@ -681,17 +755,21 @@ void recording_renderer_records_valid_command_sequences(pp::tests::Harness& h)
PP_EXPECT(h, commands[1].clear_color.a == 1.0F);
PP_EXPECT(h, commands[2].kind == RecordedRenderCommandKind::set_viewport);
PP_EXPECT(h, commands[2].viewport.height == 32U);
PP_EXPECT(h, commands[3].kind == RecordedRenderCommandKind::bind_shader);
PP_EXPECT(h, commands[3].name == std::string_view("recorded-shader"));
PP_EXPECT(h, commands[4].kind == RecordedRenderCommandKind::bind_texture);
PP_EXPECT(h, commands[4].texture_slot == 1U);
PP_EXPECT(h, commands[4].texture_desc.extent.height == 32U);
PP_EXPECT(h, recorded_render_command_kind_name(commands[4].kind) == std::string_view("bind_texture"));
PP_EXPECT(h, commands[5].kind == RecordedRenderCommandKind::bind_mesh);
PP_EXPECT(h, commands[5].mesh_desc.vertex_count == 3U);
PP_EXPECT(h, commands[6].kind == RecordedRenderCommandKind::draw);
PP_EXPECT(h, commands[7].kind == RecordedRenderCommandKind::end_render_pass);
PP_EXPECT(h, recorded_render_command_kind_name(commands[6].kind) == std::string_view("draw"));
PP_EXPECT(h, commands[3].kind == RecordedRenderCommandKind::set_blend_state);
PP_EXPECT(h, commands[3].blend_state.enabled);
PP_EXPECT(h, commands[3].blend_state.destination_color == BlendFactor::one_minus_source_alpha);
PP_EXPECT(h, recorded_render_command_kind_name(commands[3].kind) == std::string_view("set_blend_state"));
PP_EXPECT(h, commands[4].kind == RecordedRenderCommandKind::bind_shader);
PP_EXPECT(h, commands[4].name == std::string_view("recorded-shader"));
PP_EXPECT(h, commands[5].kind == RecordedRenderCommandKind::bind_texture);
PP_EXPECT(h, commands[5].texture_slot == 1U);
PP_EXPECT(h, commands[5].texture_desc.extent.height == 32U);
PP_EXPECT(h, recorded_render_command_kind_name(commands[5].kind) == std::string_view("bind_texture"));
PP_EXPECT(h, commands[6].kind == RecordedRenderCommandKind::bind_mesh);
PP_EXPECT(h, commands[6].mesh_desc.vertex_count == 3U);
PP_EXPECT(h, commands[7].kind == RecordedRenderCommandKind::draw);
PP_EXPECT(h, commands[8].kind == RecordedRenderCommandKind::end_render_pass);
PP_EXPECT(h, recorded_render_command_kind_name(commands[7].kind) == std::string_view("draw"));
PP_EXPECT(h, context.upload_texture(
texture,
@@ -699,12 +777,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() == 9U);
PP_EXPECT(h, commands_after_upload[8].kind == RecordedRenderCommandKind::upload_texture);
PP_EXPECT(h, commands_after_upload[8].texture_desc.extent.width == 64U);
PP_EXPECT(h, commands_after_upload[8].readback_region.x == 4U);
PP_EXPECT(h, commands_after_upload[8].upload_bytes == 96U);
PP_EXPECT(h, recorded_render_command_kind_name(commands_after_upload[8].kind) == std::string_view("upload_texture"));
PP_EXPECT(h, commands_after_upload.size() == 10U);
PP_EXPECT(h, commands_after_upload[9].kind == RecordedRenderCommandKind::upload_texture);
PP_EXPECT(h, commands_after_upload[9].texture_desc.extent.width == 64U);
PP_EXPECT(h, commands_after_upload[9].readback_region.x == 4U);
PP_EXPECT(h, commands_after_upload[9].upload_bytes == 96U);
PP_EXPECT(h, recorded_render_command_kind_name(commands_after_upload[9].kind) == std::string_view("upload_texture"));
PP_EXPECT(h, context.read_texture(
texture,
@@ -712,22 +790,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() == 10U);
PP_EXPECT(h, commands_after_readback[9].kind == RecordedRenderCommandKind::read_texture);
PP_EXPECT(h, commands_after_readback[9].texture_desc.extent.width == 64U);
PP_EXPECT(h, commands_after_readback[9].readback_region.x == 4U);
PP_EXPECT(h, commands_after_readback[9].readback_region.height == 3U);
PP_EXPECT(h, commands_after_readback[9].readback_bytes == 96U);
PP_EXPECT(h, recorded_render_command_kind_name(commands_after_readback[9].kind) == std::string_view("read_texture"));
PP_EXPECT(h, commands_after_readback.size() == 11U);
PP_EXPECT(h, commands_after_readback[10].kind == RecordedRenderCommandKind::read_texture);
PP_EXPECT(h, commands_after_readback[10].texture_desc.extent.width == 64U);
PP_EXPECT(h, commands_after_readback[10].readback_region.x == 4U);
PP_EXPECT(h, commands_after_readback[10].readback_region.height == 3U);
PP_EXPECT(h, commands_after_readback[10].readback_bytes == 96U);
PP_EXPECT(h, recorded_render_command_kind_name(commands_after_readback[10].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() == 11U);
PP_EXPECT(h, commands_after_capture[10].kind == RecordedRenderCommandKind::capture_frame);
PP_EXPECT(h, commands_after_capture[10].target_desc.extent.width == 64U);
PP_EXPECT(h, commands_after_capture[10].target_desc.extent.height == 32U);
PP_EXPECT(h, commands_after_capture[10].capture_bytes == 8192U);
PP_EXPECT(h, recorded_render_command_kind_name(commands_after_capture[10].kind) == std::string_view("capture_frame"));
PP_EXPECT(h, commands_after_capture.size() == 12U);
PP_EXPECT(h, commands_after_capture[11].kind == RecordedRenderCommandKind::capture_frame);
PP_EXPECT(h, commands_after_capture[11].target_desc.extent.width == 64U);
PP_EXPECT(h, commands_after_capture[11].target_desc.extent.height == 32U);
PP_EXPECT(h, commands_after_capture[11].capture_bytes == 8192U);
PP_EXPECT(h, recorded_render_command_kind_name(commands_after_capture[11].kind) == std::string_view("capture_frame"));
PP_EXPECT(h, context.blit_render_target(
target,
@@ -737,16 +815,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() == 12U);
PP_EXPECT(h, commands_after_blit[11].kind == RecordedRenderCommandKind::blit_render_target);
PP_EXPECT(h, commands_after_blit[11].source_desc.extent.width == 64U);
PP_EXPECT(h, commands_after_blit[11].destination_desc.extent.height == 32U);
PP_EXPECT(h, commands_after_blit[11].source_region.width == 16U);
PP_EXPECT(h, commands_after_blit[11].destination_region.x == 2U);
PP_EXPECT(h, commands_after_blit[11].blit_filter == BlitFilter::linear);
PP_EXPECT(h, commands_after_blit[11].blit_source_bytes == 512U);
PP_EXPECT(h, commands_after_blit[11].blit_destination_bytes == 128U);
PP_EXPECT(h, recorded_render_command_kind_name(commands_after_blit[11].kind) == std::string_view("blit_render_target"));
PP_EXPECT(h, commands_after_blit.size() == 13U);
PP_EXPECT(h, commands_after_blit[12].kind == RecordedRenderCommandKind::blit_render_target);
PP_EXPECT(h, commands_after_blit[12].source_desc.extent.width == 64U);
PP_EXPECT(h, commands_after_blit[12].destination_desc.extent.height == 32U);
PP_EXPECT(h, commands_after_blit[12].source_region.width == 16U);
PP_EXPECT(h, commands_after_blit[12].destination_region.x == 2U);
PP_EXPECT(h, commands_after_blit[12].blit_filter == BlitFilter::linear);
PP_EXPECT(h, commands_after_blit[12].blit_source_bytes == 512U);
PP_EXPECT(h, commands_after_blit[12].blit_destination_bytes == 128U);
PP_EXPECT(h, recorded_render_command_kind_name(commands_after_blit[12].kind) == std::string_view("blit_render_target"));
device.clear();
PP_EXPECT(h, device.commands().empty());
@@ -788,6 +866,10 @@ void recording_renderer_rejects_invalid_command_order_and_targets(pp::tests::Har
PP_EXPECT(h, !draw_before_begin.ok());
PP_EXPECT(h, draw_before_begin.code == StatusCode::invalid_argument);
const auto blend_before_begin = context.set_blend_state(BlendState {});
PP_EXPECT(h, !blend_before_begin.ok());
PP_EXPECT(h, blend_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);
@@ -825,6 +907,19 @@ void recording_renderer_rejects_invalid_command_order_and_targets(pp::tests::Har
PP_EXPECT(h, !nested_begin.ok());
PP_EXPECT(h, nested_begin.code == StatusCode::invalid_argument);
auto invalid_blend = BlendState {};
invalid_blend.source_color = static_cast<BlendFactor>(255);
const auto invalid_blend_state = context.set_blend_state(invalid_blend);
PP_EXPECT(h, !invalid_blend_state.ok());
PP_EXPECT(h, invalid_blend_state.code == StatusCode::invalid_argument);
PP_EXPECT(h, context.set_blend_state(BlendState {
.enabled = true,
.source_color = BlendFactor::source_alpha,
.destination_color = BlendFactor::one_minus_source_alpha,
})
.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);
@@ -851,6 +946,10 @@ void recording_renderer_rejects_invalid_command_order_and_targets(pp::tests::Har
PP_EXPECT(h, !viewport_after_end.ok());
PP_EXPECT(h, viewport_after_end.code == StatusCode::invalid_argument);
const auto blend_after_end = context.set_blend_state(BlendState {});
PP_EXPECT(h, !blend_after_end.ok());
PP_EXPECT(h, blend_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);
@@ -939,6 +1038,7 @@ int main()
harness.run("computes_readback_byte_sizes", computes_readback_byte_sizes);
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_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);