• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 /*  Skia has lots of debug-only code. Often this is just null checks or other
41     parameter checking, but sometimes it can be quite intrusive (e.g. check that
42     each 32bit pixel is in premultiplied form). This code can be very useful
43     during development, but will slow things down in a shipping product.
44 
45     By default, these mutually exclusive flags are defined in SkPreConfig.h,
46     based on the presence or absence of NDEBUG, but that decision can be changed
47     here.
48  */
49 //#define SK_DEBUG
50 //#define SK_RELEASE
51 
52 /*  Skia has certain debug-only code that is extremely intensive even for debug
53     builds.  This code is useful for diagnosing specific issues, but is not
54     generally applicable, therefore it must be explicitly enabled to avoid
55     the performance impact. By default these flags are undefined, but can be
56     enabled by uncommenting them below.
57  */
58 //#define SK_DEBUG_GLYPH_CACHE
59 //#define SK_DEBUG_PATH
60 
61 /*  To assist debugging, Skia provides an instance counting utility in
62     include/core/SkInstCount.h. This flag turns on and off that utility to
63     allow instance count tracking in either debug or release builds. By
64     default it is enabled in debug but disabled in release.
65  */
66 //#define SK_ENABLE_INST_COUNT 1
67 
68 /*  If, in debugging mode, Skia needs to stop (presumably to invoke a debugger)
69     it will call SK_CRASH(). If this is not defined it, it is defined in
70     SkPostConfig.h to write to an illegal address
71  */
72 //#define SK_CRASH() *(int *)(uintptr_t)0 = 0
73 
74 
75 /*  preconfig will have attempted to determine the endianness of the system,
76     but you can change these mutually exclusive flags here.
77  */
78 //#define SK_CPU_BENDIAN
79 //#define SK_CPU_LENDIAN
80 
81 /*  Most compilers use the same bit endianness for bit flags in a byte as the
82     system byte endianness, and this is the default. If for some reason this
83     needs to be overridden, specify which of the mutually exclusive flags to
84     use. For example, some atom processors in certain configurations have big
85     endian byte order but little endian bit orders.
86 */
87 //#define SK_UINT8_BITFIELD_BENDIAN
88 //#define SK_UINT8_BITFIELD_LENDIAN
89 
90 
91 /*  To write debug messages to a console, skia will call SkDebugf(...) following
92     printf conventions (e.g. const char* format, ...). If you want to redirect
93     this to something other than printf, define yours here
94  */
95 //#define SkDebugf(...)  MyFunction(__VA_ARGS__)
96 
97 /*
98  *  To specify a different default font cache limit, define this. If this is
99  *  undefined, skia will use a built-in value.
100  */
101 //#define SK_DEFAULT_FONT_CACHE_LIMIT   (1024 * 1024)
102 
103 /*
104  *  To specify the default size of the image cache, undefine this and set it to
105  *  the desired value (in bytes). SkGraphics.h as a runtime API to set this
106  *  value as well. If this is undefined, a built-in value will be used.
107  */
108 //#define SK_DEFAULT_IMAGE_CACHE_LIMIT (1024 * 1024)
109 
110 /*  If zlib is available and you want to support the flate compression
111     algorithm (used in PDF generation), define SK_ZLIB_INCLUDE to be the
112     include path. Alternatively, define SK_SYSTEM_ZLIB to use the system zlib
113     library specified as "#include <zlib.h>".
114  */
115 //#define SK_ZLIB_INCLUDE <zlib.h>
116 //#define SK_SYSTEM_ZLIB
117 
118 /*  Define this to allow PDF scalars above 32k.  The PDF/A spec doesn't allow
119     them, but modern PDF interpreters should handle them just fine.
120  */
121 //#define SK_ALLOW_LARGE_PDF_SCALARS
122 
123 /*  Define this to provide font subsetter in PDF generation.
124  */
125 //#define SK_SFNTLY_SUBSETTER "sfntly/subsetter/font_subsetter.h"
126 
127 /*  Define this to set the upper limit for text to support LCD. Values that
128     are very large increase the cost in the font cache and draw slower, without
129     improving readability. If this is undefined, Skia will use its default
130     value (e.g. 48)
131  */
132 //#define SK_MAX_SIZE_FOR_LCDTEXT     48
133 
134 /*  If SK_DEBUG is defined, then you can optionally define SK_SUPPORT_UNITTEST
135     which will run additional self-tests at startup. These can take a long time,
136     so this flag is optional.
137  */
138 #ifdef SK_DEBUG
139 //#define SK_SUPPORT_UNITTEST
140 #endif
141 
142 /*  Change the ordering to work in X windows.
143  */
144 #ifdef SK_SAMPLES_FOR_X
145         #define SK_R32_SHIFT    16
146         #define SK_G32_SHIFT    8
147         #define SK_B32_SHIFT    0
148         #define SK_A32_SHIFT    24
149 #endif
150 
151 
152 /* Determines whether to build code that supports the GPU backend. Some classes
153    that are not GPU-specific, such as SkShader subclasses, have optional code
154    that is used allows them to interact with the GPU backend. If you'd like to
155    omit this code set SK_SUPPORT_GPU to 0. This also allows you to omit the gpu
156    directories from your include search path when you're not building the GPU
157    backend. Defaults to 1 (build the GPU code).
158  */
159 //#define SK_SUPPORT_GPU 1
160 
161 
162 /* The PDF generation code uses Path Ops to generate inverse fills and complex
163  * clipping paths, but at this time, Path Ops is not release ready yet. So,
164  * the code is hidden behind this #define guard. If you are feeling adventurous
165  * and want the latest and greatest PDF generation code, uncomment the #define.
166  * When Path Ops is release ready, the define guards and this user config
167  * define should be removed entirely.
168  */
169 //#define SK_PDF_USE_PATHOPS
170 
171 /* Skia uses these defines as the target of include preprocessor directives.
172  * The header files pointed to by these defines provide declarations and
173  * possibly inline implementations of threading primitives.
174  *
175  * See SkThread.h for documentation on what these includes must contain.
176  */
177 //#define SK_ATOMICS_PLATFORM_H "SkAtomics_xxx.h"
178 //#define SK_MUTEX_PLATFORM_H "SkMutex_xxx.h"
179 //#define SK_BARRIERS_PLATFORM_H "SkBarriers_xxx.h"
180 
181 #endif
182