File: overlay_layer_id.h

package info (click to toggle)
chromium 138.0.7204.183-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 6,071,908 kB
  • sloc: cpp: 34,937,088; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,953; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,806; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (66 lines) | stat: -rw-r--r-- 2,015 bytes parent folder | download | duplicates (2)
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
// Copyright 2024 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_GFX_OVERLAY_LAYER_ID_H_
#define UI_GFX_OVERLAY_LAYER_ID_H_

#include <stdint.h>

#include <compare>
#include <string>
#include <utility>

#include "base/component_export.h"

namespace gfx {

// A layer ID packing that includes the namespace. Should be stable across
// frames if OS compositor subtree reuse is desired.
// See |SharedQuadState::layer_id| and |SharedQuadState::layer_namespace_id|.
class COMPONENT_EXPORT(GFX) OverlayLayerId {
 public:
  using NamespaceId = std::pair<uint32_t, uint32_t>;

  OverlayLayerId();
  // `layer_namespace_id` must be non-zero.
  OverlayLayerId(const NamespaceId& layer_namespace_id, uint32_t layer_id);
  ~OverlayLayerId();

  // The set of named layers that Viz make create that do not (or cannot) map
  // back to anything in any compositor frames.
  enum class VizInternalId : uint32_t {
    kInvalid = 0,
    kPrimaryPlane,
    kDelegatedInkTrail,
  };

  // Create an `OverlayLayerId` with a zero `layer_namespace_id`, which is
  // reserved for internal viz use.
  // `layer_id` must be non-zero.
  static OverlayLayerId MakeVizInternal(VizInternalId layer_id);

  // Create an `OverlayLayerId` with a `layer_namespace_id` of {1,1}.
  static OverlayLayerId MakeForTesting(uint32_t layer_id);

  auto operator<=>(const OverlayLayerId&) const = default;

  std::string ToString() const;

  // TODO(crbug.com/324460866): remove when we remove partial delegation.
  using SharedQuadStateLayerId = std::pair<NamespaceId, uint32_t>;
  SharedQuadStateLayerId shared_quad_state_layer_id() const {
    return {layer_namespace_id_, layer_id_};
  }

 private:
  // See `viz::SharedQuadState::layer_namespace_id`.
  // A value of 0 is reserved for Viz use.
  NamespaceId layer_namespace_id_;
  // See `viz::SharedQuadState::layer_id`.
  uint32_t layer_id_ = 0;
};

}  // namespace gfx

#endif  // UI_GFX_OVERLAY_LAYER_ID_H_