Expand description
Preview protocol for oxframe.
Status: oxframe is under very active development. The API is not stable yet and may change from version to version. Pin the exact version in your Cargo.toml and check the changelog before upgrading.
Session implements the editor protocol (oxframe-protocol) on top of
any PreviewEngine and is independent of the transport:
- natively,
serverexposes it over a WebSocket on127.0.0.1(frames are JPEG-encoded and cached); - in the browser, the same session runs inside wasm and frames go to a canvas as raw RGBA.
Modules§
- server
- Native preview server: WebSocket on
127.0.0.1, protocol JSON for commands/events, binary frames (16-byte header + JPEG).
Structs§
Enums§
- Meta
Edit - An edit of a scene’s
meta.jsonrequested by the editor. - Output
- A message for the UI: JSON event or binary frame.
Traits§
- Preview
Engine - What the preview needs from an engine, on top of drawing frames
(
FrameSource). Implemented byoxframe::PreviewAdapter.
Functions§
- rgba_
encoder - Raw RGBA “encoding” (in-process transports, tests).
Type Aliases§
- Encoder
- Encodes a rendered frame for the wire.