Skip to main content

Module schema

Module schema

Expand description

Closed Rust-side schema and metadata used for Kotlin code generation.

Modules§

scroll_changed_flags: The bits of a ScrollChanged event’s flags word.
scroll_into_view_flags: The bit of a ScrollIntoView record’s flags.
scroll_target_kind: The values of a ScrollIntoView record’s target kind.
scroll_to_flags: The bits of a ScrollTo record’s flags word.

Structs§

Animation: One animation the Renderer plays to its end on its own frame clock, described once.
AnimationEvents: Which moments of an animation are reported back as AnimationEvents. None, the default, means the animation plays to its end without a single call to the Host.
BoundaryOp: One logical boundary operation, stated without saying which side calls it.
BoxProps
ButtonProps
Color
ColumnProps
EnumVariantSchema
EventSchema
FieldSchema
Keyframe
MessagePlacement: Where a transient message is drawn, for an application that wants a place other than the design system’s.
OverlayTokens: Application-level overlay theme tokens for Dialog, Menu, Dropdown, Sheet and the transient message. Every measure is in dp, and 0 keeps the design system’s own.
Rect: A rectangle in physical pixels, for ScrollTarget.
RoleEnumSchema: A role enum that codegen mirrors into Kotlin.
RowProps
ScrollIntoView: A request to bring a rectangle into view in one container, written by Batch::scroll_into_view.
ScrollTo: A request to scroll a container to an offset, written by Batch::scroll_to.
Selection
SpacerProps
TextFieldProps
TextProps
Theme: A design system choice plus how it reacts to the host platform.
TransformFunction: One CSS transform function: its kind and up to six values, the unused ones zero.
VariantSchema
WebBatchField: One field of the MutationBatch record the Host writes into the shared memory.
Window: What an application may decide about its own window.

Enums§

Constants§

ALIGNMENT_SCHEMA
ANDROID_BRIDGE_CLASS: The JVM class the Android shims bind to. The Kotlin file is generated under the same name, so the two sides cannot drift.
ANIMATED_PROPERTY_SCHEMA
ANIMATION_CONTROL_SCHEMA
ANIMATION_EVENT_KIND_SCHEMA
ARRANGEMENT_SCHEMA
ASSET_KIND_SCHEMA
BACKGROUND_REPEAT_SCHEMA
BOUNDARY_SCHEMA
BUTTON_KIND_SCHEMA
BUTTON_VARIANT_SCHEMA
CHROME_SCHEMA
COLOR_INTERPOLATION_SCHEMA
COLOR_ROLE_COUNT: How many colour roles there are, which is how many rows every token table has and how many slots a palette carries per scheme.
COLOR_ROLE_SCHEMA
COLOR_SCHEME_SCHEMA
COMPACT_NAVIGATION_SCHEMA
CONTENT_SCALE_SCHEMA
CURSOR_SCHEMA
DECORATION_KIND_SCHEMA
DESIGN_SYSTEM_SCHEMA
EDIT_GROUP_STATUS_SCHEMA
EVENT_SCHEMA
FILE_DELIVERY_SCHEMA
FILE_DIALOG_KIND_SCHEMA
FILE_DIALOG_STATUS_SCHEMA
FILE_OP_SCHEMA
FILL_MODE_SCHEMA
GENERIC_FAMILY_SCHEMA
GUTTER_DECORATION_KIND_SCHEMA
HORIZONTAL_ALIGNMENT_SCHEMA
HOVER_PHASE_SCHEMA
ICON_ROLE_SCHEMA
IO_STATUS_SCHEMA
KEY_SCHEMA
LAST_WINDOW_CLOSED_SCHEMA
MATERIAL_ROLE_SCHEMA
MAX_MODIFIER_WORDS: The most words any modifier’s value takes, the two every record has included.
MESSAGE_DURATION_SCHEMA
MESSAGE_HORIZONTAL_SCHEMA
MESSAGE_VERTICAL_SCHEMA
MINIMAP_SIDE_SCHEMA
MODIFIER_SCHEMA
MOTION_ROLE_SCHEMA
NOTIFICATION_IMPORTANCE_SCHEMA
NOTIFICATION_PERMISSION_SCHEMA
NOTIFICATION_PRESENTATION_SCHEMA
OVERFLOW_WRAP_SCHEMA
PLAYBACK_DIRECTION_SCHEMA
PLAY_STATE_SCHEMA
POINTER_KIND_SCHEMA
POINTER_TYPE_SCHEMA
POPOVER_ALIGN_SCHEMA
POPOVER_PLACEMENT_SCHEMA
PROPERTY_SCHEMA
PROTOCOL_VERSION
REDUCED_MOTION_SCHEMA
REVEAL_ALIGN_SCHEMA
ROLE_ENUM_SCHEMA: Every role enum codegen mirrors, in wire order. Appending is the only allowed edit.
SCHEMA_DESCRIPTOR: Canonical schema text. Variant order is wire-significant and must only be appended to.
SCHEMA_HASH: Stable handshake hash of the complete ordered schema metadata.
SEMANTICS_CHECKED_SHIFT: Where the checked field sits in Modifier::Semantics::state.
SEMANTICS_CLICK_ACTION_BIT: The bit that exposes a click action on the node.
SEMANTICS_DISABLED_SHIFT: Where the disabled field sits in Modifier::Semantics::state: 0 unset, 1 enabled, 2 disabled.
SEMANTICS_EXPANDED_SHIFT: Where the expanded field sits in Modifier::Semantics::state: 0 unset, 1 collapsed, 2 expanded.
SEMANTICS_FOCUSED_SHIFT: Where the focused field sits in Modifier::Semantics::state: 0 unset, 1 not focused, 2 focused.
SEMANTICS_FOCUS_ACTION_BIT: The bit that exposes a focus action on the node.
SEMANTICS_HIDDEN_BIT: The bit that excludes the node from the accessibility tree.
SEMANTICS_ROLE_SCHEMA
SEMANTICS_SELECTED_SHIFT: Where the selected field sits in Modifier::Semantics::state.
SEMANTICS_STATE_MASK: Every bit Modifier::Semantics::state may set.
SEVERITY_SCHEMA
SHAPE_ROLE_SCHEMA
SLOT_ROLE_SCHEMA
SNAP_SCHEMA
SPACE_ROLE_SCHEMA
STEP_POSITION_SCHEMA
STORAGE_OP_SCHEMA
SYSTEM_COLOR_SCHEME_SCHEMA
TEXT_ALIGN_SCHEMA
TEXT_OVERFLOW_SCHEMA
TILE_MODE_SCHEMA
TIMING_KIND_SCHEMA
TITLE_BAR_SCHEMA
TRANSFORM_FUNCTION_KIND_SCHEMA
TYPE_ROLE_COUNT: How many type roles there are, which is how many font slots a theme carries.
TYPE_ROLE_SCHEMA
USER_SELECT_SCHEMA
VERTICAL_ALIGNMENT_SCHEMA
WEB_BATCH_BYTES: How long that record is, including the padding #[repr(C)] adds before the result.
WEB_BATCH_FIELDS: MutationBatch as a wasm32 target lays it out.
WEB_EVENT_BUFFER_BYTES: How much room the Host lends the Renderer to encode one event into.
WEB_EVENT_BUFFER_MAX_BYTES: The largest event buffer the Host lends a browser Renderer.
WEB_EVENT_BUFFER_OFFSET: Where the event buffer starts inside the block compose_rust_host_web_start reports.
WEB_LEND_EVENT_BUFFER_SYMBOL: The Host export a browser Renderer borrows a larger event buffer from.
WEB_MODULE_GLOBAL: The global the loader module publishes the compiled Host module under.
WEB_RENDERER_IMPORT_MODULE: The wasm import module the Host’s frame request comes from.
WEB_RUST_REGION_BASE: The first address that belongs to the Rust module.
WEB_START_SYMBOL: The extra Host export a browser needs, because a page has no library loader.
WEB_TABLE_GLOBAL: The global the loader publishes the trampoline’s table under.
WHEEL_DELTA_MODE_SCHEMA
WIDGET_SCHEMA
WINDOW_HEIGHT_CLASS_SCHEMA
WINDOW_MODE_SCHEMA
WINDOW_SIZE_CLASS_SCHEMA
WORD_BREAK_SCHEMA
WORD_WRAP_MODE_SCHEMA

Functions§

corner_smoothing: The smoothing a CornerCurve value draws with: clamped to 0..=1, NaN as 0.
modifier_extra_words: The extra_words the schema gives a modifier tag, or None for a tag it does not list.