aboutsummaryrefslogtreecommitdiffstats
path: root/include
diff options
context:
space:
mode:
authorAndrew Hannam <andrewh@inmarket.com.au>2013-01-17 17:47:51 +1000
committerAndrew Hannam <andrewh@inmarket.com.au>2013-01-17 17:47:51 +1000
commit5b444276ae427091d7c413eb297a909f0a9472b3 (patch)
tree8642fbc5b7b56fe1803baa0d59e06d3b61b88944 /include
parent1fc03db5861c232792042844c15153a7e1bcc724 (diff)
downloaduGFX-5b444276ae427091d7c413eb297a909f0a9472b3.tar.gz
uGFX-5b444276ae427091d7c413eb297a909f0a9472b3.tar.bz2
uGFX-5b444276ae427091d7c413eb297a909f0a9472b3.zip
Implement GMISC Array Operations
Diffstat (limited to 'include')
-rw-r--r--include/gmisc/gmisc.h6
1 files changed, 6 insertions, 0 deletions
diff --git a/include/gmisc/gmisc.h b/include/gmisc/gmisc.h
index 0cce12bd..c68e5ca2 100644
--- a/include/gmisc/gmisc.h
+++ b/include/gmisc/gmisc.h
@@ -69,6 +69,12 @@ extern "C" {
*
* @note Assumes the destination buffer is large enough for the resultant data.
* @note This routine is optimised to perform as fast as possible.
+ * @note No type checking is performed on the source format. It is assumed to
+ * have only valid values eg. ARRAY_DATA_4BITSIGNED will have values
+ * 0000 -> 0111 for positive numbers and 1111 -> 1000 for negative numbers
+ * Bits 5 -> 8 in the storage byte are treated in an undefined manner.
+ * @note If srcfmt or dstfmt is an unknown format, this routine does nothing
+ * with no warning that something is wrong
*
* @api
*/