1// Copyright 2014 The Flutter Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5/// Service extension constants for the rendering library.
6///
7/// These constants will be used when registering service extensions in the
8/// framework, and they will also be used by tools and services that call these
9/// service extensions.
10///
11/// The String value for each of these extension names should be accessed by
12/// calling the `.name` property on the enum value.
13enum RenderingServiceExtensions {
14 /// Name of service extension that, when called, will toggle whether the
15 /// framework will color invert and horizontally flip images that have been
16 /// decoded to a size taking at least [debugImageOverheadAllowance] bytes more
17 /// than necessary.
18 ///
19 /// See also:
20 ///
21 /// * [debugInvertOversizedImages], which is the flag that this service
22 /// extension exposes.
23 /// * [RendererBinding.initServiceExtensions], where the service extension is
24 /// registered.
25 invertOversizedImages,
26
27 /// Name of service extension that, when called, will toggle whether each
28 /// [RenderBox] will paint a box around its bounds as well as additional boxes
29 /// showing construction lines.
30 ///
31 /// See also:
32 ///
33 /// * [debugPaintSizeEnabled], which is the flag that this service extension
34 /// exposes.
35 /// * [RendererBinding.initServiceExtensions], where the service extension is
36 /// registered.
37 debugPaint,
38
39 /// Name of service extension that, when called, will toggle whether each
40 /// [RenderBox] will paint a line at each of its baselines.
41 ///
42 /// See also:
43 ///
44 /// * [debugPaintBaselinesEnabled], which is the flag that this service
45 /// extension exposes.
46 /// * [RendererBinding.initServiceExtensions], where the service extension is
47 /// registered.
48 debugPaintBaselinesEnabled,
49
50 /// Name of service extension that, when called, will toggle whether a rotating
51 /// set of colors will be overlaid on the device when repainting layers in debug
52 /// mode.
53 ///
54 /// See also:
55 ///
56 /// * [debugRepaintRainbowEnabled], which is the flag that this service
57 /// extension exposes.
58 /// * [RendererBinding.initServiceExtensions], where the service extension is
59 /// registered.
60 repaintRainbow,
61
62 /// Name of service extension that, when called, will dump a [String]
63 /// representation of the layer tree to console.
64 ///
65 /// See also:
66 ///
67 /// * [RendererBinding.initServiceExtensions], where the service extension is
68 /// registered.
69 debugDumpLayerTree,
70
71 /// Name of service extension that, when called, will toggle whether all
72 /// clipping effects from the layer tree will be ignored.
73 ///
74 /// See also:
75 ///
76 /// * [debugDisableClipLayers], which is the flag that this service extension
77 /// exposes.
78 /// * [RendererBinding.initServiceExtensions], where the service extension is
79 /// registered.
80 debugDisableClipLayers,
81
82 /// Name of service extension that, when called, will toggle whether all
83 /// physical modeling effects from the layer tree will be ignored.
84 ///
85 /// See also:
86 ///
87 /// * [debugDisablePhysicalShapeLayers], which is the flag that this service
88 /// extension exposes.
89 /// * [RendererBinding.initServiceExtensions], where the service extension is
90 /// registered.
91 debugDisablePhysicalShapeLayers,
92
93 /// Name of service extension that, when called, will toggle whether all opacity
94 /// effects from the layer tree will be ignored.
95 ///
96 /// See also:
97 ///
98 /// * [debugDisableOpacityLayers], which is the flag that this service extension
99 /// exposes.
100 /// * [RendererBinding.initServiceExtensions], where the service extension is
101 /// registered.
102 debugDisableOpacityLayers,
103
104 /// Name of service extension that, when called, will dump a [String]
105 /// representation of the render tree to console.
106 ///
107 /// See also:
108 ///
109 /// * [RendererBinding.initServiceExtensions], where the service extension is
110 /// registered.
111 debugDumpRenderTree,
112
113 /// Name of service extension that, when called, will dump a [String]
114 /// representation of the semantics tree (in traversal order) to console.
115 ///
116 /// See also:
117 ///
118 /// * [RendererBinding.initServiceExtensions], where the service extension is
119 /// registered.
120 debugDumpSemanticsTreeInTraversalOrder,
121
122 /// Name of service extension that, when called, will dump a [String]
123 /// representation of the semantics tree (in inverse hit test order) to console.
124 ///
125 /// See also:
126 ///
127 /// * [RendererBinding.initServiceExtensions], where the service extension is
128 /// registered.
129 debugDumpSemanticsTreeInInverseHitTestOrder,
130
131 /// Name of service extension that, when called, will toggle whether [Timeline]
132 /// events are added for every [RenderObject] painted.
133 ///
134 /// See also:
135 ///
136 /// * [debugProfilePaintsEnabled], which is the flag that this service extension
137 /// exposes.
138 /// * [RendererBinding.initServiceExtensions], where the service extension is
139 /// registered.
140 profileRenderObjectPaints,
141
142 /// Name of service extension that, when called, will toggle whether [Timeline]
143 /// events are added for every [RenderObject] laid out.
144 ///
145 /// See also:
146 ///
147 /// * [debugProfileLayoutsEnabled], which is the flag that this service
148 /// extension exposes.
149 /// * [RendererBinding.initServiceExtensions], where the service extension is
150 /// registered.
151 profileRenderObjectLayouts,
152}
153