gpui-box-kit 0.1.0

GPUI Box Kit design-system components and interaction primitives
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

//! Sound, moving pictures, and geometry — none of it decoded here.
//!
//! The three surfaces in this module are the ones a general-purpose desktop
//! application needs and cannot assemble out of a button and a slider: a
//! player for audio, a player for video, and a viewer for a 3D model. They
//! keep the posture the rest of the library keeps, which for media means
//! something specific.
//!
//! **There is no player in this crate, and there is none in GPUI at the
//! pinned revision.** GPUI draws images and, on macOS, composites a
//! `CVPixelBuffer` through its surface element; it has no decoder, no audio
//! device, and no frame pump. So [`AudioPlayer`] and [`VideoPlayer`] are
//! written against [`MediaTransport`], the seam an operating-system backend
//! lands behind, and a surface with no transport says exactly that instead of
//! drawing a transport bar that would move if anything were playing.
//!
//! **A progress bar is never drawn from a guess.** Position, duration, and
//! buffered spans are the transport's facts. A transport that reports no
//! duration gets a position and no fraction, and a surface with no transport
//! gets no track at all.
//!
//! **A fixture says so.** [`FixtureTransport`] decodes nothing and advances no
//! clock. Every surface publishes and draws [`MediaOrigin`], so a scene, a
//! test, and a screenshot all distinguish a fixture from a player.
//!
//! **A model is read inside a fence.** [`ModelViewer`] takes a glTF 2.0
//! document through the bounded reader in [`gltf`], which accepts a stated
//! subset, refuses anything outside it, and refuses anything past
//! [`ModelBounds`] before allocating for it. The refusal is the contract; the
//! shading is deliberately minimal.

pub mod audio_player;
pub mod gltf;
pub mod model_viewer;
pub mod transport;
pub mod video_player;

pub use audio_player::AudioPlayer;
pub use gltf::{ModelBounds, ModelDefect, ModelError, ModelLimit, ModelMesh, ModelScene};
pub use model_viewer::{ModelShading, ModelState, ModelViewer, ModelViewerEvent};
pub use transport::{
    FixtureTransport, MediaAvailability, MediaCommand, MediaEvent, MediaOrigin, MediaOutcome,
    MediaSnapshot, MediaTransport,
};
pub use video_player::VideoPlayer;

use gpui::{AnyElement, Hsla, IntoElement, ParentElement, SharedString, Styled, div, px};
use gpui_kit_theme::{Space, Theme, TypeScale};

use crate::foundation::{StyledExt, text};

/// Where a notice sits on the surface it covers.
#[derive(Clone, Copy, PartialEq, Eq)]
pub(crate) enum NoticePlace {
    /// The middle of an otherwise empty surface.
    Middle,
    /// A band along the foot, for a surface with a still behind it that the
    /// reader is meant to keep seeing.
    Foot,
}

/// What stands where the media would be when there is none.
///
/// A title and the backend's own sentence, never an empty rectangle: a reader
/// shown a blank frame cannot tell a refusal from silence.
fn notice(theme: &Theme, tint: Hsla, title: SharedString, detail: SharedString) -> AnyElement {
    notice_at(theme, tint, title, detail, NoticePlace::Middle)
}

/// The same sentence, placed against whatever is already on the surface.
fn notice_at(
    theme: &Theme,
    tint: Hsla,
    title: SharedString,
    detail: SharedString,
    place: NoticePlace,
) -> AnyElement {
    let base = match place {
        NoticePlace::Middle => div().absolute().inset_0().justify_center(),
        // A still is worth keeping visible, so the sentence takes a band at
        // the foot on a scrim of its own rather than covering the picture.
        NoticePlace::Foot => div()
            .absolute()
            .bottom_0()
            .left_0()
            .right_0()
            .bg(theme.colors.canvas.opacity(0.88)),
    };
    base.column()
        .items_center()
        .gap_token(theme, Space::Xs)
        .p_token(theme, Space::Lg)
        .text_align(gpui::TextAlign::Center)
        .child(text(theme, TypeScale::Subtitle, title))
        .child(
            text(theme, TypeScale::Body, detail)
                .max_w(px(360.0))
                .text_color(tint),
        )
        .into_any_element()
}