Create Shared Memory bridge
create_shared_memory_bridgeCreate a shared memory bridge for zero-copy IPC with external apps. Choose direction (in/out), kind (TOP/CHOP), and matching shared memory name.
Instructions
Create a Shared Memory In/Out TOP/CHOP for zero-copy IPC with another app on the same host (Notch, Unity, Unreal, custom tools). Pick direction ('in' to receive, 'out' to publish), kind (TOP for pixel buffers, CHOP for numeric channels), and a shmName that the peer must match exactly. After creating an Out variant, wire the producer TOP/CHOP into it with connect_nodes. When format.header=false the peer reads a raw headerless buffer — sizes must agree exactly or frames will garble. Some (direction, kind) combos are platform/build-dependent; the tool returns a friendly fatal if the optype isn't available.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| direction | Yes | 'in' = receive from an external app; 'out' = publish to an external app. | |
| kind | Yes | TOP = pixel buffer (RGBA frames); CHOP = numeric channels (control / audio-rate). | |
| shmName | Yes | Shared-memory segment name. Must match exactly on both sides. Two TDs using the same name will collide. | |
| parent | No | COMP path to create the operator in. | /project1 |
| name | No | Operator name; auto-generated when omitted (e.g. shm_in / shm_out). | |
| format | No | Optional format hints. Unknown / unsupported pars on this build become warnings. |