Romain Guy | 51769a6 | 2010-07-23 00:28:00 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2010 The Android Open Source Project |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
Romain Guy | 5b3b352 | 2010-10-27 18:57:51 -0700 | [diff] [blame] | 17 | #ifndef ANDROID_HWUI_PROPERTIES_H |
| 18 | #define ANDROID_HWUI_PROPERTIES_H |
Romain Guy | 51769a6 | 2010-07-23 00:28:00 -0700 | [diff] [blame] | 19 | |
John Reck | 938e884 | 2017-08-24 13:41:59 -0700 | [diff] [blame] | 20 | #include <cutils/compiler.h> |
Romain Guy | fb8b763 | 2010-08-23 21:05:08 -0700 | [diff] [blame] | 21 | #include <cutils/properties.h> |
| 22 | |
Romain Guy | 51769a6 | 2010-07-23 00:28:00 -0700 | [diff] [blame] | 23 | /** |
Chris Craik | 5e00c7c | 2016-07-06 16:10:09 -0700 | [diff] [blame] | 24 | * This file contains the list of system properties used to configure libhwui. |
Romain Guy | 51769a6 | 2010-07-23 00:28:00 -0700 | [diff] [blame] | 25 | */ |
| 26 | |
Chris Craik | 2507c34 | 2015-05-04 14:36:49 -0700 | [diff] [blame] | 27 | namespace android { |
| 28 | namespace uirenderer { |
| 29 | |
Romain Guy | cf51a41 | 2013-04-08 19:40:31 -0700 | [diff] [blame] | 30 | /////////////////////////////////////////////////////////////////////////////// |
| 31 | // Compile-time properties |
| 32 | /////////////////////////////////////////////////////////////////////////////// |
| 33 | |
Romain Guy | 28d8ff6 | 2011-08-22 14:01:34 -0700 | [diff] [blame] | 34 | // Textures used by layers must have dimensions multiples of this number |
| 35 | #define LAYER_SIZE 64 |
| 36 | |
Romain Guy | 8d4aeb7 | 2013-02-12 16:08:55 -0800 | [diff] [blame] | 37 | // Defines the size in bits of the stencil buffer for the framebuffer |
Romain Guy | ada4d53 | 2012-02-02 17:31:16 -0800 | [diff] [blame] | 38 | // Note: Only 1 bit is required for clipping but more bits are required |
Romain Guy | 8d4aeb7 | 2013-02-12 16:08:55 -0800 | [diff] [blame] | 39 | // to properly implement overdraw debugging |
Romain Guy | 7c450aa | 2012-09-21 19:15:00 -0700 | [diff] [blame] | 40 | #define STENCIL_BUFFER_SIZE 8 |
Romain Guy | 530041d | 2012-01-25 18:56:29 -0800 | [diff] [blame] | 41 | |
Romain Guy | cf51a41 | 2013-04-08 19:40:31 -0700 | [diff] [blame] | 42 | /////////////////////////////////////////////////////////////////////////////// |
| 43 | // Debug properties |
| 44 | /////////////////////////////////////////////////////////////////////////////// |
| 45 | |
Romain Guy | e190aa6 | 2010-11-10 19:01:29 -0800 | [diff] [blame] | 46 | /** |
Romain Guy | 4ff0cf4 | 2012-08-06 14:51:10 -0700 | [diff] [blame] | 47 | * Debug level for app developers. The value is a numeric value defined |
| 48 | * by the DebugLevel enum below. |
Romain Guy | e190aa6 | 2010-11-10 19:01:29 -0800 | [diff] [blame] | 49 | */ |
Romain Guy | 4ff0cf4 | 2012-08-06 14:51:10 -0700 | [diff] [blame] | 50 | #define PROPERTY_DEBUG "debug.hwui.level" |
Romain Guy | e190aa6 | 2010-11-10 19:01:29 -0800 | [diff] [blame] | 51 | |
| 52 | /** |
| 53 | * Debug levels. Debug levels are used as flags. |
| 54 | */ |
| 55 | enum DebugLevel { |
| 56 | kDebugDisabled = 0, |
| 57 | kDebugMemory = 1, |
Romain Guy | 25dc3a7 | 2010-12-10 12:33:05 -0800 | [diff] [blame] | 58 | kDebugCaches = 2, |
Kenny Root | 042f7d6 | 2011-07-13 09:49:43 -0700 | [diff] [blame] | 59 | kDebugMoreCaches = kDebugMemory | kDebugCaches |
Romain Guy | e190aa6 | 2010-11-10 19:01:29 -0800 | [diff] [blame] | 60 | }; |
| 61 | |
Romain Guy | 4ff0cf4 | 2012-08-06 14:51:10 -0700 | [diff] [blame] | 62 | /** |
Romain Guy | 7c450aa | 2012-09-21 19:15:00 -0700 | [diff] [blame] | 63 | * Used to enable/disable layers update debugging. The accepted values are |
Romain Guy | 4ff0cf4 | 2012-08-06 14:51:10 -0700 | [diff] [blame] | 64 | * "true" and "false". The default value is "false". |
| 65 | */ |
| 66 | #define PROPERTY_DEBUG_LAYERS_UPDATES "debug.hwui.show_layers_updates" |
| 67 | |
Romain Guy | 7c450aa | 2012-09-21 19:15:00 -0700 | [diff] [blame] | 68 | /** |
Romain Guy | 627c6fd | 2013-08-21 11:53:18 -0700 | [diff] [blame] | 69 | * Used to enable/disable overdraw debugging. |
| 70 | * |
| 71 | * The accepted values are |
| 72 | * "show", to show overdraw |
| 73 | * "show_deuteranomaly", to show overdraw if you suffer from Deuteranomaly |
| 74 | * "count", to show an overdraw counter |
| 75 | * "false", to disable overdraw debugging |
| 76 | * |
| 77 | * The default value is "false". |
Romain Guy | 7c450aa | 2012-09-21 19:15:00 -0700 | [diff] [blame] | 78 | */ |
Romain Guy | 78dd96d | 2013-05-03 14:24:16 -0700 | [diff] [blame] | 79 | #define PROPERTY_DEBUG_OVERDRAW "debug.hwui.overdraw" |
Romain Guy | 7c450aa | 2012-09-21 19:15:00 -0700 | [diff] [blame] | 80 | |
Romain Guy | 87e2f757 | 2012-09-24 11:37:12 -0700 | [diff] [blame] | 81 | /** |
John Reck | fe5e7b7 | 2014-05-23 17:42:28 -0700 | [diff] [blame] | 82 | * System property used to enable or disable hardware rendering profiling. |
| 83 | * The default value of this property is assumed to be false. |
| 84 | * |
| 85 | * When profiling is enabled, the adb shell dumpsys gfxinfo command will |
| 86 | * output extra information about the time taken to execute by the last |
| 87 | * frames. |
| 88 | * |
| 89 | * Possible values: |
| 90 | * "true", to enable profiling |
| 91 | * "visual_bars", to enable profiling and visualize the results on screen |
| 92 | * "false", to disable profiling |
| 93 | */ |
| 94 | #define PROPERTY_PROFILE "debug.hwui.profile" |
| 95 | #define PROPERTY_PROFILE_VISUALIZE_BARS "visual_bars" |
| 96 | |
| 97 | /** |
Romain Guy | 3ff0bfd | 2013-02-25 14:15:37 -0800 | [diff] [blame] | 98 | * Used to enable/disable non-rectangular clipping debugging. |
| 99 | * |
| 100 | * The accepted values are: |
| 101 | * "highlight", drawing commands clipped by the stencil will |
| 102 | * be colored differently |
| 103 | * "region", renders the clipping region on screen whenever |
| 104 | * the stencil is set |
| 105 | * "hide", don't show the clip |
| 106 | * |
| 107 | * The default value is "hide". |
| 108 | */ |
Romain Guy | 08bca88 | 2013-02-25 16:21:30 -0800 | [diff] [blame] | 109 | #define PROPERTY_DEBUG_STENCIL_CLIP "debug.hwui.show_non_rect_clip" |
Romain Guy | 3ff0bfd | 2013-02-25 14:15:37 -0800 | [diff] [blame] | 110 | |
| 111 | /** |
John Reck | 23d307c | 2014-10-27 12:38:48 -0700 | [diff] [blame] | 112 | * Turn on to draw dirty regions every other frame. |
| 113 | * |
| 114 | * Possible values: |
| 115 | * "true", to enable dirty regions debugging |
| 116 | * "false", to disable dirty regions debugging |
| 117 | */ |
| 118 | #define PROPERTY_DEBUG_SHOW_DIRTY_REGIONS "debug.hwui.show_dirty_regions" |
| 119 | |
| 120 | /** |
Romain Guy | cf51a41 | 2013-04-08 19:40:31 -0700 | [diff] [blame] | 121 | * Disables draw operation deferral if set to "true", forcing draw |
| 122 | * commands to be issued to OpenGL in order, and processed in sequence |
| 123 | * with state-manipulation canvas commands. |
| 124 | */ |
| 125 | #define PROPERTY_DISABLE_DRAW_DEFER "debug.hwui.disable_draw_defer" |
| 126 | |
| 127 | /** |
| 128 | * Used to disable draw operation reordering when deferring draw operations |
| 129 | * Has no effect if PROPERTY_DISABLE_DRAW_DEFER is set to "true" |
| 130 | */ |
| 131 | #define PROPERTY_DISABLE_DRAW_REORDER "debug.hwui.disable_draw_reorder" |
| 132 | |
John Reck | d04794a | 2015-05-08 10:04:36 -0700 | [diff] [blame] | 133 | /** |
| 134 | * Setting this property will enable or disable the dropping of frames with |
| 135 | * empty damage. Default is "true". |
| 136 | */ |
| 137 | #define PROPERTY_SKIP_EMPTY_DAMAGE "debug.hwui.skip_empty_damage" |
| 138 | |
| 139 | /** |
John Reck | 149173d | 2015-08-10 09:52:29 -0700 | [diff] [blame] | 140 | * Controls whether or not HWUI will use the EGL_EXT_buffer_age extension |
| 141 | * to do partial invalidates. Setting this to "false" will fall back to |
| 142 | * using BUFFER_PRESERVED instead |
| 143 | * Default is "true" |
| 144 | */ |
| 145 | #define PROPERTY_USE_BUFFER_AGE "debug.hwui.use_buffer_age" |
| 146 | |
| 147 | /** |
| 148 | * Setting this to "false" will force HWUI to always do full-redraws of the surface. |
| 149 | * This will disable the use of EGL_EXT_buffer_age and BUFFER_PRESERVED. |
| 150 | * Default is "true" |
| 151 | */ |
ryang | 647bc13 | 2016-09-26 15:57:38 -0400 | [diff] [blame] | 152 | #define PROPERTY_ENABLE_PARTIAL_UPDATES "debug.hwui.use_partial_updates" |
John Reck | 149173d | 2015-08-10 09:52:29 -0700 | [diff] [blame] | 153 | |
John Reck | ec10097 | 2018-04-05 16:41:41 -0700 | [diff] [blame] | 154 | /** |
| 155 | * Setting this to "false" will disable the use of the EGL_ANDROID_presentation_time extension |
| 156 | * and prevents more precise control over swap behavior & timings. |
| 157 | */ |
| 158 | #define PROPERTY_USE_PRESENT_TIME "debug.hwui.use_present_time" |
| 159 | |
John Reck | c7cd9cf | 2016-03-28 10:38:19 -0700 | [diff] [blame] | 160 | #define PROPERTY_FILTER_TEST_OVERHEAD "debug.hwui.filter_test_overhead" |
| 161 | |
Stan Iliev | 03de074 | 2016-07-07 12:35:54 -0400 | [diff] [blame] | 162 | /** |
John Reck | 8dc02f9 | 2017-07-17 09:55:02 -0700 | [diff] [blame] | 163 | * Indicates whether PBOs can be used to back pixel buffers. |
| 164 | * Accepted values are "true" and "false". Default is true. |
| 165 | */ |
| 166 | #define PROPERTY_ENABLE_GPU_PIXEL_BUFFERS "debug.hwui.use_gpu_pixel_buffers" |
| 167 | |
| 168 | /** |
Stan Iliev | 03de074 | 2016-07-07 12:35:54 -0400 | [diff] [blame] | 169 | * Allows to set rendering pipeline mode to OpenGL (default), Skia OpenGL |
| 170 | * or Vulkan. |
| 171 | */ |
Derek Sollenberger | 4badfe6 | 2017-02-14 11:38:06 -0500 | [diff] [blame] | 172 | #define PROPERTY_RENDERER "debug.hwui.renderer" |
Stan Iliev | 03de074 | 2016-07-07 12:35:54 -0400 | [diff] [blame] | 173 | |
Stan Iliev | e9d0012 | 2017-09-19 12:07:10 -0400 | [diff] [blame] | 174 | /** |
| 175 | * Allows to collect a recording of Skia drawing commands. |
| 176 | */ |
| 177 | #define PROPERTY_CAPTURE_SKP_ENABLED "debug.hwui.capture_skp_enabled" |
| 178 | |
Stan Iliev | e9d0012 | 2017-09-19 12:07:10 -0400 | [diff] [blame] | 179 | /** |
| 180 | * Defines how many frames in a sequence to capture. |
| 181 | */ |
John Reck | 1bcacfd | 2017-11-03 10:12:19 -0700 | [diff] [blame] | 182 | #define PROPERTY_CAPTURE_SKP_FRAMES "debug.hwui.capture_skp_frames" |
Stan Iliev | e9d0012 | 2017-09-19 12:07:10 -0400 | [diff] [blame] | 183 | |
| 184 | /** |
| 185 | * File name and location, where a SKP recording will be saved. |
| 186 | */ |
| 187 | #define PROPERTY_CAPTURE_SKP_FILENAME "debug.hwui.skp_filename" |
| 188 | |
Lingfeng Yang | 3a9f223 | 2018-01-24 10:40:18 -0800 | [diff] [blame] | 189 | /** |
| 190 | * Property for whether this is running in the emulator. |
| 191 | */ |
| 192 | #define PROPERTY_QEMU_KERNEL "ro.kernel.qemu" |
| 193 | |
Romain Guy | cf51a41 | 2013-04-08 19:40:31 -0700 | [diff] [blame] | 194 | /////////////////////////////////////////////////////////////////////////////// |
Romain Guy | cf51a41 | 2013-04-08 19:40:31 -0700 | [diff] [blame] | 195 | // Misc |
| 196 | /////////////////////////////////////////////////////////////////////////////// |
| 197 | |
| 198 | // Converts a number of mega-bytes into bytes |
John Reck | 1bcacfd | 2017-11-03 10:12:19 -0700 | [diff] [blame] | 199 | #define MB(s) ((s)*1024 * 1024) |
Romain Guy | 3b748a4 | 2013-04-17 18:54:38 -0700 | [diff] [blame] | 200 | // Converts a number of kilo-bytes into bytes |
John Reck | 1bcacfd | 2017-11-03 10:12:19 -0700 | [diff] [blame] | 201 | #define KB(s) ((s)*1024) |
Romain Guy | cf51a41 | 2013-04-08 19:40:31 -0700 | [diff] [blame] | 202 | |
John Reck | 1bcacfd | 2017-11-03 10:12:19 -0700 | [diff] [blame] | 203 | enum class ProfileType { None, Console, Bars }; |
Chris Craik | 2507c34 | 2015-05-04 14:36:49 -0700 | [diff] [blame] | 204 | |
John Reck | 1bcacfd | 2017-11-03 10:12:19 -0700 | [diff] [blame] | 205 | enum class OverdrawColorSet { Default = 0, Deuteranomaly }; |
Chris Craik | 2507c34 | 2015-05-04 14:36:49 -0700 | [diff] [blame] | 206 | |
John Reck | 1bcacfd | 2017-11-03 10:12:19 -0700 | [diff] [blame] | 207 | enum class StencilClipDebug { Hide, ShowHighlight, ShowRegion }; |
Chris Craik | 2507c34 | 2015-05-04 14:36:49 -0700 | [diff] [blame] | 208 | |
John Reck | 18f442e | 2018-04-09 16:56:34 -0700 | [diff] [blame] | 209 | enum class RenderPipelineType { SkiaGL, SkiaVulkan, NotInitialized = 128 }; |
Stan Iliev | 03de074 | 2016-07-07 12:35:54 -0400 | [diff] [blame] | 210 | |
Chris Craik | 2507c34 | 2015-05-04 14:36:49 -0700 | [diff] [blame] | 211 | /** |
| 212 | * Renderthread-only singleton which manages several static rendering properties. Most of these |
| 213 | * are driven by system properties which are queried once at initialization, and again if init() |
| 214 | * is called. |
| 215 | */ |
| 216 | class Properties { |
| 217 | public: |
| 218 | static bool load(); |
| 219 | |
| 220 | static bool drawDeferDisabled; |
| 221 | static bool drawReorderDisabled; |
| 222 | static bool debugLayersUpdates; |
| 223 | static bool debugOverdraw; |
| 224 | static bool showDirtyRegions; |
John Reck | d04794a | 2015-05-08 10:04:36 -0700 | [diff] [blame] | 225 | // TODO: Remove after stabilization period |
| 226 | static bool skipEmptyFrames; |
John Reck | 149173d | 2015-08-10 09:52:29 -0700 | [diff] [blame] | 227 | static bool useBufferAge; |
| 228 | static bool enablePartialUpdates; |
John Reck | ec10097 | 2018-04-05 16:41:41 -0700 | [diff] [blame] | 229 | static bool usePresentTime; |
Chris Craik | 2507c34 | 2015-05-04 14:36:49 -0700 | [diff] [blame] | 230 | |
John Reck | 8dc02f9 | 2017-07-17 09:55:02 -0700 | [diff] [blame] | 231 | // TODO: Move somewhere else? |
| 232 | static constexpr float textGamma = 1.45f; |
Chris Craik | 9fded23 | 2015-11-11 16:42:34 -0800 | [diff] [blame] | 233 | |
Chris Craik | 2507c34 | 2015-05-04 14:36:49 -0700 | [diff] [blame] | 234 | static DebugLevel debugLevel; |
| 235 | static OverdrawColorSet overdrawColorSet; |
| 236 | static StencilClipDebug debugStencilClip; |
| 237 | |
| 238 | // Override the value for a subset of properties in this class |
| 239 | static void overrideProperty(const char* name, const char* value); |
| 240 | |
| 241 | static float overrideLightRadius; |
| 242 | static float overrideLightPosY; |
| 243 | static float overrideLightPosZ; |
| 244 | static float overrideAmbientRatio; |
| 245 | static int overrideAmbientShadowStrength; |
| 246 | static int overrideSpotShadowStrength; |
| 247 | |
| 248 | static ProfileType getProfileType(); |
Bo Liu | f7340ee | 2017-11-02 16:09:03 -0700 | [diff] [blame] | 249 | ANDROID_API static RenderPipelineType getRenderPipelineType(); |
Chris Craik | 2507c34 | 2015-05-04 14:36:49 -0700 | [diff] [blame] | 250 | |
John Reck | 938e884 | 2017-08-24 13:41:59 -0700 | [diff] [blame] | 251 | ANDROID_API static bool enableHighContrastText; |
| 252 | |
John Reck | 682573c | 2015-10-30 10:37:35 -0700 | [diff] [blame] | 253 | // Should be used only by test apps |
| 254 | static bool waitForGpuCompletion; |
John Reck | f148076 | 2016-07-03 18:28:25 -0700 | [diff] [blame] | 255 | static bool forceDrawFrame; |
John Reck | 682573c | 2015-10-30 10:37:35 -0700 | [diff] [blame] | 256 | |
John Reck | c7cd9cf | 2016-03-28 10:38:19 -0700 | [diff] [blame] | 257 | // Should only be set by automated tests to try and filter out |
| 258 | // any overhead they add |
| 259 | static bool filterOutTestOverhead; |
| 260 | |
John Reck | a896306 | 2017-06-14 10:47:50 -0700 | [diff] [blame] | 261 | // Workaround a device lockup in edge cases by switching to async mode |
| 262 | // instead of the default vsync (b/38372997). Only system_server should hit this. |
| 263 | // Any existing RenderProxy & Surface combination will be unaffected, only things |
| 264 | // created after changing this. |
| 265 | static bool disableVsync; |
| 266 | |
Stan Iliev | e9d0012 | 2017-09-19 12:07:10 -0400 | [diff] [blame] | 267 | static bool skpCaptureEnabled; |
| 268 | |
John Reck | 9f51644 | 2017-09-25 10:27:21 -0700 | [diff] [blame] | 269 | // For experimentation b/68769804 |
| 270 | ANDROID_API static bool enableRTAnimations; |
| 271 | |
John Reck | 113ddd9 | 2017-11-09 16:21:21 -0800 | [diff] [blame] | 272 | // Used for testing only to change the render pipeline. |
Greg Daniel | 98c78da | 2017-01-04 14:45:56 -0500 | [diff] [blame] | 273 | static void overrideRenderPipelineType(RenderPipelineType); |
Greg Daniel | 98c78da | 2017-01-04 14:45:56 -0500 | [diff] [blame] | 274 | |
Lingfeng Yang | 3a9f223 | 2018-01-24 10:40:18 -0800 | [diff] [blame] | 275 | static bool runningInEmulator; |
| 276 | |
John Reck | 6afa009 | 2018-03-01 17:28:35 -0800 | [diff] [blame] | 277 | ANDROID_API static bool debuggingEnabled; |
John Reck | 5642847 | 2018-03-16 17:27:17 -0700 | [diff] [blame] | 278 | ANDROID_API static bool isolatedProcess; |
John Reck | 6afa009 | 2018-03-01 17:28:35 -0800 | [diff] [blame] | 279 | |
Jorim Jaggi | 767e25e | 2018-04-04 23:07:35 +0200 | [diff] [blame] | 280 | ANDROID_API static int contextPriority; |
| 281 | |
Chris Craik | 2507c34 | 2015-05-04 14:36:49 -0700 | [diff] [blame] | 282 | private: |
| 283 | static ProfileType sProfileType; |
| 284 | static bool sDisableProfileBars; |
Stan Iliev | 03de074 | 2016-07-07 12:35:54 -0400 | [diff] [blame] | 285 | static RenderPipelineType sRenderPipelineType; |
John Reck | 1bcacfd | 2017-11-03 10:12:19 -0700 | [diff] [blame] | 286 | }; // class Caches |
Chris Craik | 2507c34 | 2015-05-04 14:36:49 -0700 | [diff] [blame] | 287 | |
John Reck | 1bcacfd | 2017-11-03 10:12:19 -0700 | [diff] [blame] | 288 | }; // namespace uirenderer |
| 289 | }; // namespace android |
Romain Guy | e190aa6 | 2010-11-10 19:01:29 -0800 | [diff] [blame] | 290 | |
John Reck | 1bcacfd | 2017-11-03 10:12:19 -0700 | [diff] [blame] | 291 | #endif // ANDROID_HWUI_PROPERTIES_H |