Properties.h revision c08820f587ad94698691a6657e87712de07e484c 
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#include <utils/Singleton.h>
23
24/**
25 * This file contains the list of system properties used to configure
26 * the OpenGLRenderer.
27 */
28
29namespace android {
30namespace uirenderer {
31
32///////////////////////////////////////////////////////////////////////////////
33// Compile-time properties
34///////////////////////////////////////////////////////////////////////////////
35
36// If turned on, text is interpreted as glyphs instead of UTF-16
37#define RENDER_TEXT_AS_GLYPHS 1
38
39// Textures used by layers must have dimensions multiples of this number
40#define LAYER_SIZE 64
41
42// Defines the size in bits of the stencil buffer for the framebuffer
43// Note: Only 1 bit is required for clipping but more bits are required
44// to properly implement overdraw debugging
45#define STENCIL_BUFFER_SIZE 8
46
47///////////////////////////////////////////////////////////////////////////////
48// Debug properties
49///////////////////////////////////////////////////////////////////////////////
50
51/**
52 * Debug level for app developers. The value is a numeric value defined
53 * by the DebugLevel enum below.
54 */
55#define PROPERTY_DEBUG "debug.hwui.level"
56
57/**
58 * Debug levels. Debug levels are used as flags.
59 */
60enum DebugLevel {
61    kDebugDisabled = 0,
62    kDebugMemory = 1,
63    kDebugCaches = 2,
64    kDebugMoreCaches = kDebugMemory | kDebugCaches
65};
66
67/**
68 * Used to enable/disable layers update debugging. The accepted values are
69 * "true" and "false". The default value is "false".
70 */
71#define PROPERTY_DEBUG_LAYERS_UPDATES "debug.hwui.show_layers_updates"
72
73/**
74 * Used to enable/disable overdraw debugging.
75 *
76 * The accepted values are
77 * "show", to show overdraw
78 * "show_deuteranomaly", to show overdraw if you suffer from Deuteranomaly
79 * "count", to show an overdraw counter
80 * "false", to disable overdraw debugging
81 *
82 * The default value is "false".
83 */
84#define PROPERTY_DEBUG_OVERDRAW "debug.hwui.overdraw"
85
86/**
87 *  System property used to enable or disable hardware rendering profiling.
88 * The default value of this property is assumed to be false.
89 *
90 * When profiling is enabled, the adb shell dumpsys gfxinfo command will
91 * output extra information about the time taken to execute by the last
92 * frames.
93 *
94 * Possible values:
95 * "true", to enable profiling
96 * "visual_bars", to enable profiling and visualize the results on screen
97 * "false", to disable profiling
98 */
99#define PROPERTY_PROFILE "debug.hwui.profile"
100#define PROPERTY_PROFILE_VISUALIZE_BARS "visual_bars"
101
102/**
103 * Used to enable/disable non-rectangular clipping debugging.
104 *
105 * The accepted values are:
106 * "highlight", drawing commands clipped by the stencil will
107 *              be colored differently
108 * "region", renders the clipping region on screen whenever
109 *           the stencil is set
110 * "hide", don't show the clip
111 *
112 * The default value is "hide".
113 */
114#define PROPERTY_DEBUG_STENCIL_CLIP "debug.hwui.show_non_rect_clip"
115
116/**
117 * Turn on to draw dirty regions every other frame.
118 *
119 * Possible values:
120 * "true", to enable dirty regions debugging
121 * "false", to disable dirty regions debugging
122 */
123#define PROPERTY_DEBUG_SHOW_DIRTY_REGIONS "debug.hwui.show_dirty_regions"
124
125/**
126 * Disables draw operation deferral if set to "true", forcing draw
127 * commands to be issued to OpenGL in order, and processed in sequence
128 * with state-manipulation canvas commands.
129 */
130#define PROPERTY_DISABLE_DRAW_DEFER "debug.hwui.disable_draw_defer"
131
132/**
133 * Used to disable draw operation reordering when deferring draw operations
134 * Has no effect if PROPERTY_DISABLE_DRAW_DEFER is set to "true"
135 */
136#define PROPERTY_DISABLE_DRAW_REORDER "debug.hwui.disable_draw_reorder"
137
138/**
139 * Setting this property will enable or disable the dropping of frames with
140 * empty damage. Default is "true".
141 */
142#define PROPERTY_SKIP_EMPTY_DAMAGE "debug.hwui.skip_empty_damage"
143
144/**
145 * Setting this property will enable or disable usage of EGL_KHR_swap_buffers_with_damage
146 * See: https://www.khronos.org/registry/egl/extensions/KHR/EGL_KHR_swap_buffers_with_damage.txt
147 * Default is "true"
148 */
149#define PROPERTY_SWAP_WITH_DAMAGE "debug.hwui.swap_with_damage"
150
151/**
152 * Controls whether or not HWUI will use the EGL_EXT_buffer_age extension
153 * to do partial invalidates. Setting this to "false" will fall back to
154 * using BUFFER_PRESERVED instead
155 * Default is "true"
156 */
157#define PROPERTY_USE_BUFFER_AGE "debug.hwui.use_buffer_age"
158
159/**
160 * Setting this to "false" will force HWUI to always do full-redraws of the surface.
161 * This will disable the use of EGL_EXT_buffer_age and BUFFER_PRESERVED.
162 * Default is "true"
163 */
164#define PROPERTY_ENABLE_PARTIAL_UPDATES "debug.hwui.enable_partial_updates"
165
166///////////////////////////////////////////////////////////////////////////////
167// Runtime configuration properties
168///////////////////////////////////////////////////////////////////////////////
169
170/**
171 * Used to enable/disable scissor optimization. The accepted values are
172 * "true" and "false". The default value is "false".
173 *
174 * When scissor optimization is enabled, OpenGLRenderer will attempt to
175 * minimize the use of scissor by selectively enabling and disabling the
176 * GL scissor test.
177 * When the optimization is disabled, OpenGLRenderer will keep the GL
178 * scissor test enabled and change the scissor rect as needed.
179 * Some GPUs (for instance the SGX 540) perform better when changing
180 * the scissor rect often than when enabling/disabling the scissor test
181 * often.
182 */
183#define PROPERTY_DISABLE_SCISSOR_OPTIMIZATION "ro.hwui.disable_scissor_opt"
184
185/**
186 * Indicates whether PBOs can be used to back pixel buffers.
187 * Accepted values are "true" and "false". Default is true.
188 */
189#define PROPERTY_ENABLE_GPU_PIXEL_BUFFERS "ro.hwui.use_gpu_pixel_buffers"
190
191// These properties are defined in mega-bytes
192#define PROPERTY_TEXTURE_CACHE_SIZE "ro.hwui.texture_cache_size"
193#define PROPERTY_LAYER_CACHE_SIZE "ro.hwui.layer_cache_size"
194#define PROPERTY_RENDER_BUFFER_CACHE_SIZE "ro.hwui.r_buffer_cache_size"
195#define PROPERTY_GRADIENT_CACHE_SIZE "ro.hwui.gradient_cache_size"
196#define PROPERTY_PATH_CACHE_SIZE "ro.hwui.path_cache_size"
197#define PROPERTY_VERTEX_CACHE_SIZE "ro.hwui.vertex_cache_size"
198#define PROPERTY_PATCH_CACHE_SIZE "ro.hwui.patch_cache_size"
199#define PROPERTY_DROP_SHADOW_CACHE_SIZE "ro.hwui.drop_shadow_cache_size"
200#define PROPERTY_FBO_CACHE_SIZE "ro.hwui.fbo_cache_size"
201
202// These properties are defined in percentage (range 0..1)
203#define PROPERTY_TEXTURE_CACHE_FLUSH_RATE "ro.hwui.texture_cache_flushrate"
204
205// These properties are defined in pixels
206#define PROPERTY_TEXT_SMALL_CACHE_WIDTH "ro.hwui.text_small_cache_width"
207#define PROPERTY_TEXT_SMALL_CACHE_HEIGHT "ro.hwui.text_small_cache_height"
208#define PROPERTY_TEXT_LARGE_CACHE_WIDTH "ro.hwui.text_large_cache_width"
209#define PROPERTY_TEXT_LARGE_CACHE_HEIGHT "ro.hwui.text_large_cache_height"
210
211// Gamma (>= 1.0, <= 10.0)
212#define PROPERTY_TEXT_GAMMA "hwui.text_gamma"
213
214///////////////////////////////////////////////////////////////////////////////
215// Default property values
216///////////////////////////////////////////////////////////////////////////////
217
218#define DEFAULT_TEXTURE_CACHE_SIZE 24.0f
219#define DEFAULT_LAYER_CACHE_SIZE 16.0f
220#define DEFAULT_RENDER_BUFFER_CACHE_SIZE 2.0f
221#define DEFAULT_PATH_CACHE_SIZE 4.0f
222#define DEFAULT_VERTEX_CACHE_SIZE 1.0f
223#define DEFAULT_PATCH_CACHE_SIZE 128.0f // in kB
224#define DEFAULT_GRADIENT_CACHE_SIZE 0.5f
225#define DEFAULT_DROP_SHADOW_CACHE_SIZE 2.0f
226#define DEFAULT_FBO_CACHE_SIZE 0
227
228#define DEFAULT_TEXTURE_CACHE_FLUSH_RATE 0.6f
229
230#define DEFAULT_TEXT_GAMMA 1.4f
231
232///////////////////////////////////////////////////////////////////////////////
233// Misc
234///////////////////////////////////////////////////////////////////////////////
235
236// Converts a number of mega-bytes into bytes
237#define MB(s) s * 1024 * 1024
238// Converts a number of kilo-bytes into bytes
239#define KB(s) s * 1024
240
241enum class ProfileType {
242    None,
243    Console,
244    Bars
245};
246
247enum class OverdrawColorSet {
248    Default = 0,
249    Deuteranomaly
250};
251
252enum class StencilClipDebug {
253    Hide,
254    ShowHighlight,
255    ShowRegion
256};
257
258/**
259 * Renderthread-only singleton which manages several static rendering properties. Most of these
260 * are driven by system properties which are queried once at initialization, and again if init()
261 * is called.
262 */
263class Properties {
264public:
265    static bool load();
266
267    static bool drawDeferDisabled;
268    static bool drawReorderDisabled;
269    static bool debugLayersUpdates;
270    static bool debugOverdraw;
271    static bool showDirtyRegions;
272    // TODO: Remove after stabilization period
273    static bool skipEmptyFrames;
274    // TODO: Remove after stabilization period
275    static bool swapBuffersWithDamage;
276    static bool useBufferAge;
277    static bool enablePartialUpdates;
278
279    static float textGamma;
280
281    static DebugLevel debugLevel;
282    static OverdrawColorSet overdrawColorSet;
283    static StencilClipDebug debugStencilClip;
284
285    // Override the value for a subset of properties in this class
286    static void overrideProperty(const char* name, const char* value);
287
288    static float overrideLightRadius;
289    static float overrideLightPosY;
290    static float overrideLightPosZ;
291    static float overrideAmbientRatio;
292    static int overrideAmbientShadowStrength;
293    static int overrideSpotShadowStrength;
294
295    static ProfileType getProfileType();
296
297private:
298    static ProfileType sProfileType;
299    static bool sDisableProfileBars;
300
301}; // class Caches
302
303}; // namespace uirenderer
304}; // namespace android
305
306#endif // ANDROID_HWUI_PROPERTIES_H
307