File: snapshot.h

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (76 lines) | stat: -rw-r--r-- 2,910 bytes parent folder | download | duplicates (9)
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
// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef UI_SNAPSHOT_SNAPSHOT_H_
#define UI_SNAPSHOT_SNAPSHOT_H_

#include "base/functional/callback_forward.h"
#include "base/memory/ref_counted.h"
#include "base/memory/ref_counted_memory.h"
#include "ui/gfx/native_widget_types.h"
#include "ui/snapshot/snapshot_export.h"

namespace gfx {
class Rect;
class Image;
class Size;
}

// Utility functions to grab snapshots of views and windows. These functions do
// no security checks, so these are useful for debugging purposes where no
// BrowserProcess instance is available (ie. tests), and other user-driven
// scenarios.

namespace ui {

using GrabSnapshotImageCallback = base::OnceCallback<void(gfx::Image snapshot)>;
using GrabSnapshotDataCallback =
    base::OnceCallback<void(scoped_refptr<base::RefCountedMemory> data)>;

// These functions take a snapshot of the specified view or window, within
// `source_rect`, specified in layer space coordinates (DIP for desktop,
// physical pixels for Android).
//
// Returns the snapshot via the provided `callback`. In case of an error, an
// empty image (`gfx::Image::IsEmpty()`) will be returned.

SNAPSHOT_EXPORT void GrabWindowSnapshot(gfx::NativeWindow window,
                                        const gfx::Rect& source_rect,
                                        GrabSnapshotImageCallback callback);

SNAPSHOT_EXPORT void GrabViewSnapshot(gfx::NativeView view,
                                      const gfx::Rect& source_rect,
                                      GrabSnapshotImageCallback callback);

// Takes a snapshot as with `GrabWindowSnapshot()` and scales it to
// `target_size` (in physical pixels).
//
// Returns the snapshot via the provided `callback`. In case of an error, an
// empty image (`gfx::Image::IsEmpty()`) will be returned.
SNAPSHOT_EXPORT void GrabWindowSnapshotAndScale(
    gfx::NativeWindow window,
    const gfx::Rect& source_rect,
    const gfx::Size& target_size,
    GrabSnapshotImageCallback callback);

// Takes a snapshot as with `GrabWindowSnapshot()` and encodes it as PNG data.
//
// Returns the data via the provided `callback`. In case of an error, a null
// pointer will be returned.
SNAPSHOT_EXPORT void GrabWindowSnapshotAsPNG(gfx::NativeWindow window,
                                             const gfx::Rect& source_rect,
                                             GrabSnapshotDataCallback callback);

// Takes a snapshot as with `GrabWindowSnapshot()` and encodes it as JPEG data.
//
// Returns the data via the provided `callback`. In case of an error, a null
// pointer will be returned.
SNAPSHOT_EXPORT void GrabWindowSnapshotAsJPEG(
    gfx::NativeWindow window,
    const gfx::Rect& source_rect,
    GrabSnapshotDataCallback callback);

}  // namespace ui

#endif  // UI_SNAPSHOT_SNAPSHOT_H_