summaryrefslogtreecommitdiff
path: root/include/opus_defines.h
diff options
context:
space:
mode:
authorTimothy B. Terriberry <tterribe@xiph.org>2015-02-20 12:44:10 -0800
committerTimothy B. Terriberry <tterribe@xiph.org>2015-02-20 12:44:10 -0800
commit75d81f5bb3705135a0259be0e9602820f1c6cb5c (patch)
tree34f57559d9d1ceac94522ca378f2f04db4a03103 /include/opus_defines.h
parent45cbdff36f0d0c2a395326d09e4dd375601e28cb (diff)
downloadopus-75d81f5bb3705135a0259be0e9602820f1c6cb5c.tar.gz
Document how to tell if your build is fixed-point.
This way we won't break this by accident.
Diffstat (limited to 'include/opus_defines.h')
-rw-r--r--include/opus_defines.h4
1 files changed, 4 insertions, 0 deletions
diff --git a/include/opus_defines.h b/include/opus_defines.h
index 32b7c976..41e81f08 100644
--- a/include/opus_defines.h
+++ b/include/opus_defines.h
@@ -714,6 +714,10 @@ OPUS_EXPORT const char *opus_strerror(int error);
/** Gets the libopus version string.
*
+ * Applications may look for the substring "-fixed" in the version string to
+ * determine whether they have a fixed-point or floating-point build at
+ * runtime.
+ *
* @returns Version string
*/
OPUS_EXPORT const char *opus_get_version_string(void);