Properties.h revision eb32a499194119b3783b86c925172df02e5d2685 
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
38// Note: Only 1 bit is required for clipping but more bits are required
39// to properly implement the winding fill rule when rasterizing paths
40#define STENCIL_BUFFER_SIZE 0
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/disbale 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// These properties are defined in mega-bytes
65#define PROPERTY_TEXTURE_CACHE_SIZE "ro.hwui.texture_cache_size"
66#define PROPERTY_LAYER_CACHE_SIZE "ro.hwui.layer_cache_size"
67#define PROPERTY_GRADIENT_CACHE_SIZE "ro.hwui.gradient_cache_size"
68#define PROPERTY_PATH_CACHE_SIZE "ro.hwui.path_cache_size"
69#define PROPERTY_SHAPE_CACHE_SIZE "ro.hwui.shape_cache_size"
70#define PROPERTY_DROP_SHADOW_CACHE_SIZE "ro.hwui.drop_shadow_cache_size"
71#define PROPERTY_FBO_CACHE_SIZE "ro.hwui.fbo_cache_size"
72
73// These properties are defined in percentage (range 0..1)
74#define PROPERTY_TEXTURE_CACHE_FLUSH_RATE "ro.hwui.texture_cache_flush_rate"
75
76// These properties are defined in pixels
77#define PROPERTY_TEXT_SMALL_CACHE_WIDTH "ro.hwui.text_small_cache_width"
78#define PROPERTY_TEXT_SMALL_CACHE_HEIGHT "ro.hwui.text_small_cache_height"
79#define PROPERTY_TEXT_LARGE_CACHE_WIDTH "ro.hwui.text_large_cache_width"
80#define PROPERTY_TEXT_LARGE_CACHE_HEIGHT "ro.hwui.text_large_cache_height"
81
82// Indicates whether gamma correction should be applied in the shaders
83// or in lookup tables. Accepted values:
84//
85//     - "lookup3", correction based on lookup tables. Gamma correction
86//        is different for black and white text (see thresholds below)
87//
88//     - "lookup", correction based on a single lookup table
89//
90//     - "shader3", correction applied by a GLSL shader. Gamma correction
91//        is different for black and white text (see thresholds below)
92//
93//     - "shader", correction applied by a GLSL shader
94//
95// See PROPERTY_TEXT_GAMMA, PROPERTY_TEXT_BLACK_GAMMA_THRESHOLD and
96// PROPERTY_TEXT_WHITE_GAMMA_THRESHOLD for more control.
97#define PROPERTY_TEXT_GAMMA_METHOD "hwui.text_gamma_correction"
98#define DEFAULT_TEXT_GAMMA_METHOD "lookup"
99
100// Gamma (>= 1.0, <= 10.0)
101#define PROPERTY_TEXT_GAMMA "hwui.text_gamma"
102// Luminance threshold below which black gamma correction is applied. Range: [0..255]
103#define PROPERTY_TEXT_BLACK_GAMMA_THRESHOLD "hwui.text_gamma.black_threshold"
104// Lumincance threshold above which white gamma correction is applied. Range: [0..255]
105#define PROPERTY_TEXT_WHITE_GAMMA_THRESHOLD "hwui.text_gamma.white_threshold"
106
107// Converts a number of mega-bytes into bytes
108#define MB(s) s * 1024 * 1024
109
110#define DEFAULT_TEXTURE_CACHE_SIZE 24.0f
111#define DEFAULT_LAYER_CACHE_SIZE 16.0f
112#define DEFAULT_PATH_CACHE_SIZE 4.0f
113#define DEFAULT_SHAPE_CACHE_SIZE 1.0f
114#define DEFAULT_PATCH_CACHE_SIZE 512
115#define DEFAULT_GRADIENT_CACHE_SIZE 0.5f
116#define DEFAULT_DROP_SHADOW_CACHE_SIZE 2.0f
117#define DEFAULT_FBO_CACHE_SIZE 16
118
119#define DEFAULT_TEXTURE_CACHE_FLUSH_RATE 0.6f
120
121#define DEFAULT_TEXT_GAMMA 1.4f
122#define DEFAULT_TEXT_BLACK_GAMMA_THRESHOLD 64
123#define DEFAULT_TEXT_WHITE_GAMMA_THRESHOLD 192
124
125static DebugLevel readDebugLevel() {
126    char property[PROPERTY_VALUE_MAX];
127    if (property_get(PROPERTY_DEBUG, property, NULL) > 0) {
128        return (DebugLevel) atoi(property);
129    }
130    return kDebugDisabled;
131}
132
133#endif // ANDROID_HWUI_PROPERTIES_H
134