Viewer (FS-Skia-UI)

Viewer Module

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

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

Functions and values

Function or value	Description
`captureDiagnostic options diagnostic` Full Usage: `captureDiagnostic options diagnostic` Parameters: options : `ViewerDiagnosticsOptions` diagnostic : `ViewerDiagnosticEvent` Returns: `ViewerDiagnosticEvent option`	Public contract function exposed by this FS.Skia.UI package. options : `ViewerDiagnosticsOptions` diagnostic : `ViewerDiagnosticEvent` Returns: `ViewerDiagnosticEvent option`
`captureScreenshotEvidence request options scene` Full Usage: `captureScreenshotEvidence request options scene` Parameters: request : `ScreenshotEvidenceRequest` options : `ViewerOptions` scene : `SceneNode` Returns: `ScreenshotEvidenceResult`	Public contract function exposed by this FS.Skia.UI package. request : `ScreenshotEvidenceRequest` options : `ViewerOptions` scene : `SceneNode` Returns: `ScreenshotEvidenceResult`
`classifyWindowObservation outcome externalObservationAttempted externalWindowMatched captureAttempted captureSucceeded` Full Usage: `classifyWindowObservation outcome externalObservationAttempted externalWindowMatched captureAttempted captureSucceeded` Parameters: outcome : `ViewerLaunchOutcome` externalObservationAttempted : `bool` externalWindowMatched : `bool option` captureAttempted : `bool` captureSucceeded : `bool option` Returns: `ViewerWindowObservationResult`	Public contract function exposed by this FS.Skia.UI package. outcome : `ViewerLaunchOutcome` externalObservationAttempted : `bool` externalWindowMatched : `bool option` captureAttempted : `bool` captureSucceeded : `bool option` Returns: `ViewerWindowObservationResult`
`classifyWindowState diagnostic` Full Usage: `classifyWindowState diagnostic` Parameters: diagnostic : `ViewerWindowStateDiagnostic` Returns: `ViewerLifecycleState`	Public contract function exposed by this FS.Skia.UI package. diagnostic : `ViewerWindowStateDiagnostic` Returns: `ViewerLifecycleState`
`defaultDiagnostics` Full Usage: `defaultDiagnostics` Returns: `ViewerDiagnosticsOptions`	Public contract function exposed by this FS.Skia.UI package. Returns: `ViewerDiagnosticsOptions`
`defaultWindowBehavior` Full Usage: `defaultWindowBehavior` Returns: `ViewerWindowBehaviorRequest`	Public contract function exposed by this FS.Skia.UI package. Returns: `ViewerWindowBehaviorRequest`
`desktopSessionDiagnostic ()` Full Usage: `desktopSessionDiagnostic ()` Parameters: () : `unit` Returns: `ViewerDesktopSessionDiagnostic`	Public contract function exposed by this FS.Skia.UI package. () : `unit` Returns: `ViewerDesktopSessionDiagnostic`
`failureFromDiagnostic diagnostic` Full Usage: `failureFromDiagnostic diagnostic` Parameters: diagnostic : `ViewerDiagnosticEvent` Returns: `ViewerRunFailure`	Public contract function exposed by this FS.Skia.UI package. diagnostic : `ViewerDiagnosticEvent` Returns: `ViewerRunFailure`
`init options` Full Usage: `init options` Parameters: options : `ViewerOptions` Returns: `ViewerModel * ViewerEffect list`	Public contract function exposed by this FS.Skia.UI package. options : `ViewerOptions` Returns: `ViewerModel * ViewerEffect list`
`initEvidenceWorkflow request` Full Usage: `initEvidenceWorkflow request` Parameters: request : `ScreenshotEvidenceRequest` Returns: `EvidenceWorkflowModel * EvidenceWorkflowEffect list`	Public contract function exposed by this FS.Skia.UI package. request : `ScreenshotEvidenceRequest` Returns: `EvidenceWorkflowModel * EvidenceWorkflowEffect list`
`initRun request` Full Usage: `initRun request` Parameters: request : `ViewerRunRequest` Returns: `ViewerRunModel * ViewerRunEffect list`	Public contract function exposed by this FS.Skia.UI package. request : `ViewerRunRequest` Returns: `ViewerRunModel * ViewerRunEffect list`
`initWithWindowBehavior options behavior` Full Usage: `initWithWindowBehavior options behavior` Parameters: options : `ViewerOptions` behavior : `ViewerWindowBehaviorRequest` Returns: `ViewerModel * ViewerEffect list`	Public contract function exposed by this FS.Skia.UI package. options : `ViewerOptions` behavior : `ViewerWindowBehaviorRequest` Returns: `ViewerModel * ViewerEffect list`
`run options scene` Full Usage: `run options scene` Parameters: options : `ViewerOptions` scene : `SceneNode` Returns: `Result<ViewerLaunchOutcome, ViewerRunFailure>`	Public contract function exposed by this FS.Skia.UI package. options : `ViewerOptions` scene : `SceneNode` Returns: `Result<ViewerLaunchOutcome, ViewerRunFailure>`
`runApp options host` Full Usage: `runApp options host` Parameters: options : `ViewerOptions` host : `GeneratedAppHost<'model, 'msg>` Returns: `Result<ViewerLaunchOutcome, ViewerRunFailure>` Type parameters: 'model, 'msg	Public contract function exposed by this FS.Skia.UI package. options : `ViewerOptions` host : `GeneratedAppHost<'model, 'msg>` Returns: `Result<ViewerLaunchOutcome, ViewerRunFailure>`
`runAppEvidence request options host` Full Usage: `runAppEvidence request options host` Parameters: request : `ViewerRunRequest` options : `ViewerOptions` host : `GeneratedAppHost<'model, 'msg>` Returns: `Result<ViewerLaunchOutcome, ViewerRunFailure>` Type parameters: 'model, 'msg	Public contract function exposed by this FS.Skia.UI package. request : `ViewerRunRequest` options : `ViewerOptions` host : `GeneratedAppHost<'model, 'msg>` Returns: `Result<ViewerLaunchOutcome, ViewerRunFailure>`
`runAppWithWindowBehavior options behavior host` Full Usage: `runAppWithWindowBehavior options behavior host` Parameters: options : `ViewerOptions` behavior : `ViewerWindowBehaviorRequest` host : `GeneratedAppHost<'model, 'msg>` Returns: `Result<ViewerLaunchOutcome, ViewerRunFailure>` Type parameters: 'model, 'msg	Public contract function exposed by this FS.Skia.UI package. options : `ViewerOptions` behavior : `ViewerWindowBehaviorRequest` host : `GeneratedAppHost<'model, 'msg>` Returns: `Result<ViewerLaunchOutcome, ViewerRunFailure>`
`runBounded request options scene` Full Usage: `runBounded request options scene` Parameters: request : `ViewerRunRequest` options : `ViewerOptions` scene : `SceneNode` Returns: `Result<ViewerRunEvidence, ViewerRunFailure>`	Public contract function exposed by this FS.Skia.UI package. request : `ViewerRunRequest` options : `ViewerOptions` scene : `SceneNode` Returns: `Result<ViewerRunEvidence, ViewerRunFailure>`
`runForFrames frameCount options scene` Full Usage: `runForFrames frameCount options scene` Parameters: frameCount : `int` options : `ViewerOptions` scene : `SceneNode` Returns: `Result<ViewerRunEvidence, ViewerRunFailure>`	Public contract function exposed by this FS.Skia.UI package. frameCount : `int` options : `ViewerOptions` scene : `SceneNode` Returns: `Result<ViewerRunEvidence, ViewerRunFailure>`
`runInteractiveViewer options host` Full Usage: `runInteractiveViewer options host` Parameters: options : `ViewerOptions` host : `InteractiveViewerHost<'model, 'msg>` Returns: `Result<ViewerLaunchOutcome, ViewerRunFailure>` Type parameters: 'model, 'msg	Feature 085 — pointer-aware, size-aware durable launch. Routes native pointer events and window resizes to the host and renders the size-aware `View`; additive to `runApp`/`runAppWithWindowBehavior`, which stay intact (FR-004/FR-006/FR-009). options : `ViewerOptions` host : `InteractiveViewerHost<'model, 'msg>` Returns: `Result<ViewerLaunchOutcome, ViewerRunFailure>`
`runInteractiveViewerWithWindowBehavior options behavior host` Full Usage: `runInteractiveViewerWithWindowBehavior options behavior host` Parameters: options : `ViewerOptions` behavior : `ViewerWindowBehaviorRequest` host : `InteractiveViewerHost<'model, 'msg>` Returns: `Result<ViewerLaunchOutcome, ViewerRunFailure>` Type parameters: 'model, 'msg	As `runInteractiveViewer` with an explicit window behavior. options : `ViewerOptions` behavior : `ViewerWindowBehaviorRequest` host : `InteractiveViewerHost<'model, 'msg>` Returns: `Result<ViewerLaunchOutcome, ViewerRunFailure>`
`runUntilFirstFrame options scene` Full Usage: `runUntilFirstFrame options scene` Parameters: options : `ViewerOptions` scene : `SceneNode` Returns: `Result<ViewerRunEvidence, ViewerRunFailure>`	Public contract function exposed by this FS.Skia.UI package. options : `ViewerOptions` scene : `SceneNode` Returns: `Result<ViewerRunEvidence, ViewerRunFailure>`
`runtimeCapability ()` Full Usage: `runtimeCapability ()` Parameters: () : `unit` Returns: `ViewerRuntimeCapability`	Public contract function exposed by this FS.Skia.UI package. () : `unit` Returns: `ViewerRuntimeCapability`
`shouldCaptureDiagnostic options diagnostic` Full Usage: `shouldCaptureDiagnostic options diagnostic` Parameters: options : `ViewerDiagnosticsOptions` diagnostic : `ViewerDiagnosticEvent` Returns: `bool`	Public contract function exposed by this FS.Skia.UI package. options : `ViewerDiagnosticsOptions` diagnostic : `ViewerDiagnosticEvent` Returns: `bool`
`update msg model` Full Usage: `update msg model` Parameters: msg : `ViewerMsg` model : `ViewerModel` Returns: `ViewerModel * ViewerEffect list`	Public contract function exposed by this FS.Skia.UI package. msg : `ViewerMsg` model : `ViewerModel` Returns: `ViewerModel * ViewerEffect list`
`updateEvidenceWorkflow msg model` Full Usage: `updateEvidenceWorkflow msg model` Parameters: msg : `EvidenceWorkflowMsg` model : `EvidenceWorkflowModel` Returns: `EvidenceWorkflowModel * EvidenceWorkflowEffect list`	Public contract function exposed by this FS.Skia.UI package. msg : `EvidenceWorkflowMsg` model : `EvidenceWorkflowModel` Returns: `EvidenceWorkflowModel * EvidenceWorkflowEffect list`
`updateRun msg model` Full Usage: `updateRun msg model` Parameters: msg : `ViewerRunMsg` model : `ViewerRunModel` Returns: `ViewerRunModel * ViewerRunEffect list`	Public contract function exposed by this FS.Skia.UI package. msg : `ViewerRunMsg` model : `ViewerRunModel` Returns: `ViewerRunModel * ViewerRunEffect list`
`validateWindowBehavior request` Full Usage: `validateWindowBehavior request` Parameters: request : `ViewerWindowBehaviorRequest` Returns: `ViewerWindowOptionResult list`	Public contract function exposed by this FS.Skia.UI package. request : `ViewerWindowBehaviorRequest` Returns: `ViewerWindowOptionResult list`
`validateWindowLaunchBehavior initialSize request` Full Usage: `validateWindowLaunchBehavior initialSize request` Parameters: initialSize : `Size` request : `ViewerWindowBehaviorRequest` Returns: `ViewerWindowOptionResult list`	Public contract function exposed by this FS.Skia.UI package. initialSize : `Size` request : `ViewerWindowBehaviorRequest` Returns: `ViewerWindowOptionResult list`