Properties.h revision f9f0016b1ff816eb2c7561eed482c056189005f8
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 */ 59enum 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. The accepted values are 74 * "show", "count" and "false". The default value is "false". 75 */ 76#define PROPERTY_DEBUG_OVERDRAW "debug.hwui.overdraw" 77 78/** 79 * Used to enable/disable non-rectangular clipping debugging. 80 * 81 * The accepted values are: 82 * "highlight", drawing commands clipped by the stencil will 83 * be colored differently 84 * "region", renders the clipping region on screen whenever 85 * the stencil is set 86 * "hide", don't show the clip 87 * 88 * The default value is "hide". 89 */ 90#define PROPERTY_DEBUG_STENCIL_CLIP "debug.hwui.show_non_rect_clip" 91 92/** 93 * Disables draw operation deferral if set to "true", forcing draw 94 * commands to be issued to OpenGL in order, and processed in sequence 95 * with state-manipulation canvas commands. 96 */ 97#define PROPERTY_DISABLE_DRAW_DEFER "debug.hwui.disable_draw_defer" 98 99/** 100 * Used to disable draw operation reordering when deferring draw operations 101 * Has no effect if PROPERTY_DISABLE_DRAW_DEFER is set to "true" 102 */ 103#define PROPERTY_DISABLE_DRAW_REORDER "debug.hwui.disable_draw_reorder" 104 105/////////////////////////////////////////////////////////////////////////////// 106// Runtime configuration properties 107/////////////////////////////////////////////////////////////////////////////// 108 109/** 110 * Used to enable/disable scissor optimization. The accepted values are 111 * "true" and "false". The default value is "false". 112 * 113 * When scissor optimization is enabled, OpenGLRenderer will attempt to 114 * minimize the use of scissor by selectively enabling and disabling the 115 * GL scissor test. 116 * When the optimization is disabled, OpenGLRenderer will keep the GL 117 * scissor test enabled and change the scissor rect as needed. 118 * Some GPUs (for instance the SGX 540) perform better when changing 119 * the scissor rect often than when enabling/disabling the scissor test 120 * often. 121 */ 122#define PROPERTY_DISABLE_SCISSOR_OPTIMIZATION "ro.hwui.disable_scissor_opt" 123 124/** 125 * Indicates whether PBOs can be used to back pixel buffers. 126 * Accepted values are "true" and "false". Default is true. 127 */ 128#define PROPERTY_ENABLE_GPU_PIXEL_BUFFERS "ro.hwui.use_gpu_pixel_buffers" 129 130// These properties are defined in mega-bytes 131#define PROPERTY_TEXTURE_CACHE_SIZE "ro.hwui.texture_cache_size" 132#define PROPERTY_LAYER_CACHE_SIZE "ro.hwui.layer_cache_size" 133#define PROPERTY_RENDER_BUFFER_CACHE_SIZE "ro.hwui.r_buffer_cache_size" 134#define PROPERTY_GRADIENT_CACHE_SIZE "ro.hwui.gradient_cache_size" 135#define PROPERTY_PATH_CACHE_SIZE "ro.hwui.path_cache_size" 136#define PROPERTY_PATCH_CACHE_SIZE "ro.hwui.patch_cache_size" 137#define PROPERTY_DROP_SHADOW_CACHE_SIZE "ro.hwui.drop_shadow_cache_size" 138#define PROPERTY_FBO_CACHE_SIZE "ro.hwui.fbo_cache_size" 139 140// These properties are defined in percentage (range 0..1) 141#define PROPERTY_TEXTURE_CACHE_FLUSH_RATE "ro.hwui.texture_cache_flushrate" 142 143// These properties are defined in pixels 144#define PROPERTY_TEXT_SMALL_CACHE_WIDTH "ro.hwui.text_small_cache_width" 145#define PROPERTY_TEXT_SMALL_CACHE_HEIGHT "ro.hwui.text_small_cache_height" 146#define PROPERTY_TEXT_LARGE_CACHE_WIDTH "ro.hwui.text_large_cache_width" 147#define PROPERTY_TEXT_LARGE_CACHE_HEIGHT "ro.hwui.text_large_cache_height" 148 149// Indicates whether gamma correction should be applied in the shaders 150// or in lookup tables. Accepted values: 151// 152// - "lookup3", correction based on lookup tables. Gamma correction 153// is different for black and white text (see thresholds below) 154// 155// - "lookup", correction based on a single lookup table 156// 157// - "shader3", correction applied by a GLSL shader. Gamma correction 158// is different for black and white text (see thresholds below) 159// 160// - "shader", correction applied by a GLSL shader 161// 162// See PROPERTY_TEXT_GAMMA, PROPERTY_TEXT_BLACK_GAMMA_THRESHOLD and 163// PROPERTY_TEXT_WHITE_GAMMA_THRESHOLD for more control. 164#define PROPERTY_TEXT_GAMMA_METHOD "hwui.text_gamma_correction" 165#define DEFAULT_TEXT_GAMMA_METHOD "lookup" 166 167// Gamma (>= 1.0, <= 10.0) 168#define PROPERTY_TEXT_GAMMA "hwui.text_gamma" 169// Luminance threshold below which black gamma correction is applied. Range: [0..255] 170#define PROPERTY_TEXT_BLACK_GAMMA_THRESHOLD "hwui.text_gamma.black_threshold" 171// Lumincance threshold above which white gamma correction is applied. Range: [0..255] 172#define PROPERTY_TEXT_WHITE_GAMMA_THRESHOLD "hwui.text_gamma.white_threshold" 173 174/////////////////////////////////////////////////////////////////////////////// 175// Default property values 176/////////////////////////////////////////////////////////////////////////////// 177 178#define DEFAULT_TEXTURE_CACHE_SIZE 24.0f 179#define DEFAULT_LAYER_CACHE_SIZE 16.0f 180#define DEFAULT_RENDER_BUFFER_CACHE_SIZE 2.0f 181#define DEFAULT_PATH_CACHE_SIZE 10.0f 182#define DEFAULT_PATCH_CACHE_SIZE 128 // in kB 183#define DEFAULT_GRADIENT_CACHE_SIZE 0.5f 184#define DEFAULT_DROP_SHADOW_CACHE_SIZE 2.0f 185#define DEFAULT_FBO_CACHE_SIZE 16 186 187#define DEFAULT_TEXTURE_CACHE_FLUSH_RATE 0.6f 188 189#define DEFAULT_TEXT_GAMMA 1.4f 190#define DEFAULT_TEXT_BLACK_GAMMA_THRESHOLD 64 191#define DEFAULT_TEXT_WHITE_GAMMA_THRESHOLD 192 192 193/////////////////////////////////////////////////////////////////////////////// 194// Misc 195/////////////////////////////////////////////////////////////////////////////// 196 197// Converts a number of mega-bytes into bytes 198#define MB(s) s * 1024 * 1024 199// Converts a number of kilo-bytes into bytes 200#define KB(s) s * 1024 201 202static DebugLevel readDebugLevel() { 203 char property[PROPERTY_VALUE_MAX]; 204 if (property_get(PROPERTY_DEBUG, property, NULL) > 0) { 205 return (DebugLevel) atoi(property); 206 } 207 return kDebugDisabled; 208} 209 210#endif // ANDROID_HWUI_PROPERTIES_H 211