Properties.h revision 115096f50a560e64a7f95d37686d4861042c7aeb
151769a68a5cb34e9564740c6a854fcb93018789dRomain Guy/* 251769a68a5cb34e9564740c6a854fcb93018789dRomain Guy * Copyright (C) 2010 The Android Open Source Project 351769a68a5cb34e9564740c6a854fcb93018789dRomain Guy * 451769a68a5cb34e9564740c6a854fcb93018789dRomain Guy * Licensed under the Apache License, Version 2.0 (the "License"); 551769a68a5cb34e9564740c6a854fcb93018789dRomain Guy * you may not use this file except in compliance with the License. 651769a68a5cb34e9564740c6a854fcb93018789dRomain Guy * You may obtain a copy of the License at 751769a68a5cb34e9564740c6a854fcb93018789dRomain Guy * 851769a68a5cb34e9564740c6a854fcb93018789dRomain Guy * http://www.apache.org/licenses/LICENSE-2.0 951769a68a5cb34e9564740c6a854fcb93018789dRomain Guy * 1051769a68a5cb34e9564740c6a854fcb93018789dRomain Guy * Unless required by applicable law or agreed to in writing, software 1151769a68a5cb34e9564740c6a854fcb93018789dRomain Guy * distributed under the License is distributed on an "AS IS" BASIS, 1251769a68a5cb34e9564740c6a854fcb93018789dRomain Guy * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 1351769a68a5cb34e9564740c6a854fcb93018789dRomain Guy * See the License for the specific language governing permissions and 1451769a68a5cb34e9564740c6a854fcb93018789dRomain Guy * limitations under the License. 1551769a68a5cb34e9564740c6a854fcb93018789dRomain Guy */ 1651769a68a5cb34e9564740c6a854fcb93018789dRomain Guy 175b3b35296e8b2c8d3f07d32bb645d5414db41a1dRomain Guy#ifndef ANDROID_HWUI_PROPERTIES_H 185b3b35296e8b2c8d3f07d32bb645d5414db41a1dRomain Guy#define ANDROID_HWUI_PROPERTIES_H 1951769a68a5cb34e9564740c6a854fcb93018789dRomain Guy 20fb8b763f762ae21923c58d64caa729b012f40e05Romain Guy#include <cutils/properties.h> 21e190aa69756aecfaffabdd4c6d32cb6b3220d842Romain Guy#include <stdlib.h> 22fb8b763f762ae21923c58d64caa729b012f40e05Romain Guy 2351769a68a5cb34e9564740c6a854fcb93018789dRomain Guy/** 2451769a68a5cb34e9564740c6a854fcb93018789dRomain Guy * This file contains the list of system properties used to configure 2551769a68a5cb34e9564740c6a854fcb93018789dRomain Guy * the OpenGLRenderer. 2651769a68a5cb34e9564740c6a854fcb93018789dRomain Guy */ 2751769a68a5cb34e9564740c6a854fcb93018789dRomain Guy 28726aeba80ffc6778a9bc3e0ee957b8d644183505Romain Guy// If turned on, text is interpreted as glyphs instead of UTF-16 29726aeba80ffc6778a9bc3e0ee957b8d644183505Romain Guy#define RENDER_TEXT_AS_GLYPHS 1 30726aeba80ffc6778a9bc3e0ee957b8d644183505Romain Guy 3128d8ff6dbcc1b137131c70b72b4dbd211db7fbd9Romain Guy// Indicates whether to remove the biggest layers first, or the smaller ones 3228d8ff6dbcc1b137131c70b72b4dbd211db7fbd9Romain Guy#define LAYER_REMOVE_BIGGEST_FIRST 0 3328d8ff6dbcc1b137131c70b72b4dbd211db7fbd9Romain Guy 3428d8ff6dbcc1b137131c70b72b4dbd211db7fbd9Romain Guy// Textures used by layers must have dimensions multiples of this number 3528d8ff6dbcc1b137131c70b72b4dbd211db7fbd9Romain Guy#define LAYER_SIZE 64 3628d8ff6dbcc1b137131c70b72b4dbd211db7fbd9Romain Guy 378d4aeb7111afac0c3c7e56d4ad5d92f9cfce2ffdRomain Guy// Defines the size in bits of the stencil buffer for the framebuffer 38ada4d53d50dc869b8278573ad640dc44118d3bcfRomain Guy// Note: Only 1 bit is required for clipping but more bits are required 398d4aeb7111afac0c3c7e56d4ad5d92f9cfce2ffdRomain Guy// to properly implement overdraw debugging 407c450aaa3caac2a05fcb20a177483d0e92378426Romain Guy#define STENCIL_BUFFER_SIZE 8 41530041d3191ce817832a0108514617768e43cda6Romain Guy 42e190aa69756aecfaffabdd4c6d32cb6b3220d842Romain Guy/** 434ff0cf4b83605bff630c4e6f1fabe4f72a3f93a1Romain Guy * Debug level for app developers. The value is a numeric value defined 444ff0cf4b83605bff630c4e6f1fabe4f72a3f93a1Romain Guy * by the DebugLevel enum below. 45e190aa69756aecfaffabdd4c6d32cb6b3220d842Romain Guy */ 464ff0cf4b83605bff630c4e6f1fabe4f72a3f93a1Romain Guy#define PROPERTY_DEBUG "debug.hwui.level" 47e190aa69756aecfaffabdd4c6d32cb6b3220d842Romain Guy 48e190aa69756aecfaffabdd4c6d32cb6b3220d842Romain Guy/** 49e190aa69756aecfaffabdd4c6d32cb6b3220d842Romain Guy * Debug levels. Debug levels are used as flags. 50e190aa69756aecfaffabdd4c6d32cb6b3220d842Romain Guy */ 51e190aa69756aecfaffabdd4c6d32cb6b3220d842Romain Guyenum DebugLevel { 52e190aa69756aecfaffabdd4c6d32cb6b3220d842Romain Guy kDebugDisabled = 0, 53e190aa69756aecfaffabdd4c6d32cb6b3220d842Romain Guy kDebugMemory = 1, 5425dc3a7dbac2f90f5144035e9c8ed99c09cc3132Romain Guy kDebugCaches = 2, 55042f7d64b5ccd7b5b73e7e9814a84576f04fb7d4Kenny Root kDebugMoreCaches = kDebugMemory | kDebugCaches 56e190aa69756aecfaffabdd4c6d32cb6b3220d842Romain Guy}; 57e190aa69756aecfaffabdd4c6d32cb6b3220d842Romain Guy 584ff0cf4b83605bff630c4e6f1fabe4f72a3f93a1Romain Guy/** 597c450aaa3caac2a05fcb20a177483d0e92378426Romain Guy * Used to enable/disable layers update debugging. The accepted values are 604ff0cf4b83605bff630c4e6f1fabe4f72a3f93a1Romain Guy * "true" and "false". The default value is "false". 614ff0cf4b83605bff630c4e6f1fabe4f72a3f93a1Romain Guy */ 624ff0cf4b83605bff630c4e6f1fabe4f72a3f93a1Romain Guy#define PROPERTY_DEBUG_LAYERS_UPDATES "debug.hwui.show_layers_updates" 634ff0cf4b83605bff630c4e6f1fabe4f72a3f93a1Romain Guy 647c450aaa3caac2a05fcb20a177483d0e92378426Romain Guy/** 657c450aaa3caac2a05fcb20a177483d0e92378426Romain Guy * Used to enable/disable overdraw debugging. The accepted values are 667c450aaa3caac2a05fcb20a177483d0e92378426Romain Guy * "true" and "false". The default value is "false". 677c450aaa3caac2a05fcb20a177483d0e92378426Romain Guy */ 687c450aaa3caac2a05fcb20a177483d0e92378426Romain Guy#define PROPERTY_DEBUG_OVERDRAW "debug.hwui.show_overdraw" 697c450aaa3caac2a05fcb20a177483d0e92378426Romain Guy 7087e2f757be9b24d369bab354e37c276e851b1fc7Romain Guy/** 713ff0bfdd144bba3b023eda8c49b25fb0d0de8653Romain Guy * Used to enable/disable non-rectangular clipping debugging. 723ff0bfdd144bba3b023eda8c49b25fb0d0de8653Romain Guy * 733ff0bfdd144bba3b023eda8c49b25fb0d0de8653Romain Guy * The accepted values are: 743ff0bfdd144bba3b023eda8c49b25fb0d0de8653Romain Guy * "highlight", drawing commands clipped by the stencil will 753ff0bfdd144bba3b023eda8c49b25fb0d0de8653Romain Guy * be colored differently 763ff0bfdd144bba3b023eda8c49b25fb0d0de8653Romain Guy * "region", renders the clipping region on screen whenever 773ff0bfdd144bba3b023eda8c49b25fb0d0de8653Romain Guy * the stencil is set 783ff0bfdd144bba3b023eda8c49b25fb0d0de8653Romain Guy * "hide", don't show the clip 793ff0bfdd144bba3b023eda8c49b25fb0d0de8653Romain Guy * 803ff0bfdd144bba3b023eda8c49b25fb0d0de8653Romain Guy * The default value is "hide". 813ff0bfdd144bba3b023eda8c49b25fb0d0de8653Romain Guy */ 8208bca88b272f0006e1581e9c28bc6312490f634eRomain Guy#define PROPERTY_DEBUG_STENCIL_CLIP "debug.hwui.show_non_rect_clip" 833ff0bfdd144bba3b023eda8c49b25fb0d0de8653Romain Guy 843ff0bfdd144bba3b023eda8c49b25fb0d0de8653Romain Guy/** 8587e2f757be9b24d369bab354e37c276e851b1fc7Romain Guy * Used to enable/disable scissor optimization. The accepted values are 8687e2f757be9b24d369bab354e37c276e851b1fc7Romain Guy * "true" and "false". The default value is "false". 8787e2f757be9b24d369bab354e37c276e851b1fc7Romain Guy * 8887e2f757be9b24d369bab354e37c276e851b1fc7Romain Guy * When scissor optimization is enabled, OpenGLRenderer will attempt to 8987e2f757be9b24d369bab354e37c276e851b1fc7Romain Guy * minimize the use of scissor by selectively enabling and disabling the 9087e2f757be9b24d369bab354e37c276e851b1fc7Romain Guy * GL scissor test. 9187e2f757be9b24d369bab354e37c276e851b1fc7Romain Guy * When the optimization is disabled, OpenGLRenderer will keep the GL 9287e2f757be9b24d369bab354e37c276e851b1fc7Romain Guy * scissor test enabled and change the scissor rect as needed. 9387e2f757be9b24d369bab354e37c276e851b1fc7Romain Guy * Some GPUs (for instance the SGX 540) perform better when changing 9487e2f757be9b24d369bab354e37c276e851b1fc7Romain Guy * the scissor rect often than when enabling/disabling the scissor test 9587e2f757be9b24d369bab354e37c276e851b1fc7Romain Guy * often. 9687e2f757be9b24d369bab354e37c276e851b1fc7Romain Guy */ 9787e2f757be9b24d369bab354e37c276e851b1fc7Romain Guy#define PROPERTY_DISABLE_SCISSOR_OPTIMIZATION "ro.hwui.disable_scissor_opt" 9887e2f757be9b24d369bab354e37c276e851b1fc7Romain Guy 99c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik/** 100c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik * Disables draw operation deferral if set to "true", forcing draw 101c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik * commands to be issued to OpenGL in order, and processed in sequence 102c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik * with state-manipulation canvas commands. 103c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik */ 104c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik#define PROPERTY_DISABLE_DRAW_DEFER "debug.hwui.disable_draw_defer" 105c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik 106c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik/** 107c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik * Used to disable draw operation reordering when deferring draw operations 108c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik * Has no effect if PROPERTY_DISABLE_DRAW_DEFER is set to "true" 109c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik */ 110c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik#define PROPERTY_DISABLE_DRAW_REORDER "debug.hwui.disable_draw_reorder" 111c3566d06421c8acc0aafb18f7e307e5725ce87e1Chris Craik 11251769a68a5cb34e9564740c6a854fcb93018789dRomain Guy// These properties are defined in mega-bytes 11351769a68a5cb34e9564740c6a854fcb93018789dRomain Guy#define PROPERTY_TEXTURE_CACHE_SIZE "ro.hwui.texture_cache_size" 11451769a68a5cb34e9564740c6a854fcb93018789dRomain Guy#define PROPERTY_LAYER_CACHE_SIZE "ro.hwui.layer_cache_size" 1158d4aeb7111afac0c3c7e56d4ad5d92f9cfce2ffdRomain Guy#define PROPERTY_RENDER_BUFFER_CACHE_SIZE "ro.hwui.r_buffer_cache_size" 11651769a68a5cb34e9564740c6a854fcb93018789dRomain Guy#define PROPERTY_GRADIENT_CACHE_SIZE "ro.hwui.gradient_cache_size" 1177fbcc0492fca03857e3c45064f4aa040af817d55Romain Guy#define PROPERTY_PATH_CACHE_SIZE "ro.hwui.path_cache_size" 1181e45aae5de003657e5d18f74d34998f5de5db5b7Romain Guy#define PROPERTY_DROP_SHADOW_CACHE_SIZE "ro.hwui.drop_shadow_cache_size" 119e2d345ea67e2960b37bfdc0fc8626d1bfa747404Romain Guy#define PROPERTY_FBO_CACHE_SIZE "ro.hwui.fbo_cache_size" 12051769a68a5cb34e9564740c6a854fcb93018789dRomain Guy 121eca0ca2424afc1e98912405906edfc32f7733e16Romain Guy// These properties are defined in percentage (range 0..1) 122115096f50a560e64a7f95d37686d4861042c7aebRomain Guy#define PROPERTY_TEXTURE_CACHE_FLUSH_RATE "ro.hwui.texture_cache_flushrate" 123eca0ca2424afc1e98912405906edfc32f7733e16Romain Guy 12451769a68a5cb34e9564740c6a854fcb93018789dRomain Guy// These properties are defined in pixels 125eb32a499194119b3783b86c925172df02e5d2685Chet Haase#define PROPERTY_TEXT_SMALL_CACHE_WIDTH "ro.hwui.text_small_cache_width" 126eb32a499194119b3783b86c925172df02e5d2685Chet Haase#define PROPERTY_TEXT_SMALL_CACHE_HEIGHT "ro.hwui.text_small_cache_height" 127eb32a499194119b3783b86c925172df02e5d2685Chet Haase#define PROPERTY_TEXT_LARGE_CACHE_WIDTH "ro.hwui.text_large_cache_width" 128eb32a499194119b3783b86c925172df02e5d2685Chet Haase#define PROPERTY_TEXT_LARGE_CACHE_HEIGHT "ro.hwui.text_large_cache_height" 12951769a68a5cb34e9564740c6a854fcb93018789dRomain Guy 130b1d0a4ed21168fefcb82232c8f22cb95d60acb85Romain Guy// Indicates whether gamma correction should be applied in the shaders 1316e25e38e43f9e7f71397dfab7ed32c81c7bf7d46Romain Guy// or in lookup tables. Accepted values: 1326e25e38e43f9e7f71397dfab7ed32c81c7bf7d46Romain Guy// 1336e25e38e43f9e7f71397dfab7ed32c81c7bf7d46Romain Guy// - "lookup3", correction based on lookup tables. Gamma correction 1346e25e38e43f9e7f71397dfab7ed32c81c7bf7d46Romain Guy// is different for black and white text (see thresholds below) 1356e25e38e43f9e7f71397dfab7ed32c81c7bf7d46Romain Guy// 1366e25e38e43f9e7f71397dfab7ed32c81c7bf7d46Romain Guy// - "lookup", correction based on a single lookup table 1376e25e38e43f9e7f71397dfab7ed32c81c7bf7d46Romain Guy// 1386e25e38e43f9e7f71397dfab7ed32c81c7bf7d46Romain Guy// - "shader3", correction applied by a GLSL shader. Gamma correction 1396e25e38e43f9e7f71397dfab7ed32c81c7bf7d46Romain Guy// is different for black and white text (see thresholds below) 1406e25e38e43f9e7f71397dfab7ed32c81c7bf7d46Romain Guy// 1416e25e38e43f9e7f71397dfab7ed32c81c7bf7d46Romain Guy// - "shader", correction applied by a GLSL shader 1426e25e38e43f9e7f71397dfab7ed32c81c7bf7d46Romain Guy// 1436e25e38e43f9e7f71397dfab7ed32c81c7bf7d46Romain Guy// See PROPERTY_TEXT_GAMMA, PROPERTY_TEXT_BLACK_GAMMA_THRESHOLD and 1446e25e38e43f9e7f71397dfab7ed32c81c7bf7d46Romain Guy// PROPERTY_TEXT_WHITE_GAMMA_THRESHOLD for more control. 145dfab50d8b97a90dca279b119ebe439f595616ffaRomain Guy#define PROPERTY_TEXT_GAMMA_METHOD "hwui.text_gamma_correction" 146dfab50d8b97a90dca279b119ebe439f595616ffaRomain Guy#define DEFAULT_TEXT_GAMMA_METHOD "lookup" 147b1d0a4ed21168fefcb82232c8f22cb95d60acb85Romain Guy 148b45c0c9774bd19a9dbe77d149abae4e124b08bf6Romain Guy// Gamma (>= 1.0, <= 10.0) 1496e25e38e43f9e7f71397dfab7ed32c81c7bf7d46Romain Guy#define PROPERTY_TEXT_GAMMA "hwui.text_gamma" 1506e25e38e43f9e7f71397dfab7ed32c81c7bf7d46Romain Guy// Luminance threshold below which black gamma correction is applied. Range: [0..255] 1516e25e38e43f9e7f71397dfab7ed32c81c7bf7d46Romain Guy#define PROPERTY_TEXT_BLACK_GAMMA_THRESHOLD "hwui.text_gamma.black_threshold" 1526e25e38e43f9e7f71397dfab7ed32c81c7bf7d46Romain Guy// Lumincance threshold above which white gamma correction is applied. Range: [0..255] 1536e25e38e43f9e7f71397dfab7ed32c81c7bf7d46Romain Guy#define PROPERTY_TEXT_WHITE_GAMMA_THRESHOLD "hwui.text_gamma.white_threshold" 154b45c0c9774bd19a9dbe77d149abae4e124b08bf6Romain Guy 155fb8b763f762ae21923c58d64caa729b012f40e05Romain Guy// Converts a number of mega-bytes into bytes 15624edca8b526515979778e577191089a57f5277d7Romain Guy#define MB(s) s * 1024 * 1024 157fb8b763f762ae21923c58d64caa729b012f40e05Romain Guy 15809b7c91de73b59aa3f679b3ae3ba299f82ec9f8aRomain Guy#define DEFAULT_TEXTURE_CACHE_SIZE 24.0f 15965b345fa22b878e141b8fd8ece9c208df00fa40fRomain Guy#define DEFAULT_LAYER_CACHE_SIZE 16.0f 1608d4aeb7111afac0c3c7e56d4ad5d92f9cfce2ffdRomain Guy#define DEFAULT_RENDER_BUFFER_CACHE_SIZE 2.0f 161c46d07a29e94807e768f8b162ce9f77a88ba6f46Romain Guy#define DEFAULT_PATH_CACHE_SIZE 10.0f 1622728f961614a385df1f056fc24803a9f65c90fabRomain Guy#define DEFAULT_PATCH_CACHE_SIZE 512 163fb8b763f762ae21923c58d64caa729b012f40e05Romain Guy#define DEFAULT_GRADIENT_CACHE_SIZE 0.5f 164fb8b763f762ae21923c58d64caa729b012f40e05Romain Guy#define DEFAULT_DROP_SHADOW_CACHE_SIZE 2.0f 16509b7c91de73b59aa3f679b3ae3ba299f82ec9f8aRomain Guy#define DEFAULT_FBO_CACHE_SIZE 16 166fb8b763f762ae21923c58d64caa729b012f40e05Romain Guy 167eca0ca2424afc1e98912405906edfc32f7733e16Romain Guy#define DEFAULT_TEXTURE_CACHE_FLUSH_RATE 0.6f 168eca0ca2424afc1e98912405906edfc32f7733e16Romain Guy 169b45c0c9774bd19a9dbe77d149abae4e124b08bf6Romain Guy#define DEFAULT_TEXT_GAMMA 1.4f 170b45c0c9774bd19a9dbe77d149abae4e124b08bf6Romain Guy#define DEFAULT_TEXT_BLACK_GAMMA_THRESHOLD 64 171b45c0c9774bd19a9dbe77d149abae4e124b08bf6Romain Guy#define DEFAULT_TEXT_WHITE_GAMMA_THRESHOLD 192 172b45c0c9774bd19a9dbe77d149abae4e124b08bf6Romain Guy 173e190aa69756aecfaffabdd4c6d32cb6b3220d842Romain Guystatic DebugLevel readDebugLevel() { 174e190aa69756aecfaffabdd4c6d32cb6b3220d842Romain Guy char property[PROPERTY_VALUE_MAX]; 175e190aa69756aecfaffabdd4c6d32cb6b3220d842Romain Guy if (property_get(PROPERTY_DEBUG, property, NULL) > 0) { 176e190aa69756aecfaffabdd4c6d32cb6b3220d842Romain Guy return (DebugLevel) atoi(property); 177e190aa69756aecfaffabdd4c6d32cb6b3220d842Romain Guy } 178e190aa69756aecfaffabdd4c6d32cb6b3220d842Romain Guy return kDebugDisabled; 179e190aa69756aecfaffabdd4c6d32cb6b3220d842Romain Guy} 180e190aa69756aecfaffabdd4c6d32cb6b3220d842Romain Guy 1815b3b35296e8b2c8d3f07d32bb645d5414db41a1dRomain Guy#endif // ANDROID_HWUI_PROPERTIES_H 182