Expand description
Closed Rust-side schema and metadata used for Kotlin code generation.
Structs§
- Animation
- One animation the Renderer plays to its end on its own frame clock, described once.
- Animation
Events - 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. - Boundary
Op - One logical boundary operation, stated without saying which side calls it.
- BoxProps
- Button
Props - Color
- Column
Props - Enum
Variant Schema - Event
Schema - Field
Schema - Keyframe
- Role
Enum Schema - A role enum that codegen mirrors into Kotlin.
- RowProps
- Selection
- Spacer
Props - Text
Field Props - Text
Props - Theme
- A design system choice plus how it reacts to the host platform.
- Transform
Function - One CSS transform function: its kind and up to six values, the unused ones zero.
- Variant
Schema - WebBatch
Field - One field of the
MutationBatchrecord the Host writes into the shared memory. - Window
- What an application may decide about its own window.
Enums§
- Alignment
- Animated
Property - Animation
Control - Animation
Event Kind - Arrangement
- Asset
Kind - Boundary
Param - One argument of a boundary operation.
- Button
Kind - Button
Variant - Chrome
- Color
Interpolation - Color
Role - Color
Scheme - Cursor
- Decoration
Kind - Design
System - Event
Payload - Event
Payload Type - Field
Slot - Which half of which
u64word of a modifier’s value a field occupies. - Field
Type - Fill
Mode - Generic
Family - Gutter
Decoration Kind - Hover
Phase - Icon
Role - Key
- Keyframe
Value - What one keyframe holds, which has to be what its animation’s property takes.
- Loop
Mode - Material
Role - Message
Duration - Modifier
- Motion
Role - Notification
Importance - Notification
Permission - Notification
Presentation - Overflow
Wrap - Paint
- Every place that takes a colour takes a
Paint, so colour is expressed once. - Play
State - Playback
Direction - Pointer
Kind - Pointer
Type - Property
Kind - Reduced
Motion - Reveal
Align - Severity
- Shape
Role - Slot
Role - Space
Role - Step
Position - Text
Align - Text
Overflow - Tile
Mode - Timing
- The timing function of one keyframe, which shapes the segment to the next one.
- Timing
Kind - Title
Bar - Transform
Function Kind - Type
Role - User
Select - Wheel
Delta Mode - Widget
Kind - Window
Height Class - Window
Size Class - Word
Break
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 - 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 - CURSOR_
SCHEMA - DECORATION_
KIND_ SCHEMA - DESIGN_
SYSTEM_ SCHEMA - EVENT_
SCHEMA - FILL_
MODE_ SCHEMA - GENERIC_
FAMILY_ SCHEMA - GUTTER_
DECORATION_ KIND_ SCHEMA - HOVER_
PHASE_ SCHEMA - ICON_
ROLE_ SCHEMA - KEY_
SCHEMA - MATERIAL_
ROLE_ SCHEMA - MAX_
MODIFIER_ WORDS - The most words any modifier’s value takes, the two every record has included.
- MESSAGE_
DURATION_ 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 - 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.
- SEVERITY_
SCHEMA - SHAPE_
ROLE_ SCHEMA - SLOT_
ROLE_ SCHEMA - SPACE_
ROLE_ SCHEMA - STEP_
POSITION_ 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 - WEB_
BATCH_ BYTES - How long that record is, including the padding
#[repr(C)]adds before the result. - WEB_
BATCH_ FIELDS MutationBatchas 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_ OFFSET - Where the event buffer starts inside the block
compose_rust_host_web_startreports. - WEB_
HOST_ GLOBAL - The global the generated forwarders read the Host’s exports off.
- 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.
- WHEEL_
DELTA_ MODE_ SCHEMA - WIDGET_
SCHEMA - WINDOW_
HEIGHT_ CLASS_ SCHEMA - WINDOW_
SIZE_ CLASS_ SCHEMA - WORD_
BREAK_ SCHEMA
Functions§
- modifier_
extra_ words - The
extra_wordsthe schema gives a modifier tag, orNonefor a tag it does not list.