File: frame_evictor.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 (81 lines) | stat: -rw-r--r-- 2,459 bytes parent folder | download | duplicates (5)
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
// Copyright 2017 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_VIZ_CLIENT_FRAME_EVICTOR_H_
#define COMPONENTS_VIZ_CLIENT_FRAME_EVICTOR_H_

#include <vector>

#include "base/memory/raw_ptr.h"
#include "components/viz/client/frame_eviction_manager.h"
#include "components/viz/common/surfaces/surface_id.h"

namespace viz {

class VIZ_CLIENT_EXPORT FrameEvictorClient {
 public:
  struct VIZ_CLIENT_EXPORT EvictIds {
    EvictIds();
    ~EvictIds();

    EvictIds(const EvictIds&) = delete;
    EvictIds& operator=(const EvictIds&) = delete;

    EvictIds(EvictIds&& other);
    EvictIds& operator=(EvictIds&& other);

    // `embedded_ids` contains a list of SurfaceIds embedded by the UI
    // compositor.
    std::vector<SurfaceId> embedded_ids;
  };

  virtual ~FrameEvictorClient() = default;
  virtual void EvictDelegatedFrame(
      const std::vector<SurfaceId>& surface_ids) = 0;
  virtual EvictIds CollectSurfaceIdsForEviction() const = 0;
  virtual SurfaceId GetCurrentSurfaceId() const = 0;
  virtual SurfaceId GetPreNavigationSurfaceId() const = 0;
};

// Keeps track of the visibility state of a child and notifies when the parent
// needs to drop its surface.
class VIZ_CLIENT_EXPORT FrameEvictor : public FrameEvictionManagerClient {
 public:
  explicit FrameEvictor(FrameEvictorClient* client);

  FrameEvictor(const FrameEvictor&) = delete;
  FrameEvictor& operator=(const FrameEvictor&) = delete;

  ~FrameEvictor() override;

  // Called when the parent allocates a new LocalSurfaceId for this child and
  // embeds it.
  void OnNewSurfaceEmbedded();

  // Called when the parent stops embedding the child's surface and evicts it.
  void OnSurfaceDiscarded();

  // Returns whether the parent is currently embedding a surface of this child.
  bool has_surface() const { return has_surface_; }

  // Notifies that the visibility state of the child has changed.
  void SetVisible(bool visible);

  bool visible() const { return visible_; }

  // Returns an ordered collection of `SurfaceIds` that should be evicted.
  std::vector<SurfaceId> CollectSurfaceIdsForEviction() const;

 private:
  // FrameEvictionManagerClient implementation.
  void EvictCurrentFrame() override;

  raw_ptr<FrameEvictorClient> client_;
  bool has_surface_ = false;
  bool visible_ = false;
};

}  // namespace viz

#endif  // COMPONENTS_VIZ_CLIENT_FRAME_EVICTOR_H_