Blobs;

Author: bjornbytes

docs/Blob.md

@@ -0,0 +1,42 @@
+<!--
+category: reference
+-->
+
+Blob
+===
+
+A Blob is an object that represents the contents of a file.  It can be passed to most functions that
+create objects from file data, such as `lovr.graphics.newModel` and `lovr.audio.newSource`.  Loading
+many objects in this way is often faster because the file data only needs to be read once and can be
+reused.  It can also be useful if file data is retrieved from some non-filesystem source, such as a
+network request.
+
+Functions
+---
+
+<table>
+<tr>
+  <td class="pre">lovr.filesystem.newBlob</td>
+  <td>Create a Blob from a file or raw data.</td>
+</tr>
+
+<tr>
+  <td class="pre">Blob:getFilename</td>
+  <td>Return the name of the file used to load the Blob (or the user-defined name).</td>
+</tr>
+
+<tr>
+  <td class="pre">Blob:getPointer</td>
+  <td>Return a raw pointer to the Blob's data.</td>
+</tr>
+
+<tr>
+  <td class="pre">Blob:getSize</td>
+  <td>Return the size of the Blob's data, in bytes.</td>
+</tr>
+
+<tr>
+  <td class="pre">Blob:getString</td>
+  <td>Return a string containing the binary blob data.</td>
+</tr>
+</table>

docs/Blob:getFilename.md

@@ -0,0 +1,19 @@
+<!--
+category: reference
+-->
+
+Blob:getFilename
+===
+
+Returns the name of the file used to load the Blob, or the custom name given to it when it was
+created.
+
+    filename = blob:getFilename()
+
+### Arguments
+
+None
+
+### Returns
+
+- `string filename` The name of the Blob.

docs/Blob:getPointer.md

@@ -0,0 +1,19 @@
+<!--
+category: reference
+-->
+
+Blob:getPointer
+===
+
+Returns a raw pointer to the Blob's data.  This can be used to interface with other C libraries
+using the LuaJIT FFI.  Use this only if you know what you're doing!
+
+    pointer = blob:getPointer()
+
+### Arguments
+
+None
+
+### Returns
+
+- `userdata pointer` A pointer to the data.

docs/Blob:getSize.md

@@ -0,0 +1,18 @@
+<!--
+category: reference
+-->
+
+Blob:getSize
+===
+
+Get the size of a Blob's data in bytes.
+
+    bytes = blob:getSize()
+
+### Arguments
+
+None
+
+### Returns
+
+- `number bytes` The size of the data.

docs/Blob:getString.md

@@ -0,0 +1,28 @@
+<!--
+category: reference
+-->
+
+Blob:getString
+===
+
+Get the binary data of the Blob.
+
+    data = blob:getString()
+
+### Arguments
+
+None
+
+### Returns
+
+- `string data` The Blob data.
+
+Example
+---
+
+Manually copy a file using Blobs:
+
+```
+blob = lovr.filesystem.newBlob('image.png')
+lovr.filesystem.write('copy.png', blob:getString())
+```

docs/lovr.filesystem.newBlob.md

@@ -0,0 +1,42 @@
+<!--
+category: reference
+-->
+
+lovr.filesystem.newBlob
+===
+
+Creates a new Blob.  A Blob is an object that represents the contents of a file.  It can be passed
+to most functions that create objects from file data, such as `lovr.graphics.newModel` and
+`lovr.audio.newSource`.  Loading many objects in this way is often faster because the file data
+only needs to be read once and can be reused.  It can also be useful if file data is retrieved from
+some non-filesystem source, such as a network request.
+
+---
+
+    blob = lovr.filesystem.newBlob(filename)
+
+### Arguments
+
+- `string filename` The file to load.
+
+### Returns
+
+- `Blob blob` The new Blob.
+
+---
+
+    blob = lovr.filesystem.newBlob(str, name)
+
+### Arguments
+
+- `string str` The contents of the Blob.
+- `string name` A name for the Blob (used for error messages).
+
+### Returns
+
+- `Blob blob` A new Blob.
+
+See also
+---
+
+- `Blob`