re_context_menu/actions/
screenshot_action.rs

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
use re_viewer_context::{Item, PublishedViewInfo, ScreenshotTarget, ViewId, ViewRectPublisher};

use crate::{ContextMenuAction, ContextMenuContext};

/// View screenshot action.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum ScreenshotAction {
    /// Screenshot the view, and copy the results to clipboard.
    CopyScreenshot,

    /// Screenshot the view, and save the results to disk.
    SaveScreenshot,
}

impl ContextMenuAction for ScreenshotAction {
    fn supports_multi_selection(&self, _ctx: &ContextMenuContext<'_>) -> bool {
        match self {
            Self::CopyScreenshot => false,
            Self::SaveScreenshot => true,
        }
    }

    /// Do we have a context menu for this item?
    fn supports_item(&self, ctx: &ContextMenuContext<'_>, item: &Item) -> bool {
        if *self == Self::CopyScreenshot && ctx.viewer_context.is_safari_browser() {
            // Safari only allows access to clipboard on user action (e.g. on-click).
            // However, the screenshot capture results arrives a frame later.
            re_log::debug_once!("Copying screenshots not supported on Safari");
            return false;
        }

        let Item::View(view_id) = item else {
            return false;
        };

        ctx.egui_context().memory_mut(|mem| {
            mem.caches
                .cache::<ViewRectPublisher>()
                .get(view_id)
                .is_some()
        })
    }

    fn label(&self, _ctx: &ContextMenuContext<'_>) -> String {
        match self {
            Self::CopyScreenshot => "Copy screenshot".to_owned(),
            Self::SaveScreenshot => "Save screenshot…".to_owned(),
        }
    }

    fn process_view(&self, ctx: &ContextMenuContext<'_>, view_id: &ViewId) {
        let Some(view_info) = ctx.egui_context().memory_mut(|mem| {
            mem.caches
                .cache::<ViewRectPublisher>()
                .get(view_id)
                .cloned()
        }) else {
            return;
        };

        let PublishedViewInfo { name, rect } = view_info;

        let rect = rect.shrink(2.5); // Hacky: Shrink so we don't accidentally include the border of the view.

        if !rect.is_positive() {
            re_log::info!("View too small for a screenshot");
            return;
        }

        let target = match self {
            Self::CopyScreenshot => ScreenshotTarget::CopyToClipboard,
            Self::SaveScreenshot => ScreenshotTarget::SaveToDisk,
        };

        ctx.egui_context()
            .send_viewport_cmd(egui::ViewportCommand::Screenshot(egui::UserData::new(
                re_viewer_context::ScreenshotInfo {
                    ui_rect: Some(rect),
                    pixels_per_point: ctx.egui_context().pixels_per_point(),
                    name,
                    target,
                },
            )));
    }
}