sco_ui_v1.register_overlay

Catalogue snapshot — development preview

SDK 2.3.0 · game pack 0.6.0 · source e616ed69d8f9f77b0f4827881c86d91e4a7d1689 Published release: sdk-v2.3.0 (immutable approved assets; this development preview is not an approved release). Source-backed inventory is not a runtime or in-game verification claim.

Adds overlay id; overlays draw in registration order. SCO_BAD_ARG / SCO_TOO_MANY as for register_tab.

Limitations / unestablished guarantees

• Other recursive reentrancy unspecified.
• Additional failures/output state unspecified unless described in the buffer contract.

Signature

sco_result (*)(sco_plugin *, const char *, sco_ui_draw_fn, void *)

Service and availability

Service index

Property	Value
Symbol	sco_ui_v1.register_overlay
Record ID	sco-ui-v1-register-overlay
Service	sco.ui
Table	sco_ui_v1
Version macro	SCO_UI_VERSION_1_0
Packed table version	65536
Since / availability	size >= 40; 1.0
Complete member extent (x64 bytes)	40
Table size (x64 bytes)	80

Header source

Parameters and buffers

sco_result (*register_overlay)(sco_plugin* self, const char* id, sco_ui_draw_fn draw, void* ctx);
Adds overlay id; overlays draw in registration order. SCO_BAD_ARG / SCO_TOO_MANY as for register_tab.

Results and failures

Absent table: query_service NOT_FOUND; stopped self-taking methods: UNAVAILABLE; invalid/released self: BAD_ARG; allocation exceptions: TOO_MANY. Additional failures/output state unspecified unless described in the buffer contract.

Absent capability

Absent table: query_service NOT_FOUND

Ownership

Strings/arguments copied; draw/ctx borrowed until unregister/unload. Host owns registry; no allocation transfer.

Thread affinity

Any thread; draw callbacks game thread. Other recursive reentrancy unspecified.

Callback context

draw callbacks game thread.

Reentrancy

unspecified

Cleanup and cancellation

unregister_overlay/ordinary unload/non-retained crash cleanup ends draws; off-thread unregister does not join an already-running draw. Retained-provider faults skip owner resource-release hooks and require restart; backing resources remain retained, not safe for cached calls. Guarded draws stop, but snapshots and chord reservations remain.

Language mappings

Status labels are copied verbatim from the catalogue: direct is native access; typed-wrapper is wrapper-backed; restricted is a subset/adaptation; unsupported means no supported route is established. No status implies universal safety.

Language	Catalogue status	Source evidence / wrapper tokens
c	direct	include/sco_ui.h (*register_overlay)
cpp	typed-wrapper	include/scosdk/ui.hpp return detail::CanCall(t_, &sco_ui_v1::register_overlay) && detail::CanCall(t_, &sco_ui_v1::unregister_overlay) ? t_->register_overlay(self_, id, draw, ctx) : SCO_UNAVAILABLE;
csharp	typed-wrapper	sdk/csharp/Sco.Sdk/Ui.cs fixed (byte* i = Utf8.Z(id)) r = _t->register_overlay(Self, i, &DrawTrampoline, (void*)key);
lua	unsupported	docs/ui.md Scripts bind hotkeys; tabs and overlays need draw callbacks from Lua

Examples

None identified in the catalogue; this is not proof none can exist.

Tests

• tests/abi_ui.c
• tests/test_settings.cpp
• tests/test_ui.cpp
• sdk/csharp/Sco.Sdk.Tests/FakeHost.cs
• tools/test.sh
• sdk/csharp/Sco.Sdk.Tests/Layout.cs

ABI pins prove layout, not semantic behavior or a live game session.