瀏覽代碼

Update README.md

Garrett Johnson 4 年之前
父節點
當前提交
4354efbc25
共有 1 個文件被更改,包括 6 次插入0 次删除
  1. 6 0
      README.md

+ 6 - 0
README.md

@@ -524,6 +524,8 @@ Function to derive the job priority of the given item. Higher priority values ge
 getKeys() : Array<String>
 ```
 
+Returns the keys of all the data in the batch table.
+
 ### getData
 ```js
 getData(
@@ -533,6 +535,10 @@ getData(
 ) : Array|TypedArray
 ```
 
+Returns the data associated with the `key` passed into the function. If the component and type are specified in the batch table contents then those values are used otherwise the values in `defaultComponentType` and `defaultType` are used.
+
+`defaultComponentType` can be set to `BYTE`, `UNSIGNED_BYTE`, `SHORT`, `UNSIGNED_SHORT`, `INT`, `UNSIGNED_INT`, `FLOAT`, or `DOUBLE`. `defaultType` can be set to `SCALAR`, `VEC2`, `VEC3`, or `VEC4`.
+
 # LICENSE
 
 The software is available under the [Apache V2.0 license](../LICENSE.txt).