Properties.h revision c46d07a29e94807e768f8b162ce9f77a88ba6f46 
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// If turned on, text is interpreted as glyphs instead of UTF-16
29#define RENDER_TEXT_AS_GLYPHS 1
30
31// Indicates whether to remove the biggest layers first, or the smaller ones
32#define LAYER_REMOVE_BIGGEST_FIRST 0
33
34// Textures used by layers must have dimensions multiples of this number
35#define LAYER_SIZE 64
36
37// Defines the size in bits of the stencil buffer for the framebuffer
38// Note: Only 1 bit is required for clipping but more bits are required
39// to properly implement overdraw debugging
40#define STENCIL_BUFFER_SIZE 8
41
42/**
43 * Debug level for app developers. The value is a numeric value defined
44 * by the DebugLevel enum below.
45 */
46#define PROPERTY_DEBUG "debug.hwui.level"
47
48/**
49 * Debug levels. Debug levels are used as flags.
50 */
51enum DebugLevel {
52    kDebugDisabled = 0,
53    kDebugMemory = 1,
54    kDebugCaches = 2,
55    kDebugMoreCaches = kDebugMemory | kDebugCaches
56};
57
58/**
59 * Used to enable/disable layers update debugging. The accepted values are
60 * "true" and "false". The default value is "false".
61 */
62#define PROPERTY_DEBUG_LAYERS_UPDATES "debug.hwui.show_layers_updates"
63
64/**
65 * Used to enable/disable overdraw debugging. The accepted values are
66 * "true" and "false". The default value is "false".
67 */
68#define PROPERTY_DEBUG_OVERDRAW "debug.hwui.show_overdraw"
69
70/**
71 * Used to enable/disable non-rectangular clipping debugging.
72 *
73 * The accepted values are:
74 * "highlight", drawing commands clipped by the stencil will
75 *              be colored differently
76 * "region", renders the clipping region on screen whenever
77 *           the stencil is set
78 * "hide", don't show the clip
79 *
80 * The default value is "hide".
81 */
82#define PROPERTY_DEBUG_STENCIL_CLIP "debug.hwui.show_non_rect_clip"
83
84/**
85 * Used to enable/disable scissor optimization. The accepted values are
86 * "true" and "false". The default value is "false".
87 *
88 * When scissor optimization is enabled, OpenGLRenderer will attempt to
89 * minimize the use of scissor by selectively enabling and disabling the
90 * GL scissor test.
91 * When the optimization is disabled, OpenGLRenderer will keep the GL
92 * scissor test enabled and change the scissor rect as needed.
93 * Some GPUs (for instance the SGX 540) perform better when changing
94 * the scissor rect often than when enabling/disabling the scissor test
95 * often.
96 */
97#define PROPERTY_DISABLE_SCISSOR_OPTIMIZATION "ro.hwui.disable_scissor_opt"
98
99/**
100 * Disables draw operation deferral if set to "true", forcing draw
101 * commands to be issued to OpenGL in order, and processed in sequence
102 * with state-manipulation canvas commands.
103 */
104#define PROPERTY_DISABLE_DRAW_DEFER "debug.hwui.disable_draw_defer"
105
106/**
107 * Used to disable draw operation reordering when deferring draw operations
108 * Has no effect if PROPERTY_DISABLE_DRAW_DEFER is set to "true"
109 */
110#define PROPERTY_DISABLE_DRAW_REORDER "debug.hwui.disable_draw_reorder"
111
112// These properties are defined in mega-bytes
113#define PROPERTY_TEXTURE_CACHE_SIZE "ro.hwui.texture_cache_size"
114#define PROPERTY_LAYER_CACHE_SIZE "ro.hwui.layer_cache_size"
115#define PROPERTY_RENDER_BUFFER_CACHE_SIZE "ro.hwui.r_buffer_cache_size"
116#define PROPERTY_GRADIENT_CACHE_SIZE "ro.hwui.gradient_cache_size"
117#define PROPERTY_PATH_CACHE_SIZE "ro.hwui.path_cache_size"
118#define PROPERTY_DROP_SHADOW_CACHE_SIZE "ro.hwui.drop_shadow_cache_size"
119#define PROPERTY_FBO_CACHE_SIZE "ro.hwui.fbo_cache_size"
120
121// These properties are defined in percentage (range 0..1)
122#define PROPERTY_TEXTURE_CACHE_FLUSH_RATE "ro.hwui.texture_cache_flush_rate"
123
124// These properties are defined in pixels
125#define PROPERTY_TEXT_SMALL_CACHE_WIDTH "ro.hwui.text_small_cache_width"
126#define PROPERTY_TEXT_SMALL_CACHE_HEIGHT "ro.hwui.text_small_cache_height"
127#define PROPERTY_TEXT_LARGE_CACHE_WIDTH "ro.hwui.text_large_cache_width"
128#define PROPERTY_TEXT_LARGE_CACHE_HEIGHT "ro.hwui.text_large_cache_height"
129
130// Indicates whether gamma correction should be applied in the shaders
131// or in lookup tables. Accepted values:
132//
133//     - "lookup3", correction based on lookup tables. Gamma correction
134//        is different for black and white text (see thresholds below)
135//
136//     - "lookup", correction based on a single lookup table
137//
138//     - "shader3", correction applied by a GLSL shader. Gamma correction
139//        is different for black and white text (see thresholds below)
140//
141//     - "shader", correction applied by a GLSL shader
142//
143// See PROPERTY_TEXT_GAMMA, PROPERTY_TEXT_BLACK_GAMMA_THRESHOLD and
144// PROPERTY_TEXT_WHITE_GAMMA_THRESHOLD for more control.
145#define PROPERTY_TEXT_GAMMA_METHOD "hwui.text_gamma_correction"
146#define DEFAULT_TEXT_GAMMA_METHOD "lookup"
147
148// Gamma (>= 1.0, <= 10.0)
149#define PROPERTY_TEXT_GAMMA "hwui.text_gamma"
150// Luminance threshold below which black gamma correction is applied. Range: [0..255]
151#define PROPERTY_TEXT_BLACK_GAMMA_THRESHOLD "hwui.text_gamma.black_threshold"
152// Lumincance threshold above which white gamma correction is applied. Range: [0..255]
153#define PROPERTY_TEXT_WHITE_GAMMA_THRESHOLD "hwui.text_gamma.white_threshold"
154
155// Converts a number of mega-bytes into bytes
156#define MB(s) s * 1024 * 1024
157
158#define DEFAULT_TEXTURE_CACHE_SIZE 24.0f
159#define DEFAULT_LAYER_CACHE_SIZE 16.0f
160#define DEFAULT_RENDER_BUFFER_CACHE_SIZE 2.0f
161#define DEFAULT_PATH_CACHE_SIZE 10.0f
162#define DEFAULT_PATCH_CACHE_SIZE 512
163#define DEFAULT_GRADIENT_CACHE_SIZE 0.5f
164#define DEFAULT_DROP_SHADOW_CACHE_SIZE 2.0f
165#define DEFAULT_FBO_CACHE_SIZE 16
166
167#define DEFAULT_TEXTURE_CACHE_FLUSH_RATE 0.6f
168
169#define DEFAULT_TEXT_GAMMA 1.4f
170#define DEFAULT_TEXT_BLACK_GAMMA_THRESHOLD 64
171#define DEFAULT_TEXT_WHITE_GAMMA_THRESHOLD 192
172
173static DebugLevel readDebugLevel() {
174    char property[PROPERTY_VALUE_MAX];
175    if (property_get(PROPERTY_DEBUG, property, NULL) > 0) {
176        return (DebugLevel) atoi(property);
177    }
178    return kDebugDisabled;
179}
180
181#endif // ANDROID_HWUI_PROPERTIES_H
182