CmdRealmCreate
Creates a new realm.
Realms represent renderable contexts (3D/2D). They can later be bound to
logical targets through CmdTargetLayerUpsert to form the auto-graph.
Arguments
| Field | Type | Description |
|---|---|---|
| kind | RealmKind | Realm kind (three-d or two-d) |
| outputSurfaceId | Option |
(Optional) Explicit output surface ID (rare; usually omitted) |
| hostWindowId | Option |
(Optional) Host window ID for default realm association |
| importance | Option |
(Optional) Scheduling priority (default: 1) |
| cachePolicy | Option |
(Optional) Cache policy (default: 0) |
| flags | Option |
(Optional) Realm flags (reserved) |
Response
Returns CmdResultRealmCreate:
| Field | Type | Description |
|---|---|---|
| success | bool | Whether the realm was created |
| message | String | Status or error message |
| realmId | Option |
ID of the created realm |
Validation Rules
- If
hostWindowIdis provided, it must reference an existing window. - If
outputSurfaceIdis provided, it must reference an existing surface.
When validation fails:
- command response returns
success = false - host also receives
SystemEvent::Error(scope = "command").
Documentation Vulfram Core