summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMathieu Malaterre <mathieu.malaterre@gmail.com>2012-10-25 08:44:27 +0000
committerMathieu Malaterre <mathieu.malaterre@gmail.com>2012-10-25 08:44:27 +0000
commitfd19413196cddda5ad624665b40d90a30dd15a1f (patch)
tree43fef0e5ec43669db12e8d98cbeb3183c6428979
parent6300a8a0a2206ff6771b05263fbaa870ef7e109a (diff)
[trunk] Add documentation for stable API/ABI and gcc flags on UNIX
-rw-r--r--README13
1 files changed, 13 insertions, 0 deletions
diff --git a/README b/README
index 58e12902..0a891782 100644
--- a/README
+++ b/README
@@ -32,3 +32,16 @@ see LICENSE for license and copyright information.
see INSTALL for installation procedures.
see NEWS for user visible changes in successive releases.
see CHANGES for per-revision changes.
+
+----------------
+API/ABI
+
+OpenJPEG strives to provide a stable API/ABI for your applications. As such it
+only exposes a limited subset of its functions. It uses a mecanism of
+exporting/hiding functions. If you are unsure which functions you can use in
+your applications, you should compile OpenJPEG using something similar to gcc:
+-fvisibility=hidden compilation flag.
+See also: http://gcc.gnu.org/wiki/Visibility
+
+On windows, MSVC directly supports export/hidding function and as such the only
+API available is the one supported by OpenJPEG.