Buffer:getData

Edit

Downloads the Buffer's data from VRAM and returns it as a table.

t = Buffer:getData(index, count)

Notes

This function is very slow, because it stalls the CPU until the data has finished downloading from the GPU. The stall can be avoided be calling this function in a task, which will put the task to sleep until the data is ready. See lovr.task for more details.

The length of the table will equal the number of items read. Here are some examples of how the table is formatted:

buffer = lovr.graphics.newBuffer('int', { 7 })
buffer:getData() --> returns { 7 }

buffer = lovr.graphics.newBuffer('vec3', { 7, 8, 9 })
buffer:getData() --> returns {{ 7, 8, 9 }}

buffer = lovr.graphics.newBuffer('int', { 1, 2, 3 })
buffer:getData() --> returns { 1, 2, 3 }

buffer = lovr.graphics.newBuffer({ 'vec2', 'vec2' }, {
  vec2(1,2), vec2(3,4),
  vec2(5,6), vec2(7,8)
})
buffer:getData() --> returns { { 1, 2, 3, 4 }, { 5, 6, 7, 8 } }

buffer = lovr.graphics.newBuffer({
  { 'a', 'float' },
  { 'b', 'float' }
}, { a = 1, b = 2 })
buffer:getData() --> returns { { 1, 2 } }

buffer = lovr.graphics.newBuffer({
  { 'x', 'int', 3 }
}, { x = { 1, 2, 3 } })
buffer:getData() --> returns { { x = { 1, 2, 3 } } }

buffer = lovr.graphics.newBuffer({
  { 'lights', {
    { 'pos', 'vec3' },
    { 'size', 'float' },
  }, 10}
}, data)
buffer:getData() --> returns { { lights = { { pos = ..., size = ... }, ... } } }

In summary, each individual item is wrapped in a table, except if the format is a single number. If the format has nested types or arrays then the tables will be key-value, otherwise they will use numeric keys.

See also

• Buffer:newBlob
• Texture:getPixels
• Buffer:setData
• Buffer