Build Configuration

Collaboration diagram for Build Configuration:


Detailed Description

These macros are available to tune the behavior of the toolkit. They will always be prefixed with DWFTK_


Modules

 General ANSI Build Configuration
 These macros are available to alter the functionality of the toolkit built for any platform (though with some emphasis/preference for Linux and BSD systems.).
 Microsoft Windows Build Configuration
 These macros are available to alter the functionality of the toolkit built for Microsoft Windows platforms.
 Apple Macintosh OS X Build Configuration
 These macros are available to alter the functionality of the toolkit built for Apple Macintosh OS X platforms.

Defines

#define DWFTK_BUILD_EXPAT
 Indicates Expat XML parser will be built into the library; also used by clients of the library with Expat built-in.
#define DWFTK_BUILD_JPEG
 Indicates the JPEG Library (libjpeg) will be built into the library; also used by clients of the libary with libjpeg built-in.
#define DISABLE_STREAM_JPEG
 Indicates the inline JPEG compression code in the 3D toolkit will be disabled.
#define DWFTK_XML_PARSER_BUFFER_BYTES   16384
 Indicates the size of the heap buffer used to cache the data from the input stream used during XML parsing.
#define DWFTK_EMBEDDED_FONT_HEAP_INIT   4192
 Indicates the initial size of the memory buffer to use to store the compressed font data from the embedding engine. This buffer will grow to accomodate the entire data set.
#define DWFTK_EMBEDDED_FONT_HEAP_LIMIT   65536
 Indicates the maximum amount of memory to consume with a set of embedded font data. If the embedding process exceeds this threshhold, the font data will be flushed to disk (in a temporary file) in order to reduce the memory overhead of the publishing process.
#define DWFTK_READ_ONLY
 Indicates that the library will exclude any writing code.
#define BSTREAM_READONLY
 Indicates that the library will exclude any writing code.


Define Documentation

#define BSTREAM_READONLY
 

Indicates that the library will exclude any writing code.

This macro is provided by the HSF code used by the W3D Toolkit. It is automatically defined when DWFTK_READ_ONLY is defined.

Definition at line 142 of file preprocessor.txt.

#define DWFTK_BUILD_EXPAT
 

Indicates Expat XML parser will be built into the library; also used by clients of the library with Expat built-in.

Note:
If this macro is defined and Expat is compiled into the library, it is highly recommended (and usually required) that client code also define this macro to ensure the proper header is found at build time.
The DWF Toolkit depends on the Expat XML parsing library and ships with a copy of this library. If this macro is defined, a version of Expat (currently 1.95.7) will be compiled into the library. However, it may be desirable to take advantage of a newer or previously installed version. In this case, Expat must be linked in explicitly by consumers of the DWF Tookit.

Definition at line 79 of file preprocessor.txt.

#define DWFTK_BUILD_JPEG
 

Indicates the JPEG Library (libjpeg) will be built into the library; also used by clients of the libary with libjpeg built-in.

Note:
If this macro is defined and libjpeg is compiled into the library, it is highly recommended (and usually required) that client code also define this macro to ensure the proper header is found at build time.
The DWF Toolkit may optionally use libjpeg for inline image compression for 3D DWF. However, since it is preferrable to add images (including texture images) as DWF resources rather than embedding them in the W3D stream itself, this library is rarely used. Defining this macro will cause the JPEG-enabled code in the DWF 3D toolkit to use the local header instead of the system header.

Definition at line 95 of file preprocessor.txt.

#define DWFTK_READ_ONLY
 

Indicates that the library will exclude any writing code.

Read-only shared libraries are advantageous for applications (viewers) and components (text search, object counting, etc.) that are constrained by distribution size and have no publishing requirements. It is also required for any client linking to a read-only toolkit.

Defining this macro will also automatically define BSTREAM_READONLY.

Definition at line 134 of file preprocessor.txt.


Generated on Tue Jan 6 22:40:21 2009 for Autodesk DWF Toolkit by  doxygen 1.4.5