Browse Source

Document Sound:getBlob data type;

bjorn 4 years ago
parent
commit
5ad2c9d9f5
1 changed files with 4 additions and 0 deletions
  1. 4 0
      api/lovr/data/Sound/getBlob.lua

+ 4 - 0
api/lovr/data/Sound/getBlob.lua

@@ -9,6 +9,10 @@ return {
       description = 'The Blob instance containing the bytes for the `Sound`.'
     }
   },
+  notes = [[
+    Samples for each channel are stored interleaved.  The data type of each sample is given by
+    `Sound:getFormat`.
+  ]],
   related = {
     'Blob:getPointer',
     'Image:getBlob'