tiny.sdfii.ffi.Api

1const Self = @This();2const std = @import("std");34const Engine = @import("root.zig").internals.engine;5const ffi = @import("sdfii_ffi");6const types = ffi.types;7const allocator_policy = ffi.allocator_policy;8const Router = @import("sdfii_backend").router;9const UploadPlanner = @import("sdfii_backend").upload;10const low_level = @import("abi/root.zig").core;1112const abi_allocator = allocator_policy.exportedHandleAllocator();1314engine: *Engine,1516pub fn bind(engine: *Engine) Self {17    return .{18        .engine = engine,19    };20}2122pub fn worldStep(self: *const Self, commands: types.CommandBatch, input: types.FrameInput) types.StepResult {23    return self.engine.worldStep(commands, input);24}2526pub fn configureBehaviors(self: *const Self, request: types.BehaviorConfigRequest) !void {27    try self.engine.behavior.configureFromFfi(self.engine.allocator, request);28}2930pub fn submit(self: *const Self, commands: types.CommandBatch, input: types.FrameInput) types.StepResult {31    return self.worldStep(commands, input);32}3334pub fn issueQuery(self: *const Self, request: types.QueryRequest) types.QueryResult {35    const current = self.engine.currentPublishedScene();36    const published = current.ptr() orelse return .{};37    if (published.revision != request.compiled_revision or38        !self.engine.queries.isBoundTo(request.compiled_revision))39    {40        return .{};41    }42    return .{43        .compiled_revision = request.compiled_revision,44        .match_count = 0,45    };46}4748pub fn publishedRevision(self: *const Self) types.PublishedRevisionSummary {49    const current = self.engine.currentPublishedScene();50    const published = current.ptr() orelse return .{};51    return .{52        .compiled_revision = published.revision,53        .source_tick = published.view.source_tick,54        .entity_count = @as(u32, @intCast(published.view.entity_count)),55        .asset_count = @as(u32, @intCast(published.view.asset_count)),56        .fragment_count = @as(u32, @intCast(published.program_state.fragment_count)),57        .edit_fragment_count = @as(u32, @intCast(published.program_state.edit_fragment_count)),58        .overlap_region_count = @as(u32, @intCast(published.query_state.overlap_region_count)),59        .dirty_region_count = @as(u32, @intCast(published.query_state.dirtyRegionCountForRevision(published.revision))),60        .supports_field_queries = types.flagFromBool(published.query_state.supportsFieldQueries()),61    };62}6364pub fn queryAuthority(self: *const Self, compiled_revision: u64) types.QueryAuthoritySummary {65    const current = self.engine.currentPublishedScene();66    const summary = self.engine.queries.describeBinding(67        if (current.has_value) current.value else null,68        compiled_revision,69    );70    return .{71        .requested_revision = summary.requested_revision,72        .published_revision = summary.published_revision,73        .bound_revision = summary.bound_revision,74        .revision_matches = types.flagFromBool(summary.revision_matches),75        .query_bound = types.flagFromBool(summary.query_bound),76        .supports_field_queries = types.flagFromBool(summary.supports_field_queries),77    };78}7980pub fn sdfii_abi_version() u32 {81    return 8;82}8384test "abi version records direct typed boundary" {85    try std.testing.expectEqual(@as(u32, 8), sdfii_abi_version());86}8788pub fn sdfii_engine_core_create(limits: ?*const types.EngineLimits) ?*Engine {89    const requested = limits orelse return null;90    if (requested.reserved != 0) return null;91    const engine = abi_allocator.create(Engine) catch return null;92    engine.* = Engine.initFallible(abi_allocator, .{93        .entity_capacity = requested.entity_capacity,94        .physics_scratch = .{ .program_nodes = requested.physics_program_nodes },95        .ui = .{96            .surfaces = requested.ui_surfaces,97            .surface = .{98                .nodes = requested.ui_nodes_per_surface,99                .runs = requested.ui_text_runs_per_surface,100                .styles = requested.ui_text_styles_per_surface,101                .semantic_bytes = requested.ui_semantic_bytes_per_surface,102            },103        },104    }) catch {105        abi_allocator.destroy(engine);106        return null;107    };108    return engine;109}110111pub fn sdfii_engine_core_destroy(engine: ?*Engine) void {112    if (engine) |value| {113        value.deinit();114        abi_allocator.destroy(value);115    }116}117118pub fn sdfii_engine_core_world_step(119    engine: ?*Engine,120    commands: *const types.CommandBatch,121    input: *const types.FrameInput,122    out: *types.StepResult,123) c_int {124    const e = engine orelse return low_level.SDFII_ERR_NULL_HANDLE;125    const api = bind(e);126    out.* = api.worldStep(commands.*, input.*);127    return 0;128}129130pub fn sdfii_engine_core_configure_behaviors(131    engine: ?*Engine,132    request: *const types.BehaviorConfigRequest,133) c_int {134    const e = engine orelse return low_level.SDFII_ERR_NULL_HANDLE;135    const api = bind(e);136    api.configureBehaviors(request.*) catch return -1;137    return 0;138}139140pub fn sdfii_engine_core_backend_select(141    request: *const types.BackendSelectionRequest,142    out: *types.BackendSelectionResult,143) c_int {144    out.* = Router.previewBackendSelection(request.*);145    return 0;146}147148pub fn sdfii_engine_core_render_route(149    request: *const types.RenderRouteRequest,150    out: *types.RenderRouteResult,151) c_int {152    out.* = Router.chooseRenderRoute(request.*);153    return 0;154}155156pub fn sdfii_engine_core_field_query_route(157    request: *const types.FieldQueryRouteRequest,158    out: *types.FieldQueryRouteResult,159) c_int {160    out.* = Router.chooseFieldQueryRoute(request.*);161    return 0;162}163164pub fn sdfii_engine_core_failure_fallback(165    request: *const types.FallbackRequest,166    out: *types.FallbackResult,167) c_int {168    out.* = Router.chooseFailureFallback(request.*);169    return 0;170}171172pub fn sdfii_engine_core_render_plan(173    request: *const types.RenderPlanRequest,174    out: *types.RenderPlanResult,175) c_int {176    out.* = Router.renderPlan(request.*);177    return 0;178}179180pub fn sdfii_engine_core_plan_upload(181    request: *const types.UploadPlanRequest,182    out: *types.UploadPlanResult,183) c_int {184    out.* = UploadPlanner.preview(request.*);185    return 0;186}187188test "backend planner ffi honors caller-provided availability snapshots" {189    const summary = types.CompiledArtifactSummary{190        .compiled_revision = 2,191        .node_count = 4,192        .material_count = 1,193        .light_count = 1,194        .root_node = 3,195        .execution_ir_version = 2,196        .native_payload_version = 2,197        .supports_graphics_output = 1,198        .supports_field_queries = 1,199    };200    const availability = types.BackendAvailability{201        .zig_cpu_available = 1,202        .accy_available = 1,203    };204205    var selection: types.BackendSelectionResult = .{};206    try std.testing.expectEqual(@as(c_int, 0), sdfii_engine_core_backend_select(&.{207        .summary = summary,208        .availability = availability,209    }, &selection));210    try std.testing.expectEqual(@backingInt(types.BackendKind.accy), selection.selected_backend);211212    var field_query: types.FieldQueryRouteResult = .{};213    try std.testing.expectEqual(@as(c_int, 0), sdfii_engine_core_field_query_route(&.{214        .summary = summary,215        .availability = availability,216        .backend = selection.selected_backend,217    }, &field_query));218    try std.testing.expectEqual(@backingInt(types.BackendKind.accy), field_query.query_backend);219    try std.testing.expectEqual(@backingInt(types.FieldQueryRouteReason.native_distance_sampling), field_query.reason);220221    var route: types.RenderRouteResult = .{};222    try std.testing.expectEqual(@as(c_int, 0), sdfii_engine_core_render_route(&.{223        .summary = summary,224        .availability = availability,225        .backend = selection.selected_backend,226        .graphics_requested = 1,227    }, &route));228    try std.testing.expectEqual(@backingInt(types.RenderRoute.graphics_fast_path), route.route);229230    var upload: types.UploadPlanResult = .{};231    try std.testing.expectEqual(@as(c_int, 0), sdfii_engine_core_plan_upload(&.{232        .summary = summary,233        .availability = availability,234        .backend = selection.selected_backend,235    }, &upload));236    try std.testing.expectEqual(@backingInt(types.UploadPlanMode.full), upload.mode);237}

1pub const Api = api;