summaryrefslogtreecommitdiffstats
path: root/renderscript/include/rs_vector_math.rsh
diff options
context:
space:
mode:
Diffstat (limited to 'renderscript/include/rs_vector_math.rsh')
-rw-r--r--renderscript/include/rs_vector_math.rsh17
1 files changed, 14 insertions, 3 deletions
diff --git a/renderscript/include/rs_vector_math.rsh b/renderscript/include/rs_vector_math.rsh
index d82cd69..8ad2cbf 100644
--- a/renderscript/include/rs_vector_math.rsh
+++ b/renderscript/include/rs_vector_math.rsh
@@ -14,13 +14,24 @@
* limitations under the License.
*/
-// Don't edit this file! It is auto-generated by frameworks/rs/api/gen_runtime.
+// Don't edit this file! It is auto-generated by frameworks/rs/api/generate.sh.
/*
- * rs_vector_math.rsh: TODO Add documentation
+ * rs_vector_math.rsh: Vector Math Functions
+ *
+ * These functions interpret the input arguments as representation of vectors in n-dimensional space.
+ *
+ * The precision of the mathematical operations is affected by the pragmas
+ * rs_fp_relaxed and rs_fp_full.
+ *
+ * Different precision/speed tradeoffs can be achieved by using three variants
+ * of common math functions. Functions with a name starting with
+ * - native_ may have custom hardware implementations with weaker precision,
+ * - half_ may perform internal computations using 16 bit floats, and
+ * - fast_ are n-dimensional space computations that may use 16 bit floats.
*
- * TODO Add documentation
*/
+
#ifndef RENDERSCRIPT_RS_VECTOR_MATH_RSH
#define RENDERSCRIPT_RS_VECTOR_MATH_RSH