Home | History | Annotate | Download | only in config
      1 
      2 /*
      3  * Copyright 2006 The Android Open Source Project
      4  *
      5  * Use of this source code is governed by a BSD-style license that can be
      6  * found in the LICENSE file.
      7  */
      8 
      9 
     10 #ifndef SkUserConfig_DEFINED
     11 #define SkUserConfig_DEFINED
     12 
     13 /*  SkTypes.h, the root of the public header files, does the following trick:
     14 
     15     #include "SkPreConfig.h"
     16     #include "SkUserConfig.h"
     17     #include "SkPostConfig.h"
     18 
     19     SkPreConfig.h runs first, and it is responsible for initializing certain
     20     skia defines.
     21 
     22     SkPostConfig.h runs last, and its job is to just check that the final
     23     defines are consistent (i.e. that we don't have mutually conflicting
     24     defines).
     25 
     26     SkUserConfig.h (this file) runs in the middle. It gets to change or augment
     27     the list of flags initially set in preconfig, and then postconfig checks
     28     that everything still makes sense.
     29 
     30     Below are optional defines that add, subtract, or change default behavior
     31     in Skia. Your port can locally edit this file to enable/disable flags as
     32     you choose, or these can be delared on your command line (i.e. -Dfoo).
     33 
     34     By default, this include file will always default to having all of the flags
     35     commented out, so including it will have no effect.
     36 */
     37 
     38 ///////////////////////////////////////////////////////////////////////////////
     39 
     40 /*  Scalars (the fractional value type in skia) can be implemented either as
     41     floats or 16.16 integers (fixed). Exactly one of these two symbols must be
     42     defined.
     43 */
     44 //#define SK_SCALAR_IS_FLOAT
     45 //#define SK_SCALAR_IS_FIXED
     46 
     47 
     48 /*  For some performance-critical scalar operations, skia will optionally work
     49     around the standard float operators if it knows that the CPU does not have
     50     native support for floats. If your environment uses software floating point,
     51     define this flag.
     52  */
     53 //#define SK_SOFTWARE_FLOAT
     54 
     55 
     56 /*  Skia has lots of debug-only code. Often this is just null checks or other
     57     parameter checking, but sometimes it can be quite intrusive (e.g. check that
     58     each 32bit pixel is in premultiplied form). This code can be very useful
     59     during development, but will slow things down in a shipping product.
     60 
     61     By default, these mutually exclusive flags are defined in SkPreConfig.h,
     62     based on the presence or absence of NDEBUG, but that decision can be changed
     63     here.
     64  */
     65 //#define SK_DEBUG
     66 //#define SK_RELEASE
     67 
     68 /*  Skia has certain debug-only code that is extremely intensive even for debug
     69     builds.  This code is useful for diagnosing specific issues, but is not
     70     generally applicable, therefore it must be explicitly enabled to avoid
     71     the performance impact. By default these flags are undefined, but can be
     72     enabled by uncommenting them below.
     73  */
     74 //#define SK_DEBUG_GLYPH_CACHE
     75 //#define SK_DEBUG_PATH
     76 
     77 /*  To assist debugging, Skia provides an instance counting utility in
     78     include/core/SkInstCount.h. This flag turns on and off that utility to
     79     allow instance count tracking in either debug or release builds. By
     80     default it is enabled in debug but disabled in release.
     81  */
     82 //#define SK_ENABLE_INST_COUNT 1
     83 
     84 /*  If, in debugging mode, Skia needs to stop (presumably to invoke a debugger)
     85     it will call SK_CRASH(). If this is not defined it, it is defined in
     86     SkPostConfig.h to write to an illegal address
     87  */
     88 //#define SK_CRASH() *(int *)(uintptr_t)0 = 0
     89 
     90 
     91 /*  preconfig will have attempted to determine the endianness of the system,
     92     but you can change these mutually exclusive flags here.
     93  */
     94 //#define SK_CPU_BENDIAN
     95 //#define SK_CPU_LENDIAN
     96 
     97 /*  Most compilers use the same bit endianness for bit flags in a byte as the
     98     system byte endianness, and this is the default. If for some reason this
     99     needs to be overridden, specify which of the mutually exclusive flags to
    100     use. For example, some atom processors in certain configurations have big
    101     endian byte order but little endian bit orders.
    102 */
    103 //#define SK_UINT8_BITFIELD_BENDIAN
    104 //#define SK_UINT8_BITFIELD_LENDIAN
    105 
    106 
    107 /*  Some compilers don't support long long for 64bit integers. If yours does
    108     not, define this to the appropriate type.
    109  */
    110 //#define SkLONGLONG int64_t
    111 
    112 
    113 /*  To write debug messages to a console, skia will call SkDebugf(...) following
    114     printf conventions (e.g. const char* format, ...). If you want to redirect
    115     this to something other than printf, define yours here
    116  */
    117 //#define SkDebugf(...)  MyFunction(__VA_ARGS__)
    118 
    119 /*
    120  *  To specify a different default font cache limit, define this. If this is
    121  *  undefined, skia will use a built-in value.
    122  */
    123 //#define SK_DEFAULT_FONT_CACHE_LIMIT   (1024 * 1024)
    124 
    125 /*
    126  *  To specify the default size of the image cache, undefine this and set it to
    127  *  the desired value (in bytes). SkGraphics.h as a runtime API to set this
    128  *  value as well. If this is undefined, a built-in value will be used.
    129  */
    130 //#define SK_DEFAULT_IMAGE_CACHE_LIMIT (1024 * 1024)
    131 
    132 /*  If zlib is available and you want to support the flate compression
    133     algorithm (used in PDF generation), define SK_ZLIB_INCLUDE to be the
    134     include path. Alternatively, define SK_SYSTEM_ZLIB to use the system zlib
    135     library specified as "#include <zlib.h>".
    136  */
    137 //#define SK_ZLIB_INCLUDE <zlib.h>
    138 //#define SK_SYSTEM_ZLIB
    139 
    140 /*  Define this to allow PDF scalars above 32k.  The PDF/A spec doesn't allow
    141     them, but modern PDF interpreters should handle them just fine.
    142  */
    143 //#define SK_ALLOW_LARGE_PDF_SCALARS
    144 
    145 /*  Define this to provide font subsetter in PDF generation.
    146  */
    147 //#define SK_SFNTLY_SUBSETTER "sfntly/subsetter/font_subsetter.h"
    148 
    149 /*  Define this to set the upper limit for text to support LCD. Values that
    150     are very large increase the cost in the font cache and draw slower, without
    151     improving readability. If this is undefined, Skia will use its default
    152     value (e.g. 48)
    153  */
    154 //#define SK_MAX_SIZE_FOR_LCDTEXT     48
    155 
    156 /*  If SK_DEBUG is defined, then you can optionally define SK_SUPPORT_UNITTEST
    157     which will run additional self-tests at startup. These can take a long time,
    158     so this flag is optional.
    159  */
    160 #ifdef SK_DEBUG
    161 //#define SK_SUPPORT_UNITTEST
    162 #endif
    163 
    164 /* If your system embeds skia and has complex event logging, define this
    165    symbol to name a file that maps the following macros to your system's
    166    equivalents:
    167        SK_TRACE_EVENT0(event)
    168        SK_TRACE_EVENT1(event, name1, value1)
    169        SK_TRACE_EVENT2(event, name1, value1, name2, value2)
    170    src/utils/SkDebugTrace.h has a trivial implementation that writes to
    171    the debug output stream. If SK_USER_TRACE_INCLUDE_FILE is not defined,
    172    SkTrace.h will define the above three macros to do nothing.
    173 */
    174 //#undef SK_USER_TRACE_INCLUDE_FILE
    175 
    176 /*  Change the ordering to work in X windows.
    177  */
    178 #ifdef SK_SAMPLES_FOR_X
    179         #define SK_R32_SHIFT    16
    180         #define SK_G32_SHIFT    8
    181         #define SK_B32_SHIFT    0
    182         #define SK_A32_SHIFT    24
    183 #endif
    184 
    185 
    186 /* Determines whether to build code that supports the GPU backend. Some classes
    187    that are not GPU-specific, such as SkShader subclasses, have optional code
    188    that is used allows them to interact with the GPU backend. If you'd like to
    189    omit this code set SK_SUPPORT_GPU to 0. This also allows you to omit the gpu
    190    directories from your include search path when you're not building the GPU
    191    backend. Defaults to 1 (build the GPU code).
    192  */
    193 //#define SK_SUPPORT_GPU 1
    194 
    195 
    196 /* The PDF generation code uses Path Ops to generate inverse fills and complex
    197  * clipping paths, but at this time, Path Ops is not release ready yet. So,
    198  * the code is hidden behind this #define guard. If you are feeling adventurous
    199  * and want the latest and greatest PDF generation code, uncomment the #define.
    200  * When Path Ops is release ready, the define guards and this user config
    201  * define should be removed entirely.
    202  */
    203 //#define SK_PDF_USE_PATHOPS
    204 
    205 #endif
    206