Logo FS-Skia-UI

Viewer Module

The Elmish viewer host edge (moved from the FS.Skia.UI monolith with identical function shapes).

Functions and values

Function or value Description

create configuration init update view

Full Usage: create configuration init update view

Parameters:
    configuration : ViewerConfiguration
    init : unit -> 'model * Cmd<'msg>
    update : 'msg -> 'model -> 'model * Cmd<'msg>
    view : 'model -> Scene

Returns: ViewerProgram<'model, 'msg>
Type parameters: 'model, 'msg

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

configuration : ViewerConfiguration
init : unit -> 'model * Cmd<'msg>
update : 'msg -> 'model -> 'model * Cmd<'msg>
view : 'model -> Scene
Returns: ViewerProgram<'model, 'msg>

defaultConfiguration title initialSize

Full Usage: defaultConfiguration title initialSize

Parameters:
    title : string
    initialSize : Size

Returns: ViewerConfiguration

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

title : string
initialSize : Size
Returns: ViewerConfiguration

run program

Full Usage: run program

Parameters:
Returns: Result<unit, RenderDiagnostic>
Type parameters: 'model, 'msg

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

program : ViewerProgram<'model, 'msg>
Returns: Result<unit, RenderDiagnostic>

withEffectMapping mapper program

Full Usage: withEffectMapping mapper program

Parameters:
Returns: ViewerProgram<'model, 'msg>
Type parameters: 'msg, 'model

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

mapper : 'msg -> ViewerEffect<'msg> option
program : ViewerProgram<'model, 'msg>
Returns: ViewerProgram<'model, 'msg>

withEventMapping mapper program

Full Usage: withEventMapping mapper program

Parameters:
Returns: ViewerProgram<'model, 'msg>
Type parameters: 'msg, 'model

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

mapper : ViewerEvent -> 'msg option
program : ViewerProgram<'model, 'msg>
Returns: ViewerProgram<'model, 'msg>

withSubscription subscription program

Full Usage: withSubscription subscription program

Parameters:
Returns: ViewerProgram<'model, 'msg>
Type parameters: 'model, 'msg

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

subscription : 'model -> (string list * (Dispatch<'msg> -> IDisposable)) list
program : ViewerProgram<'model, 'msg>
Returns: ViewerProgram<'model, 'msg>

Type something to start searching.