Home | History | Annotate | Download | only in hwui 
      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  */
     59 enum 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.
     74  *
     75  * The accepted values are
     76  * "show", to show overdraw
     77  * "show_deuteranomaly", to show overdraw if you suffer from Deuteranomaly
     78  * "count", to show an overdraw counter
     79  * "false", to disable overdraw debugging
     80  *
     81  * The default value is "false".
     82  */
     83 #define PROPERTY_DEBUG_OVERDRAW "debug.hwui.overdraw"
     84 
     85 /**
     86  * Used to enable/disable PerfHUD ES profiling. The accepted values
     87  * are "true" and "false". The default value is "false".
     88  */
     89 #define PROPERTY_DEBUG_NV_PROFILING "debug.hwui.nv_profiling"
     90 
     91 /**
     92  *  System property used to enable or disable hardware rendering profiling.
     93  * The default value of this property is assumed to be false.
     94  *
     95  * When profiling is enabled, the adb shell dumpsys gfxinfo command will
     96  * output extra information about the time taken to execute by the last
     97  * frames.
     98  *
     99  * Possible values:
    100  * "true", to enable profiling
    101  * "visual_bars", to enable profiling and visualize the results on screen
    102  * "false", to disable profiling
    103  */
    104 #define PROPERTY_PROFILE "debug.hwui.profile"
    105 #define PROPERTY_PROFILE_VISUALIZE_BARS "visual_bars"
    106 
    107 /**
    108  * System property used to specify the number of frames to be used
    109  * when doing hardware rendering profiling.
    110  * The default value of this property is #PROFILE_MAX_FRAMES.
    111  *
    112  * When profiling is enabled, the adb shell dumpsys gfxinfo command will
    113  * output extra information about the time taken to execute by the last
    114  * frames.
    115  *
    116  * Possible values:
    117  * "60", to set the limit of frames to 60
    118  */
    119 #define PROPERTY_PROFILE_MAXFRAMES "debug.hwui.profile.maxframes"
    120 
    121 /**
    122  * Used to enable/disable non-rectangular clipping debugging.
    123  *
    124  * The accepted values are:
    125  * "highlight", drawing commands clipped by the stencil will
    126  *              be colored differently
    127  * "region", renders the clipping region on screen whenever
    128  *           the stencil is set
    129  * "hide", don't show the clip
    130  *
    131  * The default value is "hide".
    132  */
    133 #define PROPERTY_DEBUG_STENCIL_CLIP "debug.hwui.show_non_rect_clip"
    134 
    135 /**
    136  * Turn on to draw dirty regions every other frame.
    137  *
    138  * Possible values:
    139  * "true", to enable dirty regions debugging
    140  * "false", to disable dirty regions debugging
    141  */
    142 #define PROPERTY_DEBUG_SHOW_DIRTY_REGIONS "debug.hwui.show_dirty_regions"
    143 
    144 /**
    145  * Disables draw operation deferral if set to "true", forcing draw
    146  * commands to be issued to OpenGL in order, and processed in sequence
    147  * with state-manipulation canvas commands.
    148  */
    149 #define PROPERTY_DISABLE_DRAW_DEFER "debug.hwui.disable_draw_defer"
    150 
    151 /**
    152  * Used to disable draw operation reordering when deferring draw operations
    153  * Has no effect if PROPERTY_DISABLE_DRAW_DEFER is set to "true"
    154  */
    155 #define PROPERTY_DISABLE_DRAW_REORDER "debug.hwui.disable_draw_reorder"
    156 
    157 ///////////////////////////////////////////////////////////////////////////////
    158 // Runtime configuration properties
    159 ///////////////////////////////////////////////////////////////////////////////
    160 
    161 /**
    162  * Used to enable/disable scissor optimization. The accepted values are
    163  * "true" and "false". The default value is "false".
    164  *
    165  * When scissor optimization is enabled, OpenGLRenderer will attempt to
    166  * minimize the use of scissor by selectively enabling and disabling the
    167  * GL scissor test.
    168  * When the optimization is disabled, OpenGLRenderer will keep the GL
    169  * scissor test enabled and change the scissor rect as needed.
    170  * Some GPUs (for instance the SGX 540) perform better when changing
    171  * the scissor rect often than when enabling/disabling the scissor test
    172  * often.
    173  */
    174 #define PROPERTY_DISABLE_SCISSOR_OPTIMIZATION "ro.hwui.disable_scissor_opt"
    175 
    176 /**
    177  * Indicates whether PBOs can be used to back pixel buffers.
    178  * Accepted values are "true" and "false". Default is true.
    179  */
    180 #define PROPERTY_ENABLE_GPU_PIXEL_BUFFERS "ro.hwui.use_gpu_pixel_buffers"
    181 
    182 // These properties are defined in mega-bytes
    183 #define PROPERTY_TEXTURE_CACHE_SIZE "ro.hwui.texture_cache_size"
    184 #define PROPERTY_LAYER_CACHE_SIZE "ro.hwui.layer_cache_size"
    185 #define PROPERTY_RENDER_BUFFER_CACHE_SIZE "ro.hwui.r_buffer_cache_size"
    186 #define PROPERTY_GRADIENT_CACHE_SIZE "ro.hwui.gradient_cache_size"
    187 #define PROPERTY_PATH_CACHE_SIZE "ro.hwui.path_cache_size"
    188 #define PROPERTY_VERTEX_CACHE_SIZE "ro.hwui.vertex_cache_size"
    189 #define PROPERTY_PATCH_CACHE_SIZE "ro.hwui.patch_cache_size"
    190 #define PROPERTY_DROP_SHADOW_CACHE_SIZE "ro.hwui.drop_shadow_cache_size"
    191 #define PROPERTY_FBO_CACHE_SIZE "ro.hwui.fbo_cache_size"
    192 
    193 // These properties are defined in percentage (range 0..1)
    194 #define PROPERTY_TEXTURE_CACHE_FLUSH_RATE "ro.hwui.texture_cache_flushrate"
    195 
    196 // These properties are defined in pixels
    197 #define PROPERTY_TEXT_SMALL_CACHE_WIDTH "ro.hwui.text_small_cache_width"
    198 #define PROPERTY_TEXT_SMALL_CACHE_HEIGHT "ro.hwui.text_small_cache_height"
    199 #define PROPERTY_TEXT_LARGE_CACHE_WIDTH "ro.hwui.text_large_cache_width"
    200 #define PROPERTY_TEXT_LARGE_CACHE_HEIGHT "ro.hwui.text_large_cache_height"
    201 
    202 // Indicates whether gamma correction should be applied in the shaders
    203 // or in lookup tables. Accepted values:
    204 //
    205 //     - "lookup3", correction based on lookup tables. Gamma correction
    206 //        is different for black and white text (see thresholds below)
    207 //
    208 //     - "lookup", correction based on a single lookup table
    209 //
    210 //     - "shader3", correction applied by a GLSL shader. Gamma correction
    211 //        is different for black and white text (see thresholds below)
    212 //
    213 //     - "shader", correction applied by a GLSL shader
    214 //
    215 // See PROPERTY_TEXT_GAMMA, PROPERTY_TEXT_BLACK_GAMMA_THRESHOLD and
    216 // PROPERTY_TEXT_WHITE_GAMMA_THRESHOLD for more control.
    217 #define PROPERTY_TEXT_GAMMA_METHOD "hwui.text_gamma_correction"
    218 #define DEFAULT_TEXT_GAMMA_METHOD "lookup"
    219 
    220 // Gamma (>= 1.0, <= 10.0)
    221 #define PROPERTY_TEXT_GAMMA "hwui.text_gamma"
    222 // Luminance threshold below which black gamma correction is applied. Range: [0..255]
    223 #define PROPERTY_TEXT_BLACK_GAMMA_THRESHOLD "hwui.text_gamma.black_threshold"
    224 // Lumincance threshold above which white gamma correction is applied. Range: [0..255]
    225 #define PROPERTY_TEXT_WHITE_GAMMA_THRESHOLD "hwui.text_gamma.white_threshold"
    226 
    227 ///////////////////////////////////////////////////////////////////////////////
    228 // Default property values
    229 ///////////////////////////////////////////////////////////////////////////////
    230 
    231 #define DEFAULT_TEXTURE_CACHE_SIZE 24.0f
    232 #define DEFAULT_LAYER_CACHE_SIZE 16.0f
    233 #define DEFAULT_RENDER_BUFFER_CACHE_SIZE 2.0f
    234 #define DEFAULT_PATH_CACHE_SIZE 10.0f
    235 #define DEFAULT_VERTEX_CACHE_SIZE 1.0f
    236 #define DEFAULT_PATCH_CACHE_SIZE 128 // in kB
    237 #define DEFAULT_GRADIENT_CACHE_SIZE 0.5f
    238 #define DEFAULT_DROP_SHADOW_CACHE_SIZE 2.0f
    239 #define DEFAULT_FBO_CACHE_SIZE 0
    240 
    241 #define DEFAULT_TEXTURE_CACHE_FLUSH_RATE 0.6f
    242 
    243 #define DEFAULT_TEXT_GAMMA 1.4f
    244 #define DEFAULT_TEXT_BLACK_GAMMA_THRESHOLD 64
    245 #define DEFAULT_TEXT_WHITE_GAMMA_THRESHOLD 192
    246 
    247 ///////////////////////////////////////////////////////////////////////////////
    248 // Misc
    249 ///////////////////////////////////////////////////////////////////////////////
    250 
    251 // Converts a number of mega-bytes into bytes
    252 #define MB(s) s * 1024 * 1024
    253 // Converts a number of kilo-bytes into bytes
    254 #define KB(s) s * 1024
    255 
    256 static DebugLevel readDebugLevel() {
    257     char property[PROPERTY_VALUE_MAX];
    258     if (property_get(PROPERTY_DEBUG, property, NULL) > 0) {
    259         return (DebugLevel) atoi(property);
    260     }
    261     return kDebugDisabled;
    262 }
    263 
    264 #endif // ANDROID_HWUI_PROPERTIES_H
    265