Add screenshot target and source

Author: emilk

crates/viewer/re_space_view/src/lib.rs

@@ -11,7 +11,6 @@ mod instance_hash_conversions;
 mod outlines;
 mod query;
 mod results_ext;
-mod screenshot;
 mod view_property_ui;
 
 pub use annotation_context_utils::{
@@ -31,7 +30,6 @@ pub use query::{
 pub use results_ext::{
     HybridLatestAtResults, HybridResults, HybridResultsChunkIter, RangeResultsExt,
 };
-pub use screenshot::ScreenshotMode;
 pub use view_property_ui::view_property_ui;
 
 pub mod external {

crates/viewer/re_space_view/src/screenshot.rs

@@ -2,14 +2,14 @@ use egui::{epaint::util::OrderedFloat, text::TextWrapping, NumExt as _, WidgetTe
 
 use re_format::format_f32;
 use re_math::BoundingBox;
-use re_space_view::ScreenshotMode;
 use re_types::{
     archetypes::Pinhole, blueprint::components::VisualBounds2D, components::ViewCoordinates,
     image::ImageKind,
 };
 use re_ui::UiExt as _;
 use re_viewer_context::{
-    HoverHighlight, SelectionHighlight, SpaceViewHighlights, SpaceViewState, ViewerContext,
+    HoverHighlight, ScreenshotTarget, SelectionHighlight, SpaceViewHighlights, SpaceViewState,
+    ViewerContext,
 };
 
 use crate::{
@@ -344,18 +344,18 @@ pub fn paint_loading_spinners(
 pub fn screenshot_context_menu(
     _ctx: &ViewerContext<'_>,
     _response: &egui::Response,
-) -> Option<ScreenshotMode> {
+) -> Option<ScreenshotTarget> {
     #[cfg(not(target_arch = "wasm32"))]
     {
         if _ctx.app_options.experimental_space_view_screenshots {
             let mut take_screenshot = None;
             _response.context_menu(|ui| {
                 ui.style_mut().wrap_mode = Some(egui::TextWrapMode::Extend);
                 if ui.button("Save screenshot to disk").clicked() {
-                    take_screenshot = Some(ScreenshotMode::SaveAndCopyToClipboard);
+                    take_screenshot = Some(ScreenshotTarget::SaveAndCopyToClipboard);
                     ui.close_menu();
                 } else if ui.button("Copy screenshot to clipboard").clicked() {
-                    take_screenshot = Some(ScreenshotMode::CopyToClipboard);
+                    take_screenshot = Some(ScreenshotTarget::CopyToClipboard);
                     ui.close_menu();
                 }
             });

crates/viewer/re_space_view_spatial/src/ui.rs

@@ -249,13 +249,14 @@ impl SpatialSpaceView2D {
 
         // ------------------------------------------------------------------------
 
-        if let Some(mode) = screenshot_context_menu(ctx, &response) {
+        if let Some(target) = screenshot_context_menu(ctx, &response) {
             ctx.egui_ctx
                 .send_viewport_cmd(egui::ViewportCommand::Screenshot(egui::UserData::new(
                     re_viewer_context::ScreenshotInfo {
-                        space_view: Some(query.space_view_id),
                         ui_rect: Some(response.rect),
                         pixels_per_point: ui.ctx().pixels_per_point(),
+                        source: re_viewer_context::ScreenshotSource::SpaceView(query.space_view_id),
+                        target,
                     },
                 )));
         }

crates/viewer/re_space_view_spatial/src/ui_2d.rs

@@ -1,6 +1,7 @@
 use std::sync::Arc;
 
 use itertools::Itertools as _;
+
 use re_build_info::CrateVersion;
 use re_data_source::{DataSource, FileContents};
 use re_entity_db::entity_db::EntityDb;
@@ -12,8 +13,8 @@ use re_viewer_context::{
     command_channel,
     store_hub::{BlueprintPersistence, StoreHub, StoreHubStats},
     AppOptions, BlueprintUndoState, CommandReceiver, CommandSender, ComponentUiRegistry, PlayState,
-    SpaceViewClass, SpaceViewClassRegistry, SpaceViewClassRegistryError, StoreContext,
-    SystemCommand, SystemCommandSender,
+    ScreenshotInfo, SpaceViewClass, SpaceViewClassRegistry, SpaceViewClassRegistryError,
+    StoreContext, SystemCommand, SystemCommandSender,
 };
 
 use crate::app_blueprint::PanelStateOverrides;
@@ -1904,13 +1905,14 @@ impl eframe::App for App {
                     if let Some(info) = &user_data
                         .data
                         .as_ref()
-                        .and_then(|data| data.downcast_ref::<re_viewer_context::ScreenshotInfo>())
+                        .and_then(|data| data.downcast_ref::<ScreenshotInfo>())
                     {
                         re_log::info!("Screenshot info: {info:?}");
                         let ScreenshotInfo {
-                            space_view,
                             ui_rect,
                             pixels_per_point,
+                            source,
+                            target,
                         } = (*info).clone();
 
                         let rgba = if let Some(ui_rect) = ui_rect {

crates/viewer/re_viewer/src/app.rs

@@ -133,7 +133,31 @@ pub fn contents_name_style(name: &ContentsName) -> re_ui::LabelStyle {
 /// Specified what we are screenshotting.
 #[derive(Clone, Debug, PartialEq)]
 pub struct ScreenshotInfo {
-    pub space_view: Option<SpaceViewId>,
+    /// What portion of the UI to take a screenshot of (in ui points).
     pub ui_rect: Option<egui::Rect>,
     pub pixels_per_point: f32,
+
+    /// What we are screenshotting.
+    pub source: ScreenshotSource,
+
+    /// Where to put the screenshot.
+    pub target: ScreenshotTarget,
+}
+
+/// What we are screenshotting.
+#[derive(Clone, Copy, Debug, PartialEq, Eq)]
+pub enum ScreenshotSource {
+    WholeApp,
+
+    SpaceView(SpaceViewId),
+}
+
+/// Where to put the screenshot.
+#[derive(Clone, Copy, Debug, PartialEq, Eq)]
+pub enum ScreenshotTarget {
+    /// The screenshot will be saved to disc and copied to the clipboard.
+    SaveAndCopyToClipboard,
+
+    /// The screenshot will be copied to the clipboard.
+    CopyToClipboard,
 }

crates/viewer/re_viewer_context/src/lib.rs

@@ -1,18 +1,19 @@
-use re_space_view::ScreenshotMode;
+use re_viewer_context::ScreenshotTarget;
 use re_viewport_blueprint::SpaceViewBlueprint;
 
+// TODO: use this
 pub fn handle_pending_space_view_screenshots(
     space_view: &SpaceViewBlueprint,
     data: &[u8],
     extent: glam::UVec2,
-    mode: ScreenshotMode,
+    target: ScreenshotTarget,
 ) {
     // Set to clipboard.
     #[cfg(not(target_arch = "wasm32"))]
     re_viewer_context::Clipboard::with(|clipboard| {
         clipboard.set_image([extent.x as _, extent.y as _], data);
     });
-    if mode == ScreenshotMode::CopyToClipboard {
+    if target == ScreenshotTarget::CopyToClipboard {
         return;
     }
 
@@ -33,20 +34,16 @@ pub fn handle_pending_space_view_screenshots(
         i += 1;
     };
     let filename = std::path::Path::new(&filename);
+    let readable_path = filename.canonicalize().unwrap_or(filename.to_path_buf());
+
+    // TODO: use rfd to pick a path?
 
     match image::save_buffer(filename, data, extent.x, extent.y, image::ColorType::Rgba8) {
-        Ok(_) => {
-            re_log::info!(
-                "Saved screenshot to {:?}.",
-                filename.canonicalize().unwrap_or(filename.to_path_buf())
-            );
+        Ok(()) => {
+            re_log::info!("Saved screenshot to {readable_path:?}.",);
         }
         Err(err) => {
-            re_log::error!(
-                "Failed to safe screenshot to {:?}: {}",
-                filename.canonicalize().unwrap_or(filename.to_path_buf()),
-                err
-            );
+            re_log::error!("Failed to save screenshot to {readable_path:?}: {err}");
         }
     }
 }