ABI, errors & capabilities

ABI contract

• GX3DE_ABI_VERSION is 1 in dev-40.
• Public numeric fields use fixed-width C integer types and double.
• Descriptor/query structs are size-tagged through struct_size; initialize it to sizeof(struct).
• Boundary strings and paths are UTF-8.
• No C++, VTK, OpenGL, X11, Win32, Tk or POSIX structure crosses the public ABI.
• Output handles from creation functions are valid only when the function returns GX3DE_OK.

Result codes

Use gx3de_result_name() for the stable textual name; for renderer failures also query gx3de_target_render_diagnostics().

Capability discovery

Call gx3de_get_info() for ABI version and the original capability words. The first 64 feature bits are fully allocated. In ABI v1 the second capability word is stored in gx3de_info.reserved[0]. For newer grouped discovery use gx3de_get_capabilities(api_group,...), which returns up to four 64-bit words for CORE, renderer, animation or field groups.

gx3de_info info = {.struct_size = sizeof info};
if (gx3de_get_info(&info) != GX3DE_OK || info.abi_version != GX3DE_ABI_VERSION)
    return 1;

if (!(info.reserved[0] & GX3DE_CAP2_SCIENTIFIC_DIRECT_COLOR))
    /* fall back to scalar/object coloring */;

gx3de_capability_set caps = {.struct_size = sizeof caps};
if (gx3de_get_capabilities(GX3DE_API_GROUP_ANIMATION, &caps) == GX3DE_OK &&
    caps.api_version == GX3DE_ANIMATION_API_VERSION &&
    (caps.words[0] & GX3DE_ANIM_CAP_MULTILAYER)) {
    /* multilayer timeline path */
}

dev-40 capability additions

All engine capability bits