blob: 20b8f2f6e1656361c10149afbc77973ad6aaaac9 [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>
Romain Guye190aa62010-11-10 19:01:29 -080021#include <stdlib.h>
Romain Guyfb8b7632010-08-23 21:05:08 -070022
Romain Guy51769a62010-07-23 00:28:00 -070023/**
24 * This file contains the list of system properties used to configure
25 * the OpenGLRenderer.
26 */
27
Romain Guycf51a412013-04-08 19:40:31 -070028///////////////////////////////////////////////////////////////////////////////
29// Compile-time properties
30///////////////////////////////////////////////////////////////////////////////
31
Romain Guy726aeba2011-06-01 14:52:00 -070032// If turned on, text is interpreted as glyphs instead of UTF-16
33#define RENDER_TEXT_AS_GLYPHS 1
34
Romain Guy28d8ff62011-08-22 14:01:34 -070035// Indicates whether to remove the biggest layers first, or the smaller ones
36#define LAYER_REMOVE_BIGGEST_FIRST 0
37
38// Textures used by layers must have dimensions multiples of this number
39#define LAYER_SIZE 64
40
Romain Guy8d4aeb72013-02-12 16:08:55 -080041// Defines the size in bits of the stencil buffer for the framebuffer
Romain Guyada4d532012-02-02 17:31:16 -080042// Note: Only 1 bit is required for clipping but more bits are required
Romain Guy8d4aeb72013-02-12 16:08:55 -080043// to properly implement overdraw debugging
Romain Guy7c450aa2012-09-21 19:15:00 -070044#define STENCIL_BUFFER_SIZE 8
Romain Guy530041d2012-01-25 18:56:29 -080045
Romain Guycf51a412013-04-08 19:40:31 -070046///////////////////////////////////////////////////////////////////////////////
47// Debug properties
48///////////////////////////////////////////////////////////////////////////////
49
Romain Guye190aa62010-11-10 19:01:29 -080050/**
Romain Guy4ff0cf42012-08-06 14:51:10 -070051 * Debug level for app developers. The value is a numeric value defined
52 * by the DebugLevel enum below.
Romain Guye190aa62010-11-10 19:01:29 -080053 */
Romain Guy4ff0cf42012-08-06 14:51:10 -070054#define PROPERTY_DEBUG "debug.hwui.level"
Romain Guye190aa62010-11-10 19:01:29 -080055
56/**
57 * Debug levels. Debug levels are used as flags.
58 */
59enum DebugLevel {
60 kDebugDisabled = 0,
61 kDebugMemory = 1,
Romain Guy25dc3a72010-12-10 12:33:05 -080062 kDebugCaches = 2,
Kenny Root042f7d62011-07-13 09:49:43 -070063 kDebugMoreCaches = kDebugMemory | kDebugCaches
Romain Guye190aa62010-11-10 19:01:29 -080064};
65
Romain Guy4ff0cf42012-08-06 14:51:10 -070066/**
Romain Guy7c450aa2012-09-21 19:15:00 -070067 * Used to enable/disable layers update debugging. The accepted values are
Romain Guy4ff0cf42012-08-06 14:51:10 -070068 * "true" and "false". The default value is "false".
69 */
70#define PROPERTY_DEBUG_LAYERS_UPDATES "debug.hwui.show_layers_updates"
71
Romain Guy7c450aa2012-09-21 19:15:00 -070072/**
Romain Guy627c6fd2013-08-21 11:53:18 -070073 * Used to enable/disable overdraw debugging.
74 *
75 * The accepted values are
76 * "show", to show overdraw
77 * "show_deuteranomaly", to show overdraw if you suffer from Deuteranomaly
78 * "count", to show an overdraw counter
79 * "false", to disable overdraw debugging
80 *
81 * The default value is "false".
Romain Guy7c450aa2012-09-21 19:15:00 -070082 */
Romain Guy78dd96d2013-05-03 14:24:16 -070083#define PROPERTY_DEBUG_OVERDRAW "debug.hwui.overdraw"
Romain Guy7c450aa2012-09-21 19:15:00 -070084
Romain Guy87e2f7572012-09-24 11:37:12 -070085/**
Romain Guy31e08e92013-06-18 15:53:53 -070086 * Used to enable/disable PerfHUD ES profiling. The accepted values
87 * are "true" and "false". The default value is "false".
88 */
89#define PROPERTY_DEBUG_NV_PROFILING "debug.hwui.nv_profiling"
90
91/**
Romain Guy3ff0bfd2013-02-25 14:15:37 -080092 * Used to enable/disable non-rectangular clipping debugging.
93 *
94 * The accepted values are:
95 * "highlight", drawing commands clipped by the stencil will
96 * be colored differently
97 * "region", renders the clipping region on screen whenever
98 * the stencil is set
99 * "hide", don't show the clip
100 *
101 * The default value is "hide".
102 */
Romain Guy08bca882013-02-25 16:21:30 -0800103#define PROPERTY_DEBUG_STENCIL_CLIP "debug.hwui.show_non_rect_clip"
Romain Guy3ff0bfd2013-02-25 14:15:37 -0800104
105/**
Romain Guycf51a412013-04-08 19:40:31 -0700106 * Disables draw operation deferral if set to "true", forcing draw
107 * commands to be issued to OpenGL in order, and processed in sequence
108 * with state-manipulation canvas commands.
109 */
110#define PROPERTY_DISABLE_DRAW_DEFER "debug.hwui.disable_draw_defer"
111
112/**
113 * Used to disable draw operation reordering when deferring draw operations
114 * Has no effect if PROPERTY_DISABLE_DRAW_DEFER is set to "true"
115 */
116#define PROPERTY_DISABLE_DRAW_REORDER "debug.hwui.disable_draw_reorder"
117
118///////////////////////////////////////////////////////////////////////////////
119// Runtime configuration properties
120///////////////////////////////////////////////////////////////////////////////
121
122/**
Romain Guy87e2f7572012-09-24 11:37:12 -0700123 * Used to enable/disable scissor optimization. The accepted values are
124 * "true" and "false". The default value is "false".
125 *
126 * When scissor optimization is enabled, OpenGLRenderer will attempt to
127 * minimize the use of scissor by selectively enabling and disabling the
128 * GL scissor test.
129 * When the optimization is disabled, OpenGLRenderer will keep the GL
130 * scissor test enabled and change the scissor rect as needed.
131 * Some GPUs (for instance the SGX 540) perform better when changing
132 * the scissor rect often than when enabling/disabling the scissor test
133 * often.
134 */
135#define PROPERTY_DISABLE_SCISSOR_OPTIMIZATION "ro.hwui.disable_scissor_opt"
136
Chris Craikc3566d02013-02-04 16:16:33 -0800137/**
Romain Guycf51a412013-04-08 19:40:31 -0700138 * Indicates whether PBOs can be used to back pixel buffers.
Romain Guyf9f00162013-05-09 11:50:12 -0700139 * Accepted values are "true" and "false". Default is true.
Chris Craikc3566d02013-02-04 16:16:33 -0800140 */
Romain Guyf9f00162013-05-09 11:50:12 -0700141#define PROPERTY_ENABLE_GPU_PIXEL_BUFFERS "ro.hwui.use_gpu_pixel_buffers"
Chris Craikc3566d02013-02-04 16:16:33 -0800142
Romain Guy51769a62010-07-23 00:28:00 -0700143// These properties are defined in mega-bytes
144#define PROPERTY_TEXTURE_CACHE_SIZE "ro.hwui.texture_cache_size"
145#define PROPERTY_LAYER_CACHE_SIZE "ro.hwui.layer_cache_size"
Romain Guy8d4aeb72013-02-12 16:08:55 -0800146#define PROPERTY_RENDER_BUFFER_CACHE_SIZE "ro.hwui.r_buffer_cache_size"
Romain Guy51769a62010-07-23 00:28:00 -0700147#define PROPERTY_GRADIENT_CACHE_SIZE "ro.hwui.gradient_cache_size"
Romain Guy7fbcc042010-08-04 15:40:07 -0700148#define PROPERTY_PATH_CACHE_SIZE "ro.hwui.path_cache_size"
Romain Guy3b748a42013-04-17 18:54:38 -0700149#define PROPERTY_PATCH_CACHE_SIZE "ro.hwui.patch_cache_size"
Romain Guy1e45aae2010-08-13 19:39:53 -0700150#define PROPERTY_DROP_SHADOW_CACHE_SIZE "ro.hwui.drop_shadow_cache_size"
Romain Guye2d345e2010-09-24 18:39:22 -0700151#define PROPERTY_FBO_CACHE_SIZE "ro.hwui.fbo_cache_size"
Romain Guy51769a62010-07-23 00:28:00 -0700152
Romain Guyeca0ca22011-11-04 15:12:29 -0700153// These properties are defined in percentage (range 0..1)
Romain Guy115096f2013-03-19 11:32:41 -0700154#define PROPERTY_TEXTURE_CACHE_FLUSH_RATE "ro.hwui.texture_cache_flushrate"
Romain Guyeca0ca22011-11-04 15:12:29 -0700155
Romain Guy51769a62010-07-23 00:28:00 -0700156// These properties are defined in pixels
Chet Haaseeb32a492012-08-31 13:54:03 -0700157#define PROPERTY_TEXT_SMALL_CACHE_WIDTH "ro.hwui.text_small_cache_width"
158#define PROPERTY_TEXT_SMALL_CACHE_HEIGHT "ro.hwui.text_small_cache_height"
159#define PROPERTY_TEXT_LARGE_CACHE_WIDTH "ro.hwui.text_large_cache_width"
160#define PROPERTY_TEXT_LARGE_CACHE_HEIGHT "ro.hwui.text_large_cache_height"
Romain Guy51769a62010-07-23 00:28:00 -0700161
Romain Guyb1d0a4e2012-07-13 18:25:35 -0700162// Indicates whether gamma correction should be applied in the shaders
Romain Guy6e25e382012-07-18 15:50:29 -0700163// or in lookup tables. Accepted values:
164//
165// - "lookup3", correction based on lookup tables. Gamma correction
166// is different for black and white text (see thresholds below)
167//
168// - "lookup", correction based on a single lookup table
169//
170// - "shader3", correction applied by a GLSL shader. Gamma correction
171// is different for black and white text (see thresholds below)
172//
173// - "shader", correction applied by a GLSL shader
174//
175// See PROPERTY_TEXT_GAMMA, PROPERTY_TEXT_BLACK_GAMMA_THRESHOLD and
176// PROPERTY_TEXT_WHITE_GAMMA_THRESHOLD for more control.
Romain Guydfab50d2012-07-18 17:06:37 -0700177#define PROPERTY_TEXT_GAMMA_METHOD "hwui.text_gamma_correction"
178#define DEFAULT_TEXT_GAMMA_METHOD "lookup"
Romain Guyb1d0a4e2012-07-13 18:25:35 -0700179
Romain Guyb45c0c92010-08-26 20:35:23 -0700180// Gamma (>= 1.0, <= 10.0)
Romain Guy6e25e382012-07-18 15:50:29 -0700181#define PROPERTY_TEXT_GAMMA "hwui.text_gamma"
182// Luminance threshold below which black gamma correction is applied. Range: [0..255]
183#define PROPERTY_TEXT_BLACK_GAMMA_THRESHOLD "hwui.text_gamma.black_threshold"
184// Lumincance threshold above which white gamma correction is applied. Range: [0..255]
185#define PROPERTY_TEXT_WHITE_GAMMA_THRESHOLD "hwui.text_gamma.white_threshold"
Romain Guyb45c0c92010-08-26 20:35:23 -0700186
Romain Guycf51a412013-04-08 19:40:31 -0700187///////////////////////////////////////////////////////////////////////////////
188// Default property values
189///////////////////////////////////////////////////////////////////////////////
Romain Guyfb8b7632010-08-23 21:05:08 -0700190
Romain Guy09b7c912011-02-02 20:28:09 -0800191#define DEFAULT_TEXTURE_CACHE_SIZE 24.0f
Romain Guy65b345f2011-07-27 18:51:50 -0700192#define DEFAULT_LAYER_CACHE_SIZE 16.0f
Romain Guy8d4aeb72013-02-12 16:08:55 -0800193#define DEFAULT_RENDER_BUFFER_CACHE_SIZE 2.0f
Romain Guyc46d07a2013-03-15 19:06:39 -0700194#define DEFAULT_PATH_CACHE_SIZE 10.0f
Romain Guy3b748a42013-04-17 18:54:38 -0700195#define DEFAULT_PATCH_CACHE_SIZE 128 // in kB
Romain Guyfb8b7632010-08-23 21:05:08 -0700196#define DEFAULT_GRADIENT_CACHE_SIZE 0.5f
197#define DEFAULT_DROP_SHADOW_CACHE_SIZE 2.0f
Romain Guy09b7c912011-02-02 20:28:09 -0800198#define DEFAULT_FBO_CACHE_SIZE 16
Romain Guyfb8b7632010-08-23 21:05:08 -0700199
Romain Guyeca0ca22011-11-04 15:12:29 -0700200#define DEFAULT_TEXTURE_CACHE_FLUSH_RATE 0.6f
201
Romain Guyb45c0c92010-08-26 20:35:23 -0700202#define DEFAULT_TEXT_GAMMA 1.4f
203#define DEFAULT_TEXT_BLACK_GAMMA_THRESHOLD 64
204#define DEFAULT_TEXT_WHITE_GAMMA_THRESHOLD 192
205
Romain Guycf51a412013-04-08 19:40:31 -0700206///////////////////////////////////////////////////////////////////////////////
207// Misc
208///////////////////////////////////////////////////////////////////////////////
209
210// Converts a number of mega-bytes into bytes
211#define MB(s) s * 1024 * 1024
Romain Guy3b748a42013-04-17 18:54:38 -0700212// Converts a number of kilo-bytes into bytes
213#define KB(s) s * 1024
Romain Guycf51a412013-04-08 19:40:31 -0700214
Romain Guye190aa62010-11-10 19:01:29 -0800215static DebugLevel readDebugLevel() {
216 char property[PROPERTY_VALUE_MAX];
217 if (property_get(PROPERTY_DEBUG, property, NULL) > 0) {
218 return (DebugLevel) atoi(property);
219 }
220 return kDebugDisabled;
221}
222
Romain Guy5b3b3522010-10-27 18:57:51 -0700223#endif // ANDROID_HWUI_PROPERTIES_H