From fd19413196cddda5ad624665b40d90a30dd15a1f Mon Sep 17 00:00:00 2001 From: Mathieu Malaterre Date: Thu, 25 Oct 2012 08:44:27 +0000 Subject: [PATCH] [trunk] Add documentation for stable API/ABI and gcc flags on UNIX --- README | 13 +++++++++++++ 1 file changed, 13 insertions(+) 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.