Skip to content

Commit 28a0499

Browse files
committed
doc(browser_io): Add writeArrayBuffer docs
1 parent 405af96 commit 28a0499

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

doc/content/api/browser_io.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,15 @@ Read an image or mesh from a [Blob](https://developer.mozilla.org/en-US/docs/Web
2424

2525
Read an image or mesh from an [ArrayBuffer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer). `fileName` is a string with the file name. `mimeType` is an optional mime-type string.
2626

27+
## writeArrayBuffer(webWorker, useCompression, imageOrMesh, fileName, mimeType) -> { webWorker, [arrayBuffer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer) }
28+
29+
Write an image or mesh to a an [ArrayBuffer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer).
30+
31+
*useCompression*: compress the pixel data when possible
32+
*imageOrMesh*: [itk/Image](./Image.html) or [itk/Mesh](./Mesh.html) instance to write
33+
*fileName*: name that would be used for the resulting file
34+
*mimeType*: optional mime-type for the resulting file
35+
2736
---
2837

2938
## readImageFile(webWorker, file) -> { webWorker, [image](./Image.html) }

0 commit comments

Comments
 (0)