blob: 8fec42972c2fa54ebeba91d6927b4628e202892c [file] [log] [blame]
Romain Guy51769a62010-07-23 00:28:00 -07001/*
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 Guy5b3b3522010-10-27 18:57:51 -070017#ifndef ANDROID_HWUI_PROPERTIES_H
18#define ANDROID_HWUI_PROPERTIES_H
Romain Guy51769a62010-07-23 00:28:00 -070019
Romain Guyfb8b7632010-08-23 21:05:08 -070020#include <cutils/properties.h>
21
Romain Guy51769a62010-07-23 00:28:00 -070022/**
23 * This file contains the list of system properties used to configure
24 * the OpenGLRenderer.
25 */
26
Chris Craik2507c342015-05-04 14:36:49 -070027namespace android {
28namespace uirenderer {
29
Romain Guycf51a412013-04-08 19:40:31 -070030///////////////////////////////////////////////////////////////////////////////
31// Compile-time properties
32///////////////////////////////////////////////////////////////////////////////
33
Romain Guy28d8ff62011-08-22 14:01:34 -070034// Textures used by layers must have dimensions multiples of this number
35#define LAYER_SIZE 64
36
Romain Guy8d4aeb72013-02-12 16:08:55 -080037// Defines the size in bits of the stencil buffer for the framebuffer
Romain Guyada4d532012-02-02 17:31:16 -080038// Note: Only 1 bit is required for clipping but more bits are required
Romain Guy8d4aeb72013-02-12 16:08:55 -080039// to properly implement overdraw debugging
Romain Guy7c450aa2012-09-21 19:15:00 -070040#define STENCIL_BUFFER_SIZE 8
Romain Guy530041d2012-01-25 18:56:29 -080041
Romain Guycf51a412013-04-08 19:40:31 -070042///////////////////////////////////////////////////////////////////////////////
43// Debug properties
44///////////////////////////////////////////////////////////////////////////////
45
Romain Guye190aa62010-11-10 19:01:29 -080046/**
Romain Guy4ff0cf42012-08-06 14:51:10 -070047 * Debug level for app developers. The value is a numeric value defined
48 * by the DebugLevel enum below.
Romain Guye190aa62010-11-10 19:01:29 -080049 */
Romain Guy4ff0cf42012-08-06 14:51:10 -070050#define PROPERTY_DEBUG "debug.hwui.level"
Romain Guye190aa62010-11-10 19:01:29 -080051
52/**
53 * Debug levels. Debug levels are used as flags.
54 */
55enum DebugLevel {
56 kDebugDisabled = 0,
57 kDebugMemory = 1,
Romain Guy25dc3a72010-12-10 12:33:05 -080058 kDebugCaches = 2,
Kenny Root042f7d62011-07-13 09:49:43 -070059 kDebugMoreCaches = kDebugMemory | kDebugCaches
Romain Guye190aa62010-11-10 19:01:29 -080060};
61
Romain Guy4ff0cf42012-08-06 14:51:10 -070062/**
Romain Guy7c450aa2012-09-21 19:15:00 -070063 * Used to enable/disable layers update debugging. The accepted values are
Romain Guy4ff0cf42012-08-06 14:51:10 -070064 * "true" and "false". The default value is "false".
65 */
66#define PROPERTY_DEBUG_LAYERS_UPDATES "debug.hwui.show_layers_updates"
67
Romain Guy7c450aa2012-09-21 19:15:00 -070068/**
Romain Guy627c6fd2013-08-21 11:53:18 -070069 * 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 Guy7c450aa2012-09-21 19:15:00 -070078 */
Romain Guy78dd96d2013-05-03 14:24:16 -070079#define PROPERTY_DEBUG_OVERDRAW "debug.hwui.overdraw"
Romain Guy7c450aa2012-09-21 19:15:00 -070080
Romain Guy87e2f7572012-09-24 11:37:12 -070081/**
John Reckfe5e7b72014-05-23 17:42:28 -070082 * 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 Guy3ff0bfd2013-02-25 14:15:37 -080098 * 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 Guy08bca882013-02-25 16:21:30 -0800109#define PROPERTY_DEBUG_STENCIL_CLIP "debug.hwui.show_non_rect_clip"
Romain Guy3ff0bfd2013-02-25 14:15:37 -0800110
111/**
John Reck23d307c2014-10-27 12:38:48 -0700112 * 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 Guycf51a412013-04-08 19:40:31 -0700121 * 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 Reckd04794a2015-05-08 10:04:36 -0700133/**
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 Reck149173d2015-08-10 09:52:29 -0700140 * 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 */
152#define PROPERTY_ENABLE_PARTIAL_UPDATES "debug.hwui.enable_partial_updates"
153
John Reckc7cd9cf2016-03-28 10:38:19 -0700154#define PROPERTY_FILTER_TEST_OVERHEAD "debug.hwui.filter_test_overhead"
155
Romain Guycf51a412013-04-08 19:40:31 -0700156///////////////////////////////////////////////////////////////////////////////
157// Runtime configuration properties
158///////////////////////////////////////////////////////////////////////////////
159
160/**
Romain Guy87e2f7572012-09-24 11:37:12 -0700161 * Used to enable/disable scissor optimization. The accepted values are
162 * "true" and "false". The default value is "false".
163 *
164 * When scissor optimization is enabled, OpenGLRenderer will attempt to
165 * minimize the use of scissor by selectively enabling and disabling the
166 * GL scissor test.
167 * When the optimization is disabled, OpenGLRenderer will keep the GL
168 * scissor test enabled and change the scissor rect as needed.
169 * Some GPUs (for instance the SGX 540) perform better when changing
170 * the scissor rect often than when enabling/disabling the scissor test
171 * often.
172 */
173#define PROPERTY_DISABLE_SCISSOR_OPTIMIZATION "ro.hwui.disable_scissor_opt"
174
Chris Craikc3566d02013-02-04 16:16:33 -0800175/**
Romain Guycf51a412013-04-08 19:40:31 -0700176 * Indicates whether PBOs can be used to back pixel buffers.
Romain Guyf9f00162013-05-09 11:50:12 -0700177 * Accepted values are "true" and "false". Default is true.
Chris Craikc3566d02013-02-04 16:16:33 -0800178 */
Romain Guyf9f00162013-05-09 11:50:12 -0700179#define PROPERTY_ENABLE_GPU_PIXEL_BUFFERS "ro.hwui.use_gpu_pixel_buffers"
Chris Craikc3566d02013-02-04 16:16:33 -0800180
Romain Guy51769a62010-07-23 00:28:00 -0700181// These properties are defined in mega-bytes
182#define PROPERTY_TEXTURE_CACHE_SIZE "ro.hwui.texture_cache_size"
183#define PROPERTY_LAYER_CACHE_SIZE "ro.hwui.layer_cache_size"
Romain Guy8d4aeb72013-02-12 16:08:55 -0800184#define PROPERTY_RENDER_BUFFER_CACHE_SIZE "ro.hwui.r_buffer_cache_size"
Romain Guy51769a62010-07-23 00:28:00 -0700185#define PROPERTY_GRADIENT_CACHE_SIZE "ro.hwui.gradient_cache_size"
Romain Guy7fbcc042010-08-04 15:40:07 -0700186#define PROPERTY_PATH_CACHE_SIZE "ro.hwui.path_cache_size"
Chris Craik05f3d6e2014-06-02 16:27:04 -0700187#define PROPERTY_VERTEX_CACHE_SIZE "ro.hwui.vertex_cache_size"
Romain Guy3b748a42013-04-17 18:54:38 -0700188#define PROPERTY_PATCH_CACHE_SIZE "ro.hwui.patch_cache_size"
Romain Guy1e45aae2010-08-13 19:39:53 -0700189#define PROPERTY_DROP_SHADOW_CACHE_SIZE "ro.hwui.drop_shadow_cache_size"
Romain Guye2d345e2010-09-24 18:39:22 -0700190#define PROPERTY_FBO_CACHE_SIZE "ro.hwui.fbo_cache_size"
Romain Guy51769a62010-07-23 00:28:00 -0700191
Romain Guyeca0ca22011-11-04 15:12:29 -0700192// These properties are defined in percentage (range 0..1)
Romain Guy115096f2013-03-19 11:32:41 -0700193#define PROPERTY_TEXTURE_CACHE_FLUSH_RATE "ro.hwui.texture_cache_flushrate"
Romain Guyeca0ca22011-11-04 15:12:29 -0700194
Romain Guy51769a62010-07-23 00:28:00 -0700195// These properties are defined in pixels
Chet Haaseeb32a492012-08-31 13:54:03 -0700196#define PROPERTY_TEXT_SMALL_CACHE_WIDTH "ro.hwui.text_small_cache_width"
197#define PROPERTY_TEXT_SMALL_CACHE_HEIGHT "ro.hwui.text_small_cache_height"
198#define PROPERTY_TEXT_LARGE_CACHE_WIDTH "ro.hwui.text_large_cache_width"
199#define PROPERTY_TEXT_LARGE_CACHE_HEIGHT "ro.hwui.text_large_cache_height"
Romain Guy51769a62010-07-23 00:28:00 -0700200
Romain Guyb45c0c92010-08-26 20:35:23 -0700201// Gamma (>= 1.0, <= 10.0)
Romain Guy6e25e382012-07-18 15:50:29 -0700202#define PROPERTY_TEXT_GAMMA "hwui.text_gamma"
Romain Guyb45c0c92010-08-26 20:35:23 -0700203
Romain Guycf51a412013-04-08 19:40:31 -0700204///////////////////////////////////////////////////////////////////////////////
205// Default property values
206///////////////////////////////////////////////////////////////////////////////
Romain Guyfb8b7632010-08-23 21:05:08 -0700207
Romain Guy09b7c912011-02-02 20:28:09 -0800208#define DEFAULT_TEXTURE_CACHE_SIZE 24.0f
Romain Guy65b345f2011-07-27 18:51:50 -0700209#define DEFAULT_LAYER_CACHE_SIZE 16.0f
Romain Guy8d4aeb72013-02-12 16:08:55 -0800210#define DEFAULT_RENDER_BUFFER_CACHE_SIZE 2.0f
Chris Craik8d34aaf2015-05-11 19:18:11 -0700211#define DEFAULT_PATH_CACHE_SIZE 4.0f
Chris Craik05f3d6e2014-06-02 16:27:04 -0700212#define DEFAULT_VERTEX_CACHE_SIZE 1.0f
Chris Craik11718bc2015-09-22 11:50:13 -0700213#define DEFAULT_PATCH_CACHE_SIZE 128.0f // in kB
Romain Guyfb8b7632010-08-23 21:05:08 -0700214#define DEFAULT_GRADIENT_CACHE_SIZE 0.5f
215#define DEFAULT_DROP_SHADOW_CACHE_SIZE 2.0f
John Recke9cd97e2014-09-17 14:09:26 -0700216#define DEFAULT_FBO_CACHE_SIZE 0
Romain Guyfb8b7632010-08-23 21:05:08 -0700217
Romain Guyeca0ca22011-11-04 15:12:29 -0700218#define DEFAULT_TEXTURE_CACHE_FLUSH_RATE 0.6f
219
Romain Guyb45c0c92010-08-26 20:35:23 -0700220#define DEFAULT_TEXT_GAMMA 1.4f
Romain Guyb45c0c92010-08-26 20:35:23 -0700221
Romain Guycf51a412013-04-08 19:40:31 -0700222///////////////////////////////////////////////////////////////////////////////
223// Misc
224///////////////////////////////////////////////////////////////////////////////
225
226// Converts a number of mega-bytes into bytes
Chih-Hung Hsiehcef190d2016-05-19 15:25:50 -0700227#define MB(s) ((s) * 1024 * 1024)
Romain Guy3b748a42013-04-17 18:54:38 -0700228// Converts a number of kilo-bytes into bytes
Chih-Hung Hsiehcef190d2016-05-19 15:25:50 -0700229#define KB(s) ((s) * 1024)
Romain Guycf51a412013-04-08 19:40:31 -0700230
Chris Craik2507c342015-05-04 14:36:49 -0700231enum class ProfileType {
232 None,
233 Console,
234 Bars
235};
236
237enum class OverdrawColorSet {
238 Default = 0,
239 Deuteranomaly
240};
241
242enum class StencilClipDebug {
243 Hide,
244 ShowHighlight,
245 ShowRegion
246};
247
248/**
249 * Renderthread-only singleton which manages several static rendering properties. Most of these
250 * are driven by system properties which are queried once at initialization, and again if init()
251 * is called.
252 */
253class Properties {
254public:
255 static bool load();
256
257 static bool drawDeferDisabled;
258 static bool drawReorderDisabled;
259 static bool debugLayersUpdates;
260 static bool debugOverdraw;
261 static bool showDirtyRegions;
John Reckd04794a2015-05-08 10:04:36 -0700262 // TODO: Remove after stabilization period
263 static bool skipEmptyFrames;
John Reck149173d2015-08-10 09:52:29 -0700264 static bool useBufferAge;
265 static bool enablePartialUpdates;
Chris Craik2507c342015-05-04 14:36:49 -0700266
Chris Craikc08820f2015-09-22 14:22:29 -0700267 static float textGamma;
268
Chris Craik48a8f432016-02-05 15:59:29 -0800269 static int fboCacheSize;
270 static int gradientCacheSize;
Chris Craik9fded232015-11-11 16:42:34 -0800271 static int layerPoolSize;
Chris Craik48a8f432016-02-05 15:59:29 -0800272 static int patchCacheSize;
273 static int pathCacheSize;
274 static int renderBufferCacheSize;
275 static int tessellationCacheSize;
276 static int textDropShadowCacheSize;
277 static int textureCacheSize;
278 static float textureCacheFlushRate;
Chris Craik9fded232015-11-11 16:42:34 -0800279
Chris Craik2507c342015-05-04 14:36:49 -0700280 static DebugLevel debugLevel;
281 static OverdrawColorSet overdrawColorSet;
282 static StencilClipDebug debugStencilClip;
283
284 // Override the value for a subset of properties in this class
285 static void overrideProperty(const char* name, const char* value);
286
287 static float overrideLightRadius;
288 static float overrideLightPosY;
289 static float overrideLightPosZ;
290 static float overrideAmbientRatio;
291 static int overrideAmbientShadowStrength;
292 static int overrideSpotShadowStrength;
293
294 static ProfileType getProfileType();
295
John Reck682573c2015-10-30 10:37:35 -0700296 // Should be used only by test apps
297 static bool waitForGpuCompletion;
298
John Reckc7cd9cf2016-03-28 10:38:19 -0700299 // Should only be set by automated tests to try and filter out
300 // any overhead they add
301 static bool filterOutTestOverhead;
302
Chris Craik2507c342015-05-04 14:36:49 -0700303private:
304 static ProfileType sProfileType;
305 static bool sDisableProfileBars;
306
307}; // class Caches
308
309}; // namespace uirenderer
310}; // namespace android
Romain Guye190aa62010-11-10 19:01:29 -0800311
Romain Guy5b3b3522010-10-27 18:57:51 -0700312#endif // ANDROID_HWUI_PROPERTIES_H