fret-ui 0.1.0

Mechanism-layer UI engine for Fret with tree, layout, focus, routing, and interaction contracts.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134

use super::super::*;

#[derive(Debug, Clone, Copy)]
pub enum UiDebugVirtualListWindowSource {
    Layout,
    Prepaint,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum UiDebugVirtualListWindowShiftKind {
    None,
    Prefetch,
    Escape,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum UiDebugVirtualListWindowShiftReason {
    ScrollOffset,
    ViewportResize,
    ItemsRevision,
    ScrollToItem,
    InputsChange,
    Unknown,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum UiDebugVirtualListWindowShiftApplyMode {
    RetainedReconcile,
    NonRetainedRerender,
}

#[derive(Debug, Clone, Copy)]
pub struct UiDebugVirtualListWindow {
    pub source: UiDebugVirtualListWindowSource,
    pub node: NodeId,
    pub element: GlobalElementId,
    pub axis: fret_core::Axis,
    pub is_probe_layout: bool,
    pub items_len: usize,
    pub items_revision: u64,
    pub prev_items_revision: u64,
    pub measure_mode: crate::element::VirtualListMeasureMode,
    pub overscan: usize,
    pub estimate_row_height: Px,
    pub gap: Px,
    pub scroll_margin: Px,
    pub viewport: Px,
    pub prev_viewport: Px,
    pub offset: Px,
    pub prev_offset: Px,
    pub content_extent: Px,
    pub policy_key: u64,
    pub inputs_key: u64,
    pub window_range: Option<crate::virtual_list::VirtualRange>,
    pub prev_window_range: Option<crate::virtual_list::VirtualRange>,
    pub render_window_range: Option<crate::virtual_list::VirtualRange>,
    pub deferred_scroll_to_item: bool,
    pub deferred_scroll_consumed: bool,
    pub window_mismatch: bool,
    pub window_shift_kind: UiDebugVirtualListWindowShiftKind,
    pub window_shift_reason: Option<UiDebugVirtualListWindowShiftReason>,
    pub window_shift_apply_mode: Option<UiDebugVirtualListWindowShiftApplyMode>,
    pub window_shift_invalidation_detail: Option<UiDebugInvalidationDetail>,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum UiDebugRetainedVirtualListReconcileKind {
    Prefetch,
    Escape,
}

#[derive(Debug, Clone, Copy)]
pub struct UiDebugRetainedVirtualListReconcile {
    pub node: NodeId,
    pub element: GlobalElementId,
    pub reconcile_kind: UiDebugRetainedVirtualListReconcileKind,
    /// Wall-clock time spent reconciling this retained host (including mounting/unmounting items).
    pub reconcile_time_us: u32,
    pub prev_items: u32,
    pub next_items: u32,
    pub preserved_items: u32,
    pub attached_items: u32,
    pub detached_items: u32,
    /// Keep-alive bucket size before this reconcile (after loading element-local state).
    pub keep_alive_pool_len_before: u32,
    /// Number of items that were re-attached from the retained keep-alive bucket instead of being
    /// mounted from scratch.
    pub reused_from_keep_alive_items: u32,
    /// Number of detached items that were retained in the keep-alive bucket after the reconcile.
    pub kept_alive_items: u32,
    /// Number of items evicted from the keep-alive bucket due to budget.
    pub evicted_keep_alive_items: u32,
    /// Keep-alive bucket size after this reconcile (after applying detach/evict updates).
    pub keep_alive_pool_len_after: u32,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum UiDebugPrepaintActionKind {
    Invalidate,
    RequestRedraw,
    RequestAnimationFrame,
    VirtualListWindowShift,
    ChartSamplingWindowShift,
    NodeGraphCullWindowShift,
}

#[derive(Debug, Clone, Copy)]
pub struct UiDebugPrepaintAction {
    pub node: NodeId,
    pub target: Option<NodeId>,
    pub kind: UiDebugPrepaintActionKind,
    pub invalidation: Option<Invalidation>,
    pub element: Option<GlobalElementId>,
    pub virtual_list_window_shift_kind: Option<UiDebugVirtualListWindowShiftKind>,
    pub virtual_list_window_shift_reason: Option<UiDebugVirtualListWindowShiftReason>,
    pub chart_sampling_window_key: Option<u64>,
    pub node_graph_cull_window_key: Option<u64>,
    pub frame_id: FrameId,
}

#[derive(Debug, Clone, Copy)]
pub struct UiDebugVirtualListWindowShiftSample {
    pub frame_id: FrameId,
    pub source: UiDebugVirtualListWindowSource,
    pub node: NodeId,
    pub element: GlobalElementId,
    pub window_shift_kind: UiDebugVirtualListWindowShiftKind,
    pub window_shift_reason: UiDebugVirtualListWindowShiftReason,
    pub window_shift_apply_mode: UiDebugVirtualListWindowShiftApplyMode,
    pub window_shift_invalidation_detail: Option<UiDebugInvalidationDetail>,
    pub prev_window_range: Option<crate::virtual_list::VirtualRange>,
    pub window_range: Option<crate::virtual_list::VirtualRange>,
    pub render_window_range: Option<crate::virtual_list::VirtualRange>,
}