KeyboardInput (FS-Skia-UI) | FS-Skia-UI

KeyboardInput Module

Namespace: FS.Skia.UI.Input
Assembly: FS.Skia.UI.Input.dll

Public contract module exposed by this FS.Skia.UI package.

Functions and values

Function or value	Description
`analyzeBigrams model layout` Full Usage: `analyzeBigrams model layout` Parameters: model : `CanonicalInputModel` layout : `LayoutId` Returns: `BigramReport`	Public contract function exposed by this FS.Skia.UI package. model : `CanonicalInputModel` layout : `LayoutId` Returns: `BigramReport`
`commandRegistry commands` Full Usage: `commandRegistry commands` Parameters: commands : `CommandDefinition list` Returns: `Result<CommandRegistry, InputDiagnostic list>`	Public contract function exposed by this FS.Skia.UI package. commands : `CommandDefinition list` Returns: `Result<CommandRegistry, InputDiagnostic list>`
`compactStateDisplayOptions` Full Usage: `compactStateDisplayOptions` Returns: `KeyboardStateDisplayOptions`	Public contract function exposed by this FS.Skia.UI package. Returns: `KeyboardStateDisplayOptions`
`defaultStateDisplayOptions` Full Usage: `defaultStateDisplayOptions` Returns: `KeyboardStateDisplayOptions`	Public contract function exposed by this FS.Skia.UI package. Returns: `KeyboardStateDisplayOptions`
`expandedStateDisplayOptions` Full Usage: `expandedStateDisplayOptions` Returns: `KeyboardStateDisplayOptions`	Public contract function exposed by this FS.Skia.UI package. Returns: `KeyboardStateDisplayOptions`
`init activeLayout model` Full Usage: `init activeLayout model` Parameters: activeLayout : `LayoutId` model : `CanonicalInputModel` Returns: `Result<(InputRuntime * InputEffect list), InputDiagnostic list>`	Public contract function exposed by this FS.Skia.UI package. activeLayout : `LayoutId` model : `CanonicalInputModel` Returns: `Result<(InputRuntime * InputEffect list), InputDiagnostic list>`
`keyboardStateDisplay options recentEffects runtime` Full Usage: `keyboardStateDisplay options recentEffects runtime` Parameters: options : `KeyboardStateDisplayOptions` recentEffects : `InputEffect list` runtime : `InputRuntime` Returns: `KeyboardStateDisplayModel`	Public contract function exposed by this FS.Skia.UI package. options : `KeyboardStateDisplayOptions` recentEffects : `InputEffect list` runtime : `InputRuntime` Returns: `KeyboardStateDisplayModel`
`layoutState runtime` Full Usage: `layoutState runtime` Parameters: runtime : `InputRuntime` Returns: `LayoutStateView`	Public contract function exposed by this FS.Skia.UI package. runtime : `InputRuntime` Returns: `LayoutStateView`
`parseYaml yaml` Full Usage: `parseYaml yaml` Parameters: yaml : `string` Returns: `Result<InputConfiguration, InputDiagnostic list>`	Public contract function exposed by this FS.Skia.UI package. yaml : `string` Returns: `Result<InputConfiguration, InputDiagnostic list>`
`renderKeyboardStateDisplay options recentEffects runtime` Full Usage: `renderKeyboardStateDisplay options recentEffects runtime` Parameters: options : `KeyboardStateDisplayOptions` recentEffects : `InputEffect list` runtime : `InputRuntime` Returns: `Scene`	Public contract function exposed by this FS.Skia.UI package. options : `KeyboardStateDisplayOptions` recentEffects : `InputEffect list` runtime : `InputRuntime` Returns: `Scene`
`renderKeyboardStateDisplayAt (position, arg1) options recentEffects runtime` Full Usage: `renderKeyboardStateDisplayAt (position, arg1) options recentEffects runtime` Parameters: position : `float` arg1 : `float` options : `KeyboardStateDisplayOptions` recentEffects : `InputEffect list` runtime : `InputRuntime` Returns: `Scene`	Public contract function exposed by this FS.Skia.UI package. position : `float` arg1 : `float` options : `KeyboardStateDisplayOptions` recentEffects : `InputEffect list` runtime : `InputRuntime` Returns: `Scene`
`renderLayoutState runtime` Full Usage: `renderLayoutState runtime` Parameters: runtime : `InputRuntime` Returns: `Scene`	Public contract function exposed by this FS.Skia.UI package. runtime : `InputRuntime` Returns: `Scene`
`renderLayoutStateAt (position, arg1) runtime` Full Usage: `renderLayoutStateAt (position, arg1) runtime` Parameters: position : `float` arg1 : `float` runtime : `InputRuntime` Returns: `Scene`	Public contract function exposed by this FS.Skia.UI package. position : `float` arg1 : `float` runtime : `InputRuntime` Returns: `Scene`
`replay initial messages` Full Usage: `replay initial messages` Parameters: initial : `InputRuntime` messages : `InputMsg list` Returns: `InputRuntime * InputEffect list`	Public contract function exposed by this FS.Skia.UI package. initial : `InputRuntime` messages : `InputMsg list` Returns: `InputRuntime * InputEffect list`
`update msg runtime` Full Usage: `update msg runtime` Parameters: msg : `InputMsg` runtime : `InputRuntime` Returns: `InputRuntime * InputEffect list`	Public contract function exposed by this FS.Skia.UI package. msg : `InputMsg` runtime : `InputRuntime` Returns: `InputRuntime * InputEffect list`
`updateFromViewerEvent event runtime` Full Usage: `updateFromViewerEvent event runtime` Parameters: event : `ViewerEvent` runtime : `InputRuntime` Returns: `InputRuntime * InputEffect list`	Public contract function exposed by this FS.Skia.UI package. event : `ViewerEvent` runtime : `InputRuntime` Returns: `InputRuntime * InputEffect list`
`validate registry configuration` Full Usage: `validate registry configuration` Parameters: registry : `CommandRegistry` configuration : `InputConfiguration` Returns: `Result<CanonicalInputModel, InputDiagnostic list>`	Public contract function exposed by this FS.Skia.UI package. registry : `CommandRegistry` configuration : `InputConfiguration` Returns: `Result<CanonicalInputModel, InputDiagnostic list>`
`viewerInputMsg event` Full Usage: `viewerInputMsg event` Parameters: event : `ViewerEvent` Returns: `InputMsg option`	Public contract function exposed by this FS.Skia.UI package. event : `ViewerEvent` Returns: `InputMsg option`