Skip to main content

Module prelude

Module prelude 

Source
Expand description

Rust-owned source and reference metadata for declarations imported by every program.

These schemas describe nominal interpreter crate::RecordValue values. They are not aliases for Rust SDK structs: adapters decide which component schemas they consume. Keeping each declaration beside its documentation makes the parser input, rustdoc, and website reference one source of truth.

Constants§

AUDIO
An audio resource request with a gain value.
AUDIO_BLOCK
Decoded audio samples with a checked sample rate.
AUDIO_STREAM
A live audio input request with a gain value.
BOX
An axis-aligned local box with full dimensions.
BUTTON
A host-rendered control with a typed no-argument action.
CLICK
A typed interaction contract with one click operation.
CYLINDER
A cylinder aligned with local Y.
FORCE
A world-space force applied every fixed physics tick.
IMAGE
An image resource request with display dimensions.
IMAGE_FRAME
Decoded byte pixels with an explicit channel axis.
IMPULSE
A world-space impulse consumed once by physics reconciliation.
LINE
A line segment between two local positions.
MATERIAL
Surface appearance for geometry rendered by the spatial adapter.
MESH
Indexed triangle geometry.
POINT_CLOUD
A bounded set of points rendered with a shared radius.
PRELUDE
Concatenated parser input for the documented prelude declarations.
QUAD
A rectangular local XY surface facing local +Z.
RAY
A visual ray with an explicit finite length.
RENDER
A typed presentation contract with one render operation.
RIGID_BODY
Physical-body configuration for a Sphere or Box entity.
SLIDER
A host-rendered numeric control with a typed value action.
SPHERE
A sphere centered at its entity origin.
TEXT
Visible text content represented as a host UI schema.
TRANSFORM
Local pose and scale for an entity.
VEC3
A three-component numeric vector with zero defaults.
VIDEO
A video resource request with display dimensions.
VIDEO_CLIP
An immutable-value sequence of validated decoded video frames.
VIDEO_FRAME
A decoded image associated with a presentation timestamp.
VIDEO_STREAM
A live video input request with display dimensions.