docs(tools/mesh/translateUV): add info on the range of the offset

arx-tools · Aug 13, 2023 · 835d52b · 835d52b
1 parent e88b078
commit 835d52b
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/tools/mesh/translateUV.ts b/src/tools/mesh/translateUV.ts
@@ -1,5 +1,9 @@
 import { BufferAttribute, BufferGeometry, Vector2 } from 'three'
 
+/**
+ * @param offset Vector2 with the 2 values representing X and Y axis. Both axis are expected to be
+ * floats between 0 and 1
+ */
 export const translateUV = (offset: Vector2, geometry: BufferGeometry) => {
   const uv = geometry.getAttribute('uv') as BufferAttribute