unhide J API
Change-Id: Ied1465f2b4a237b9724caa5fc1dcc6f3d22640ac
diff --git a/scriptc/rs_element.rsh b/scriptc/rs_element.rsh
index 1a4cdb7..0230f10 100644
--- a/scriptc/rs_element.rsh
+++ b/scriptc/rs_element.rsh
@@ -23,9 +23,15 @@
#ifndef __RS_ELEMENT_RSH__
#define __RS_ELEMENT_RSH__
+// New API's
#if (defined(RS_VERSION) && (RS_VERSION >= 16))
/**
+ * Elements could be simple, such as an int or a float, or a
+ * structure with multiple sub elements, such as a collection of
+ * floats, float2, float4. This function returns zero for simple
+ * elements or the number of sub-elements otherwise.
+ *
* @param e element to get data from
* @return number of sub-elements in this element
*/
@@ -33,6 +39,9 @@
rsElementGetSubElementCount(rs_element e);
/**
+ * For complex elements, this function will return the
+ * sub-element at index
+ *
* @param e element to get data from
* @param index index of the sub-element to return
* @return sub-element in this element at given index
@@ -41,6 +50,9 @@
rsElementGetSubElement(rs_element, uint32_t index);
/**
+ * For complex elements, this function will return the length of
+ * sub-element name at index
+ *
* @param e element to get data from
* @param index index of the sub-element to return
* @return length of the sub-element name including the null
@@ -50,6 +62,9 @@
rsElementGetSubElementNameLength(rs_element e, uint32_t index);
/**
+ * For complex elements, this function will return the
+ * sub-element name at index
+ *
* @param e element to get data from
* @param index index of the sub-element
* @param name array to store the name into
@@ -61,6 +76,10 @@
rsElementGetSubElementName(rs_element e, uint32_t index, char *name, uint32_t nameLength);
/**
+ * For complex elements, some sub-elements could be statically
+ * sized arrays. This function will return the array size for
+ * sub-element at index
+ *
* @param e element to get data from
* @param index index of the sub-element
* @return array size of sub-element in this element at given
@@ -70,6 +89,9 @@
rsElementGetSubElementArraySize(rs_element e, uint32_t index);
/**
+ * This function specifies the location of a sub-element within
+ * the element
+ *
* @param e element to get data from
* @param index index of the sub-element
* @return offset in bytes of sub-element in this element at
@@ -79,13 +101,17 @@
rsElementGetSubElementOffsetBytes(rs_element e, uint32_t index);
/**
+ * Returns the size of element in bytes
+ *
* @param e element to get data from
* @return total size of the element in bytes
*/
extern uint32_t __attribute__((overloadable))
- rsElementGetSizeBytes(rs_element e);
+ rsElementGetBytesSize(rs_element e);
/**
+ * Returns the element's data type
+ *
* @param e element to get data from
* @return element's data type
*/
@@ -93,6 +119,8 @@
rsElementGetDataType(rs_element e);
/**
+ * Returns the element's data kind
+ *
* @param e element to get data from
* @return element's data size
*/
@@ -100,6 +128,8 @@
rsElementGetDataKind(rs_element e);
/**
+ * Returns the element's vector size
+ *
* @param e element to get data from
* @return length of the element vector (for float2, float3,
* etc.)