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
17 #ifndef ANDROID_HWUI_PROPERTIES_H
18 #define ANDROID_HWUI_PROPERTIES_H
19
20 #include <cutils/properties.h>
21 #include <stdlib.h>
22
23 /**
24 * This file contains the list of system properties used to configure
25 * the OpenGLRenderer.
26 */
27
28 ///////////////////////////////////////////////////////////////////////////////
29 // Compile-time properties
30 ///////////////////////////////////////////////////////////////////////////////
31
32 // If turned on, text is interpreted as glyphs instead of UTF-16
33 #define RENDER_TEXT_AS_GLYPHS 1
34
35 // 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
41 // Defines the size in bits of the stencil buffer for the framebuffer
42 // Note: Only 1 bit is required for clipping but more bits are required
43 // to properly implement overdraw debugging
44 #define STENCIL_BUFFER_SIZE 8
45
46 ///////////////////////////////////////////////////////////////////////////////
47 // Debug properties
48 ///////////////////////////////////////////////////////////////////////////////
49
50 /**
51 * Debug level for app developers. The value is a numeric value defined
52 * by the DebugLevel enum below.
53 */
54 #define PROPERTY_DEBUG "debug.hwui.level"
55
56 /**
57 * Debug levels. Debug levels are used as flags.
58 */
59 enum DebugLevel {
60 kDebugDisabled = 0,
61 kDebugMemory = 1,
62 kDebugCaches = 2,
63 kDebugMoreCaches = kDebugMemory | kDebugCaches
64 };
65
66 /**
67 * Used to enable/disable layers update debugging. The accepted values are
68 * "true" and "false". The default value is "false".
69 */
70 #define PROPERTY_DEBUG_LAYERS_UPDATES "debug.hwui.show_layers_updates"
71
72 /**
73 * 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".
82 */
83 #define PROPERTY_DEBUG_OVERDRAW "debug.hwui.overdraw"
84
85 /**
86 * 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 /**
92 * 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 */
103 #define PROPERTY_DEBUG_STENCIL_CLIP "debug.hwui.show_non_rect_clip"
104
105 /**
106 * 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 /**
123 * 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
137 /**
138 * Indicates whether PBOs can be used to back pixel buffers.
139 * Accepted values are "true" and "false". Default is true.
140 */
141 #define PROPERTY_ENABLE_GPU_PIXEL_BUFFERS "ro.hwui.use_gpu_pixel_buffers"
142
143 // 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"
146 #define PROPERTY_RENDER_BUFFER_CACHE_SIZE "ro.hwui.r_buffer_cache_size"
147 #define PROPERTY_GRADIENT_CACHE_SIZE "ro.hwui.gradient_cache_size"
148 #define PROPERTY_PATH_CACHE_SIZE "ro.hwui.path_cache_size"
149 #define PROPERTY_PATCH_CACHE_SIZE "ro.hwui.patch_cache_size"
150 #define PROPERTY_DROP_SHADOW_CACHE_SIZE "ro.hwui.drop_shadow_cache_size"
151 #define PROPERTY_FBO_CACHE_SIZE "ro.hwui.fbo_cache_size"
152
153 // These properties are defined in percentage (range 0..1)
154 #define PROPERTY_TEXTURE_CACHE_FLUSH_RATE "ro.hwui.texture_cache_flushrate"
155
156 // These properties are defined in pixels
157 #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"
161
162 // Indicates whether gamma correction should be applied in the shaders
163 // 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.
177 #define PROPERTY_TEXT_GAMMA_METHOD "hwui.text_gamma_correction"
178 #define DEFAULT_TEXT_GAMMA_METHOD "lookup"
179
180 // Gamma (>= 1.0, <= 10.0)
181 #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"
186
187 ///////////////////////////////////////////////////////////////////////////////
188 // Default property values
189 ///////////////////////////////////////////////////////////////////////////////
190
191 #define DEFAULT_TEXTURE_CACHE_SIZE 24.0f
192 #define DEFAULT_LAYER_CACHE_SIZE 16.0f
193 #define DEFAULT_RENDER_BUFFER_CACHE_SIZE 2.0f
194 #define DEFAULT_PATH_CACHE_SIZE 10.0f
195 #define DEFAULT_PATCH_CACHE_SIZE 128 // in kB
196 #define DEFAULT_GRADIENT_CACHE_SIZE 0.5f
197 #define DEFAULT_DROP_SHADOW_CACHE_SIZE 2.0f
198 #define DEFAULT_FBO_CACHE_SIZE 16
199
200 #define DEFAULT_TEXTURE_CACHE_FLUSH_RATE 0.6f
201
202 #define DEFAULT_TEXT_GAMMA 1.4f
203 #define DEFAULT_TEXT_BLACK_GAMMA_THRESHOLD 64
204 #define DEFAULT_TEXT_WHITE_GAMMA_THRESHOLD 192
205
206 ///////////////////////////////////////////////////////////////////////////////
207 // Misc
208 ///////////////////////////////////////////////////////////////////////////////
209
210 // Converts a number of mega-bytes into bytes
211 #define MB(s) s * 1024 * 1024
212 // Converts a number of kilo-bytes into bytes
213 #define KB(s) s * 1024
214
readDebugLevel()215 static 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
223 #endif // ANDROID_HWUI_PROPERTIES_H
224