/src/FreeImage/Source/LibMNG/README.config

https://bitbucket.org/cabalistic/ogredeps/ · ASP.NET · 104 lines · 72 code · 32 blank · 0 comment · 8 complexity · 5c9f91f804c21e49417455a817adee9b MD5 · raw file

  1. Configuration options in libmng
  2. ===============================
  3. The library is fairly configurable through the use of a number of defines.
  4. Please note however that certain defines are for internal use only.
  5. The following list gives a summary of options that can be used externally to
  6. define the functionality of the library:
  7. ========================================
  8. #define MNG_BUILD_DLL
  9. This is used to indicate that a "standard" DLL should result from compiling
  10. the library. Please note the remarks in README.dll if you intend to work
  11. with the library as a DLL. The purpose of this option is to ensure that
  12. DLL builds have the same set of functions.
  13. #define MNG_BUILD_SO
  14. This is used to indicate that a "standard" shared library (SO) should result
  15. from a compilation. The purpose of this option is to ensure that all
  16. shared libraries generated this way will have the same set of functions.
  17. #define MNG_USE_DLL / #define MNG_USE_SO
  18. These should be used when including the library header in the compilation
  19. of an application to indicate that the compiler/linker must take the
  20. necessary steps to make the binary executable to use the standard DLL
  21. or shared library (SO).
  22. #define MNG_SKIP_ZLIB / #define MNG_SKIP_LCMS / #define MNG_SKIP_IJG6B
  23. Use these in conjunction with MNG_USE_DLL / MNG_USE_SO. This is useful if
  24. you only need the external definitions of the MNG library and not the others,
  25. which will speed up the compilation process.
  26. #define MNG_SUPPORT_FULL / #define MNG_SUPPORT_LC / #define MNG_SUPPORT_VLC
  27. These can be used to indicate the level of MNG spec compliance required.
  28. Currently only full MNG compliance is supported.
  29. #define MNG_SUPPORT_IJG6B
  30. This can be used to indicate if JNG support is required. This option will
  31. include the IJG JPEG-library. Note that MNG_SUPPORT_FULL will automatically
  32. set this option. Use this only if you need JNG support with MNG-(V)LC.
  33. #define MNG_FULL_CMS / #define MNG_GAMMA_ONLY / #define MNG_NO_CMS /
  34. #define MNG_APP_CMS
  35. These indicate the color-correction support level of the library.
  36. If you are on a platform that supports lcms (Little CMS by Marti Maria Saguar)
  37. then it is highly recommended to define MNG_FULL_CMS.
  38. If your platform has it's own CMS then select MNG_APP_CMS and be sure to
  39. include the appropriate callbacks in your app.
  40. In all other cases it is recommended to define MNG_GAMMA_ONLY.
  41. #define MNG_SUPPORT_READ / #define MNG_SUPPORT_WRITE /
  42. #define MNG_SUPPORT_DISPLAY
  43. These indicate the high-level support for reading, writing and/or
  44. displaying files. Note that in order to display a file, you'll need to read
  45. it first. (yes, really!)
  46. #define MNG_STORE_CHUNKS
  47. This indicates that the library should store chunk-information when reading
  48. a file. This information can then be processed through the
  49. MNG_ITERATE_CHUNKS() function. Note that you must specify this option if
  50. you want to create and write a new file.
  51. #define MNG_ACCESS_CHUNKS
  52. This is used to indicate that the app may need access to internally stored
  53. chunk information. MNG_STORE_CHUNKS must be defined as well for this option
  54. to function properly.
  55. #define MNG_INTERNAL_MEMMNGMT
  56. You can use this to have the library handle it's own memory allocation and
  57. deallocation through the "standard" memory functions. This option is turned
  58. off by default, which means your app must define the memory callbacks.
  59. #define MNG_ERROR_TELLTALE
  60. Set this on to allow human-readable error-messages to be included in the
  61. library and the error function and callback.
  62. #define MNG_BIGENDIAN_SUPPORTED
  63. This option should be used to indicate the hardware is based on big endian
  64. integers.
  65. #define MNG_SUPPORT_TRACE / #define MNG_TRACE_TELLTALE
  66. These two can be used when debugging an app. You'll need to have the trace
  67. callback setup also. This allows for a rather thorough investigation of the
  68. libraries function paths.
  69. ========================================
  70. Any other optional defines you may encounter are for internal use only.
  71. please do not specify them externally. In case of doubt, consult the
  72. support email lists. More info can be found on http://www.libmng.com