Crate pax_runtime_api

Expand description

Public runtime API types shared across Pax crates, user components, and platform backends.

Most names are reexported at the crate root for compatibility, while their source modules provide the browsing ontology used by the generated API docs.

Re-exports§

pub use async_runtime::AsyncError;
pub use async_runtime::AsyncLimits;
pub use async_runtime::AsyncScope;
pub use async_runtime::Closed;
pub use async_runtime::Completion;
pub use async_runtime::GuardedPublisher;
pub use async_runtime::TaskControl;
pub use async_runtime::TaskOutcome;
pub use async_runtime::TaskStatus;
pub use async_runtime::TrySendError;
pub use async_runtime::UiSender;
pub use async_runtime::UiSubscription;
pub use application_shutdown::ShutdownComplete;
pub use application_shutdown::ShutdownTicket;
pub use application::AppClosed;
pub use application::AppContext;
pub use application::AppOptions;
pub use application::AppPhase;
pub use application::AppResult;
pub use application::InitContext;
pub use application::StopReason;
pub use application::HOST_MESSAGE_LIMIT;
pub use pax_value::numeric::Numeric;
pub use pax_value::CoercionRules;
pub use pax_value::ImplToFromPaxAny;
pub use pax_value::PaxValue;
pub use pax_value::ToPaxValue;
pub use pax_value::functions;
pub use pax_value::functions::register_function;
pub use pax_value::functions::Functions;
pub use pax_value::functions::HelperFunctions;
pub use properties::LocalProperty;
pub use properties::Property;
pub use properties::PropertyBinding;
pub use properties::PropertyGraph;
pub use properties::Published;
pub use paste;
pub use pax_message::serde;
pub use animation::*;
pub use color::*;
pub use drawing::*;
pub use events::*;
pub use layout::*;
pub use platform::*;
pub use rendering::*;
pub use store::*;
pub use transform::*;
pub use unit_value::*;
pub use variables::*;

Modules§

animation: Animation primitives: interpolation, easing curves, transition queues, and timelines. See also: properties.ease_to and properties.ease_to_later.
application: Root initialization and application lifetime, independent of any async executor.
application_shutdown: Retained asynchronous resource cleanup with UI-thread ownership and host wakeups.
async_runtime: Executor-neutral task lifetimes and bounded delivery to the UI thread.
color: Color and opacity types used by Pax style properties and render backends.
constants: Compiler-facing type and property spelling constants.
cursor
drawing: Vector drawing primitives: paths, fills, strokes, caps, and gradients.
events: Event payloads and cancellation wrappers passed to Pax event handlers.
http_api: Shared request and response types for Pax’s public HTTP service.
layout: Layout units, axes, and common properties shared by renderable nodes.
math
pax_value
platform: Platform, viewport, and coordinate-space marker types.
properties
refcell_debug
reflection
rendering: Rendering backend contracts and helpers for drawing Pax scene content.
serde: Serde
store: Typed stores owned by mounted nodes and discovered through NodeContext.
transform: Rotation and 2D transform types used by layout and rendering.
unit_value: Normalized unit-domain values.
variables: LocalProperty adapters that expose runtime values to expression scopes.

Macros§

borrow
borrow_mut
impl_default_coercion_rule: Implements coercion by converting the selected PaxValue variant’s contents. The optional third argument opts into CoercionRules::is_identity_roundtrip; omit it unless the type satisfies that method’s exact, side-effect-free contract.
impl_to_pax_value
use_RefCell

Structs§

AccelInterruptArgs: Device acceleration payload, in meters per second squared.
AddedLayerArgs: Chassis acknowledgement that render layers were added.
AnyCreatePatch: Common creation payload shared by native element families.
AppleLiquidGlassPatch: Apple-specific native liquid-glass effect payload.
BrowserConfigInterruptArgs: Browser capability flags discovered by the web chassis.
ButtonPatch: Create/update patch for a native button.
ChassisResizeRequestArgs: Chassis response containing measured native control bounds.
CheckboxPatch: Create/update patch for a native checkbox.
CheckboxStyleMessage: Style payload shared by checkbox-like controls.
ClickInterruptArgs: Click interrupt payload.
ContextMenuInterruptArgs: Context-menu interrupt payload.
DoubleClickInterruptArgs: Double-click interrupt payload.
DropFileArgs: File-drop interrupt payload.
DropdownPatch: Create/update patch for a native dropdown/select element.
EventBlockerPatch: Create/update patch for a native hit-test blocker with an optional solid background.
FocusInterruptArgs: Focus interrupt marker payload.
FormButtonClickArgs: Native button click payload.
FormCheckboxToggleArgs: Checkbox state-change interrupt payload.
FormDropdownChangeArgs: Dropdown selection-change payload.
FormRadioListChangeArgs: Radio-list selection-change payload.
FormSliderChangeArgs: Slider value-change payload.
FormTextboxChangeArgs: Textbox committed-value change payload.
FormTextboxInputArgs: Textbox in-progress input payload.
FramePatch: Create/update patch for a native frame host.
GlassSurfacePatch: Create/update patch for a materialized native liquid-glass surface.
GyroInterruptArgs: Device orientation payload, in degrees.
ImageDataArgs: Image-load payload carrying image metadata without a byte pointer.
ImagePatch: Image-load request sent to the chassis.
ImagePointerArgs: Image-load payload carrying a pointer to chassis-owned image bytes.
InterruptBuffer: Raw FFI buffer containing serialized interrupts.
KeyDownInterruptArgs: Key-down interrupt payload.
KeyPressInterruptArgs: Key-press interrupt payload.
KeyUpInterruptArgs: Key-up interrupt payload.
LayerSurfaceScreenshotData: Completed screenshot bytes for one physical surface within a logical canvas layer.
LinkStyleMessage: Serializable style payload for link text.
LocalFontMessage: Local bundled font payload.
MaskPathPatch: One vector coverage path entry for a native occlusion mask.
MessageQueue: Serializable batch of native messages emitted for one runtime tick.
MouseDownInterruptArgs: Mouse-down interrupt payload.
MouseMoveInterruptArgs: Mouse-move interrupt payload.
MouseOutInterruptArgs: Mouse-out interrupt payload.
MouseOverInterruptArgs: Mouse-over interrupt payload.
MouseUpInterruptArgs: Mouse-up interrupt payload.
NativeCullPatch: Advisory native-view residency changes from the shared geometry index. The macOS host retains models and view instances, and may keep a cold view attached to preserve editing, selection, overflow, or accessibility.
NativeImagePatch: Create/update patch for a native image element.
NativeMaskPatch: Create/update patch for a native occlusion mask surface.
NativeMessageQueue: Raw FFI buffer containing serialized native messages.
NavigationPatch: Request for the chassis to navigate to a URL.
PhotoPickerAssetArgs: Selected image metadata and optional copied bytes from a native photo picker.
PhotoPickerInterruptArgs: Native photo picker completion payload.
PhotoPickerPatch: Create/update patch for a transparent native photo picker hit target.
RadioListPatch: Create/update patch for a native radio list.
RenderSurfaceUpdateArgs: Browser notification that a retained render surface must be reconfigured.
RouteChangeInterruptArgs: Canonical route-location payload pushed from chassis state into the runtime.
SafeAreaInsets: Insets of the platform’s safe rectangle, in logical window pixels.
ScreenshotData: Completed screenshot bytes returned by the chassis.
ScreenshotPatch: Request to capture a screenshot from the chassis.
ScrollInterruptArgs: Location-targeted scroll delta payload.
ScrollerPatch: Create/update patch for a native/browser-owned scroller.
ScrollerPositionInterruptArgs: Native scroller position payload, including optional presentation offsets.
SelectStartArgs: Selection-start interrupt marker payload.
SetCursorPatch: Request for the chassis to update cursor style.
SliderPatch: Create/update patch for a native slider.
SystemFontMessage: System font family payload.
TapInterruptArgs: Single-touch tap payload normalized to window coordinates.
TextInputArgs: Raw text input payload delivered by a native text control.
TextMeasurementResponseArgs: Chassis response to an engine-authored native text measurement request.
TextPatch: Create/update patch for native or browser-managed text.
TextStyleMessage: Serializable text style payload shared with chassis text renderers.
TextboxPatch: Create/update patch for a native textbox.
TouchCancelInterruptArgs: Touch-cancel interrupt payload.
TouchEndInterruptArgs: Touch-end interrupt payload.
TouchMessage: One touch point in a multi-touch interrupt.
TouchMoveInterruptArgs: Touch-move interrupt payload.
TouchStartInterruptArgs: Touch-start interrupt payload.
ViewportResizeArgs: Layout viewport resize payload for the root app surface.
VisualViewportUpdateArgs: Browser visual viewport payload for page-scroll-backed root scrollers.
WebFontMessage: Web font payload, including family and source URL.
WheelInterruptArgs: Wheel interrupt payload.
YoutubeVideoPatch: Create/update patch for an embedded YouTube video.

Enums§

ColorMessage: Serializable color payload for native/chassis messages.
FontPatch: Serializable font selection payload.
FontStyleMessage: Serializable font-style value.
FontWeightMessage: Serializable font-weight value.
ImageLoadInterruptArgs: Image-load response, either by pointer or copied metadata.
ModifierKeyMessage: Normalized keyboard modifier identifier.
MouseButtonMessage: Normalized mouse button identifier.
NativeInterrupt: Events and data packets sent from the chassis back into the Pax runtime.
NativeMessage: Messages emitted by the runtime to create, update, delete, or configure native/chassis resources.
TextAlignHorizontalMessage: Serializable horizontal text alignment.
TextAlignVerticalMessage: Serializable vertical text alignment.

Crate pax_runtime_api

Crate pax_runtime_api Copy item path

Re-exports§

Modules§

Macros§

Structs§

Enums§

Crate pax_runtime_api