chaviw | 1d04428 | 2017-09-27 12:19:28 -0700 | [diff] [blame] | 1 | // Definitions for SurfaceFlinger layers. |
| 2 | |
Nataniel Borges | dcc0bab | 2019-02-15 13:22:03 -0800 | [diff] [blame] | 3 | syntax = "proto3"; |
chaviw | 1d04428 | 2017-09-27 12:19:28 -0700 | [diff] [blame] | 4 | option optimize_for = LITE_RUNTIME; |
chaviw | 0a39899 | 2021-08-13 10:13:01 -0500 | [diff] [blame] | 5 | |
| 6 | import "frameworks/native/services/surfaceflinger/layerproto/common.proto"; |
| 7 | |
chaviw | 1d04428 | 2017-09-27 12:19:28 -0700 | [diff] [blame] | 8 | package android.surfaceflinger; |
| 9 | |
| 10 | // Contains a list of all layers. |
| 11 | message LayersProto { |
| 12 | repeated LayerProto layers = 1; |
| 13 | } |
| 14 | |
Alec Mouri | 6b9e991 | 2020-01-21 10:50:24 -0800 | [diff] [blame] | 15 | // Must match definition in the IComposerClient HAL |
| 16 | enum HwcCompositionType { |
| 17 | // Invalid composition type |
| 18 | INVALID = 0; |
| 19 | // Layer was composited by the client into the client target buffer |
| 20 | CLIENT = 1; |
| 21 | // Layer was composited by the device through hardware overlays |
| 22 | DEVICE = 2; |
| 23 | // Layer was composited by the device using a color |
| 24 | SOLID_COLOR = 3; |
| 25 | // Similar to DEVICE, but the layer position may have been asynchronously set |
| 26 | // through setCursorPosition |
| 27 | CURSOR = 4; |
| 28 | // Layer was composited by the device via a sideband stream. |
| 29 | SIDEBAND = 5; |
| 30 | } |
| 31 | |
chaviw | 1d04428 | 2017-09-27 12:19:28 -0700 | [diff] [blame] | 32 | // Information about each layer. |
| 33 | message LayerProto { |
| 34 | // unique id per layer. |
Nataniel Borges | dcc0bab | 2019-02-15 13:22:03 -0800 | [diff] [blame] | 35 | int32 id = 1; |
chaviw | 1d04428 | 2017-09-27 12:19:28 -0700 | [diff] [blame] | 36 | // unique name per layer. |
Nataniel Borges | dcc0bab | 2019-02-15 13:22:03 -0800 | [diff] [blame] | 37 | string name = 2; |
chaviw | 1d04428 | 2017-09-27 12:19:28 -0700 | [diff] [blame] | 38 | // list of children this layer may have. May be empty. |
| 39 | repeated int32 children = 3; |
| 40 | // list of layers that are z order relative to this layer. |
| 41 | repeated int32 relatives = 4; |
| 42 | // The type of layer, ex Color, Layer |
Nataniel Borges | dcc0bab | 2019-02-15 13:22:03 -0800 | [diff] [blame] | 43 | string type = 5; |
| 44 | RegionProto transparent_region = 6; |
| 45 | RegionProto visible_region = 7; |
| 46 | RegionProto damage_region = 8; |
| 47 | uint32 layer_stack = 9; |
chaviw | 1d04428 | 2017-09-27 12:19:28 -0700 | [diff] [blame] | 48 | // The layer's z order. Can be z order in layer stack, relative to parent, |
| 49 | // or relative to another layer specified in zOrderRelative. |
Nataniel Borges | dcc0bab | 2019-02-15 13:22:03 -0800 | [diff] [blame] | 50 | int32 z = 10; |
chaviw | 1d04428 | 2017-09-27 12:19:28 -0700 | [diff] [blame] | 51 | // The layer's position on the display. |
Nataniel Borges | dcc0bab | 2019-02-15 13:22:03 -0800 | [diff] [blame] | 52 | PositionProto position = 11; |
chaviw | 1d04428 | 2017-09-27 12:19:28 -0700 | [diff] [blame] | 53 | // The layer's requested position. |
Nataniel Borges | dcc0bab | 2019-02-15 13:22:03 -0800 | [diff] [blame] | 54 | PositionProto requested_position = 12; |
chaviw | 1d04428 | 2017-09-27 12:19:28 -0700 | [diff] [blame] | 55 | // The layer's size. |
Nataniel Borges | dcc0bab | 2019-02-15 13:22:03 -0800 | [diff] [blame] | 56 | SizeProto size = 13; |
chaviw | 1d04428 | 2017-09-27 12:19:28 -0700 | [diff] [blame] | 57 | // The layer's crop in it's own bounds. |
Nataniel Borges | dcc0bab | 2019-02-15 13:22:03 -0800 | [diff] [blame] | 58 | RectProto crop = 14; |
chaviw | 1d04428 | 2017-09-27 12:19:28 -0700 | [diff] [blame] | 59 | // The layer's crop in it's parent's bounds. |
Nataniel Borges | dcc0bab | 2019-02-15 13:22:03 -0800 | [diff] [blame] | 60 | RectProto final_crop = 15 [deprecated=true]; |
| 61 | bool is_opaque = 16; |
| 62 | bool invalidate = 17; |
| 63 | string dataspace = 18; |
| 64 | string pixel_format = 19; |
chaviw | 1d04428 | 2017-09-27 12:19:28 -0700 | [diff] [blame] | 65 | // The layer's actual color. |
Nataniel Borges | dcc0bab | 2019-02-15 13:22:03 -0800 | [diff] [blame] | 66 | ColorProto color = 20; |
chaviw | 1d04428 | 2017-09-27 12:19:28 -0700 | [diff] [blame] | 67 | // The layer's requested color. |
Nataniel Borges | dcc0bab | 2019-02-15 13:22:03 -0800 | [diff] [blame] | 68 | ColorProto requested_color = 21; |
chaviw | 1d04428 | 2017-09-27 12:19:28 -0700 | [diff] [blame] | 69 | // Can be any combination of |
| 70 | // hidden = 0x01 |
| 71 | // opaque = 0x02, |
| 72 | // secure = 0x80, |
Nataniel Borges | dcc0bab | 2019-02-15 13:22:03 -0800 | [diff] [blame] | 73 | uint32 flags = 22; |
chaviw | 1d04428 | 2017-09-27 12:19:28 -0700 | [diff] [blame] | 74 | // The layer's actual transform |
Nataniel Borges | dcc0bab | 2019-02-15 13:22:03 -0800 | [diff] [blame] | 75 | TransformProto transform = 23; |
chaviw | 1d04428 | 2017-09-27 12:19:28 -0700 | [diff] [blame] | 76 | // The layer's requested transform. |
Nataniel Borges | dcc0bab | 2019-02-15 13:22:03 -0800 | [diff] [blame] | 77 | TransformProto requested_transform = 24; |
chaviw | 1d04428 | 2017-09-27 12:19:28 -0700 | [diff] [blame] | 78 | // The parent layer. This value can be null if there is no parent. |
Nataniel Borges | dcc0bab | 2019-02-15 13:22:03 -0800 | [diff] [blame] | 79 | int32 parent = 25; |
chaviw | 1d04428 | 2017-09-27 12:19:28 -0700 | [diff] [blame] | 80 | // The layer that this layer has a z order relative to. This value can be null. |
Nataniel Borges | dcc0bab | 2019-02-15 13:22:03 -0800 | [diff] [blame] | 81 | int32 z_order_relative_of = 26; |
chaviw | 1d04428 | 2017-09-27 12:19:28 -0700 | [diff] [blame] | 82 | // This value can be null if there's nothing to draw. |
Nataniel Borges | dcc0bab | 2019-02-15 13:22:03 -0800 | [diff] [blame] | 83 | ActiveBufferProto active_buffer = 27; |
chaviw | 1d04428 | 2017-09-27 12:19:28 -0700 | [diff] [blame] | 84 | // The number of frames available. |
Nataniel Borges | dcc0bab | 2019-02-15 13:22:03 -0800 | [diff] [blame] | 85 | int32 queued_frames = 28; |
| 86 | bool refresh_pending = 29; |
Yiwei Zhang | 7124ad3 | 2018-02-21 13:02:45 -0800 | [diff] [blame] | 87 | // The layer's composer backend destination frame |
Nataniel Borges | dcc0bab | 2019-02-15 13:22:03 -0800 | [diff] [blame] | 88 | RectProto hwc_frame = 30; |
Yiwei Zhang | 7124ad3 | 2018-02-21 13:02:45 -0800 | [diff] [blame] | 89 | // The layer's composer backend source crop |
Nataniel Borges | dcc0bab | 2019-02-15 13:22:03 -0800 | [diff] [blame] | 90 | FloatRectProto hwc_crop = 31; |
Yiwei Zhang | 7124ad3 | 2018-02-21 13:02:45 -0800 | [diff] [blame] | 91 | // The layer's composer backend transform |
Nataniel Borges | dcc0bab | 2019-02-15 13:22:03 -0800 | [diff] [blame] | 92 | int32 hwc_transform = 32; |
| 93 | int32 window_type = 33 [deprecated=true]; |
| 94 | int32 app_id = 34 [deprecated=true]; |
Yiwei Zhang | 60d1a19 | 2018-03-07 14:52:28 -0800 | [diff] [blame] | 95 | // The layer's composition type |
Alec Mouri | 6b9e991 | 2020-01-21 10:50:24 -0800 | [diff] [blame] | 96 | HwcCompositionType hwc_composition_type = 35; |
Yiwei Zhang | 60d1a19 | 2018-03-07 14:52:28 -0800 | [diff] [blame] | 97 | // If it's a buffer layer, indicate if the content is protected |
Nataniel Borges | dcc0bab | 2019-02-15 13:22:03 -0800 | [diff] [blame] | 98 | bool is_protected = 36; |
chaviw | adc40c2 | 2018-07-10 16:57:27 -0700 | [diff] [blame] | 99 | // Current frame number being rendered. |
Nataniel Borges | dcc0bab | 2019-02-15 13:22:03 -0800 | [diff] [blame] | 100 | uint64 curr_frame = 37; |
chaviw | adc40c2 | 2018-07-10 16:57:27 -0700 | [diff] [blame] | 101 | // A list of barriers that the layer is waiting to update state. |
Vishnu Nair | 9978b93 | 2018-08-22 09:11:49 -0700 | [diff] [blame] | 102 | repeated BarrierLayerProto barrier_layer = 38; |
| 103 | // If active_buffer is not null, record its transform. |
Nataniel Borges | dcc0bab | 2019-02-15 13:22:03 -0800 | [diff] [blame] | 104 | TransformProto buffer_transform = 39; |
| 105 | int32 effective_scaling_mode = 40; |
Lucas Dupin | 1b6531c | 2018-07-05 17:18:21 -0700 | [diff] [blame] | 106 | // Layer's corner radius. |
Nataniel Borges | dcc0bab | 2019-02-15 13:22:03 -0800 | [diff] [blame] | 107 | float corner_radius = 41; |
Evan Rosky | 1f6d6d5 | 2018-12-06 10:47:26 -0800 | [diff] [blame] | 108 | // Metadata map. May be empty. |
| 109 | map<int32, bytes> metadata = 42; |
Vishnu Nair | 4351ad5 | 2019-02-11 14:13:02 -0800 | [diff] [blame] | 110 | |
Nataniel Borges | dcc0bab | 2019-02-15 13:22:03 -0800 | [diff] [blame] | 111 | TransformProto effective_transform = 43; |
| 112 | FloatRectProto source_bounds = 44; |
| 113 | FloatRectProto bounds = 45; |
| 114 | FloatRectProto screen_bounds = 46; |
Vishnu Nair | 9245d3b | 2019-03-22 13:38:56 -0700 | [diff] [blame] | 115 | |
| 116 | InputWindowInfoProto input_window_info = 47; |
Vishnu Nair | 95a1ed4 | 2019-12-06 12:25:11 -0800 | [diff] [blame] | 117 | |
| 118 | // Crop used to draw the rounded corner. |
| 119 | FloatRectProto corner_radius_crop = 48; |
| 120 | |
| 121 | // length of the shadow to draw around the layer, it may be set on the |
| 122 | // layer or set by a parent layer. |
| 123 | float shadow_radius = 49; |
chaviw | ddeae26 | 2020-01-06 10:31:23 -0800 | [diff] [blame] | 124 | ColorTransformProto color_transform = 50; |
chaviw | 08f3cb2 | 2020-01-13 13:17:21 -0800 | [diff] [blame] | 125 | |
| 126 | bool is_relative_of = 51; |
Lucas Dupin | 19c8f0e | 2019-11-25 17:55:44 -0800 | [diff] [blame] | 127 | // Layer's background blur radius in pixels. |
| 128 | int32 background_blur_radius = 52; |
chaviw | 250bcbb | 2020-08-05 11:17:54 -0700 | [diff] [blame] | 129 | |
| 130 | uint32 owner_uid = 53; |
Lucas Dupin | c3800b8 | 2020-10-02 16:24:48 -0700 | [diff] [blame] | 131 | |
| 132 | // Regions of a layer, where blur should be applied. |
| 133 | repeated BlurRegion blur_regions = 54; |
Winson Chung | a30f7c9 | 2021-06-29 15:42:56 -0700 | [diff] [blame] | 134 | |
| 135 | bool is_trusted_overlay = 55; |
Pablo Gamito | abdf4da | 2021-08-10 09:55:42 +0000 | [diff] [blame] | 136 | |
| 137 | // Corner radius explicitly set on layer rather than inherited |
| 138 | float requested_corner_radius = 56; |
chaviw | 1d04428 | 2017-09-27 12:19:28 -0700 | [diff] [blame] | 139 | } |
| 140 | |
| 141 | message PositionProto { |
Nataniel Borges | dcc0bab | 2019-02-15 13:22:03 -0800 | [diff] [blame] | 142 | float x = 1; |
| 143 | float y = 2; |
chaviw | 1d04428 | 2017-09-27 12:19:28 -0700 | [diff] [blame] | 144 | } |
| 145 | |
Yiwei Zhang | 7124ad3 | 2018-02-21 13:02:45 -0800 | [diff] [blame] | 146 | message FloatRectProto { |
Nataniel Borges | dcc0bab | 2019-02-15 13:22:03 -0800 | [diff] [blame] | 147 | float left = 1; |
| 148 | float top = 2; |
| 149 | float right = 3; |
| 150 | float bottom = 4; |
Yiwei Zhang | 7124ad3 | 2018-02-21 13:02:45 -0800 | [diff] [blame] | 151 | } |
| 152 | |
chaviw | 1d04428 | 2017-09-27 12:19:28 -0700 | [diff] [blame] | 153 | message ActiveBufferProto { |
Nataniel Borges | dcc0bab | 2019-02-15 13:22:03 -0800 | [diff] [blame] | 154 | uint32 width = 1; |
| 155 | uint32 height = 2; |
| 156 | uint32 stride = 3; |
| 157 | int32 format = 4; |
chaviw | 1d04428 | 2017-09-27 12:19:28 -0700 | [diff] [blame] | 158 | } |
| 159 | |
chaviw | adc40c2 | 2018-07-10 16:57:27 -0700 | [diff] [blame] | 160 | message BarrierLayerProto { |
| 161 | // layer id the barrier is waiting on. |
Nataniel Borges | dcc0bab | 2019-02-15 13:22:03 -0800 | [diff] [blame] | 162 | int32 id = 1; |
chaviw | adc40c2 | 2018-07-10 16:57:27 -0700 | [diff] [blame] | 163 | // frame number the barrier is waiting on. |
Nataniel Borges | dcc0bab | 2019-02-15 13:22:03 -0800 | [diff] [blame] | 164 | uint64 frame_number = 2; |
chaviw | adc40c2 | 2018-07-10 16:57:27 -0700 | [diff] [blame] | 165 | } |
Vishnu Nair | 9245d3b | 2019-03-22 13:38:56 -0700 | [diff] [blame] | 166 | |