Skip to main content

Module api

Module api 

Source

Modules§

animation
Animation primitives: interpolation, easing curves, transition queues, and timelines. See also: properties.ease_to and properties.ease_to_later.
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
paste
github crates-io docs-rs
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
Store marker traits for runtime-managed state.
transform
Rotation and 2D transform types used by layout and rendering.
unit_value
Normalized unit-domain values.
variables
Property 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§

Accel
Current device acceleration, in meters per second squared.
AccelInterruptArgs
Device acceleration payload, in meters per second squared.
AddedLayerArgs
Chassis acknowledgement that render layers were added.
AlphaMaskPaint
One vector paint contributing alpha to a mask, in local path coordinates. Color channels do not affect coverage; fill alpha and opacity are multiplied.
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.
ButtonClick
User activates a native button by click or tap.
ButtonPatch
Create/update patch for a native button.
ChassisResizeRequestArgs
Chassis response containing measured native control bounds.
CheckboxChange
User checks or unchecks a checkbox.
CheckboxPatch
Create/update patch for a native checkbox.
CheckboxStyleMessage
Style payload shared by checkbox-like controls.
Click
User activates an element with a mouse click or single-touch tap.
ClickInterruptArgs
Click interrupt payload.
CommonProperties
Properties shared by every renderable Pax node.
CommonProperty
ContextMenu
User right-clicks an element to open the context menu.
ContextMenuInterruptArgs
Context-menu interrupt payload.
Depth
Logical scene depth for lighting calculations.
DoubleClick
User double-clicks a mouse button over an element.
DoubleClickInterruptArgs
Double-click interrupt payload.
Drop
User drops a file-like payload over an element.
DropFileArgs
File-drop interrupt payload.
DropdownPatch
Create/update patch for a native dropdown/select element.
Event
Event wrapper passed to Pax event handlers.
EventBlockerPatch
Create/update patch for a native hit-test blocker with an optional solid background.
Focus
Window or component focused.
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.
Functions
Registry bootstrap for built-in PAXEL helper functions.
GlassSurfacePatch
Create/update patch for a materialized native liquid-glass surface.
GradientStop
A color stop for a gradient fill, defined by a position (% or px) and a color.
Gyro
Current device orientation reported by a gyroscope/orientation sensor.
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.
KeyDown
User is pressing a key.
KeyDownInterruptArgs
Key-down interrupt payload.
KeyPress
User presses a key that displays a character (alphanumeric or symbol).
KeyPressInterruptArgs
Key-press interrupt payload.
KeyUp
User has released a key.
KeyUpInterruptArgs
Key-up interrupt payload.
KeyboardEventArgs
Common properties in keyboard events.
LayerSurfaceScreenshotData
Completed screenshot bytes for one physical surface within a logical canvas layer.
LinearGradient
Describes a linear gradient fill with a start and end point, and a list of color stops.
LinkStyleMessage
Serializable style payload for link text.
LocalFontMessage
Local bundled font payload.
MaskPathPatch
One vector coverage path entry for a native occlusion mask.
MaterialParams
Tunable response parameters for a light-reactive vector material.
MessageQueue
Serializable batch of native messages emitted for one runtime tick.
MouseDown
User presses a mouse button over an element.
MouseDownInterruptArgs
Mouse-down interrupt payload.
MouseEventArgs
Common properties in mouse-backed events and normalized activation events.
MouseMove
User moves the mouse while it is over an element.
MouseMoveInterruptArgs
Mouse-move interrupt payload.
MouseOut
User moves the mouse away from an element.
MouseOutInterruptArgs
Mouse-out interrupt payload.
MouseOver
User moves the mouse onto an element.
MouseOverInterruptArgs
Mouse-over interrupt payload.
MouseUp
User releases a mouse button over an element.
MouseUpInterruptArgs
Mouse-up interrupt payload.
NativeImagePatch
Create/update patch for a native image element.
NativeLiquidGlassScope
Runtime-inherited Apple liquid-glass effect scope.
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.
NodeContext
Runtime context passed into user component lifecycle methods and event handlers.
Percent
Raw Percent type, which we use for serialization and dynamic traversal. At the time of authoring, this type is not used directly at runtime, but is intended for into coercion into downstream types, e.g. ColorChannel, Rotation, and Size. This allows us to be “dumb” about how we parse %, and allow the context in which it is used to pull forward a specific type through into inference.
PhotoPickerAssetArgs
Selected image metadata and optional copied bytes from a native photo picker.
PhotoPickerChange
Native photo picker completion event.
PhotoPickerInterruptArgs
Native photo picker completion payload.
PhotoPickerPatch
Create/update patch for a transparent native photo picker hit target.
PhotoPickerPhoto
One selected image returned by a native photo picker.
Property
A reactive value node in Pax’s property graph.
RadialGradient
Describes a radial gradient fill with a start and end point, a radius, and a list of color stops.
RadioListPatch
Create/update patch for a native radio list.
RenderSurfaceUpdateArgs
Browser notification that a retained render surface must be reconfigured.
ReplayCanvasLayerUpdate
Replay invalidation for one logical canvas layer.
RouteChangeInterruptArgs
Canonical route-location payload pushed from chassis state into the runtime.
SceneAmbientLight
Resolved ambient light for one logical canvas layer.
SceneLight
Resolved light contribution for one logical canvas layer.
SceneLighting
Resolved lighting state for one logical canvas layer.
ScreenshotData
Completed screenshot bytes returned by the chassis.
ScreenshotPatch
Request to capture a screenshot from the chassis.
Scroll
Scroll is the shared delta-based path for wheel scrolling, touch swipe gestures, and read-only native scroller position changes. Use Wheel or TouchMove when you need platform-specific details instead of the normalized delta stream.
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.
SelectStart
A native text selection is beginning.
SelectStartArgs
Selection-start interrupt marker payload.
SetCursorPatch
Request for the chassis to update cursor style.
SliderChange
User changes a slider’s value.
SliderPatch
Create/update patch for a native slider.
Stroke
Describes the outline drawn around vector geometry.
SystemFontMessage
System font family payload.
TapInterruptArgs
Single-touch tap payload normalized to window coordinates.
TargetInfo
Derived target facts exposed to PAXEL and Rust event handlers.
TextInput
User types into a text input field.
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.
TextboxChange
User changes the text in a text input field.
TextboxInput
Text input reported while the user edits a textbox.
TextboxPatch
Create/update patch for a native textbox.
Timeline
Minimal timeline state used by animation-oriented controls.
Touch
Represents a single touch event.
TouchCancel
A TouchCancel occurs when the platform aborts an active touch sequence before normal release, such as during a system interruption or host-level gesture cancellation.
TouchCancelInterruptArgs
Touch-cancel interrupt payload.
TouchEnd
A TouchEnd occurs when the user stops touching an element. The contained touches represent a list of touch points and the event targets, then releases, the node captured at touch start.
TouchEndInterruptArgs
Touch-end interrupt payload.
TouchMessage
One touch point in a multi-touch interrupt.
TouchMove
A TouchMove occurs when the user moves while touching an element. The contained touches represent a list of touch points and the event targets the node captured at touch start, even when the point has moved outside its bounds.
TouchMoveInterruptArgs
Touch-move interrupt payload.
TouchStart
A TouchStart occurs when the user touches an element. The contained touches represent a list of touch points. The hit node is captured for the touch identifier so subsequent move and end events keep routing to the same subtree.
TouchStartInterruptArgs
Touch-start interrupt payload.
Transform2D
A sugared representation of an Affine transform combined with an anchor layout property.
TransitionManager
TransitionQueueEntry
Variable
Runtime property adapter used by expression scopes.
Vector3
A three-dimensional vector in logical scene space.
Viewport
Struct representing the outermost viewport of a rendering scene, for example a browser window or native application window.
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.
Wheel
User scrolls the mouse wheel over an element.
WheelInterruptArgs
Wheel interrupt payload.
Window
Phantom coordinate space representing the outer window.
YoutubeVideoPatch
Create/update patch for an embedded YouTube video.

Enums§

Axis
Model of 2D cartesian axes, used to disambiguate calculations that depend on axis direction (e.g. width vs height)
Color
Entrypoint for specifying and representing colors in Pax.
ColorChannel
Describes a color channel in a unit appropriate to the surrounding color model.
ColorMessage
Serializable color payload for native/chassis messages.
Duration
A duration used by animation and transition systems.
EasingCurve
Pre-built easing curves for use in transitions, as well as a Custom variant that can be used to specify an arbitrary easing curve via a function f: f64 -> f64 mapping a time on the unit interval to a multiplier on the unit interval.
Fill
Describes how to fill vector geometry.
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.
Layer
Render layer selected for a primitive or native surface.
LayoutRole
Controls whether a node participates in parent layout measurement.
LightShape
Shape of a light contribution in logical scene space.
Material
Light-reactive surface response for vector primitives.
ModifierKey
The variants of modifier keys available on keyboard-supporting platforms.
ModifierKeyMessage
Normalized keyboard modifier identifier.
MouseButton
The variants of mouse buttons available on mouse-supporting platforms.
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.
NavigationTarget
Describes where to open new windows or tabs when navigating to a URL from a Link node.
Numeric
Numeric type wrapper for PAXEL and runtime polymorphic numeric operations. This broad polyfill specifically enables terse numeric operations within expressions, without the overhead of explicit typing or numeric microsyntax.
OS
Describes known operating systems / targets.
Opacity
Describes an opacity value either as normalized alpha or as a percent.
PathElement
Describes a single element of a vector path, such as a line, a point, or curve segment.
PathSmoothing
Controls optional curve smoothing for path geometry before tessellation.
PaxValue
Runtime container for polymorphic values, for evaluating PAXEL.
PhotoPickerSourceKind
Platform source used to produce a selected photo.
PhotoPickerStatus
Completion status for a native photo picker request.
Platform
Describes categories of known platforms, for differentiating certain engine behaviors.
Rotation
Encodes a rotation in various units
Size
A spatial size value that can be either a concrete pixel value like 25px, a percent of parent bounds like 50%, or an additive/subtractive combination of the two like (100% - 10px).
StrokeCap
Controls how an open stroke terminates at the exposed endpoints of a path.
StrokeJoin
Controls how stroke segments are joined at path vertices.
TextAlignHorizontalMessage
Serializable horizontal text alignment.
TextAlignVerticalMessage
Serializable vertical text alignment.
UnitValue
A scalar value in a normalized unit domain.

Traits§

CoercionRules
Attempts to coerce a dynamic PaxValue into a concrete Rust type.
HelperFunctions
Registers helper functions made available to PAXEL scopes.
ImplToFromPaxAny
Marker trait for types that can be stored inside PaxAny without a built-in PaxValue representation.
Interpolatable
Marks a value as able to participate in Pax property transitions.
RenderContext
The Pax render trait, used as a layer of indirection and contract for backend-agnostic rendering.
Store
Marker trait for types that can be inserted into a Pax local store.
ToPaxValue
Converts a Rust value into its built-in PaxValue representation.

Functions§

bez_path_to_svg_path_data
Convert a kurbo BezPath to a SVG-friendly drawing string
bound
register_function