lovr-indeck/lovr-api/graphics/Pass/getTallyBuffer.lua

return {
  tag = 'tally',
  summary = 'Get the Buffer that tally results will be written to.',
  description = [[
    Returns the Buffer that tally results will be written to.  Each time the render pass finishes,
    the results of all the tallies will be copied to the Buffer at the specified offset.  The buffer
    can be used in a later pass in a compute shader, or the data in the buffer can be read back
    using e.g. `Buffer:newReadback`.

    If no buffer has been set, this function will return `nil`.
  ]],
  arguments = {},
  returns = {
    buffer = {
      type = 'Buffer',
      description = 'The buffer.'
    },
    offset = {
      type = 'number',
      description = 'An offset in the buffer where results will be written.'
    }
  },
  variants = {
    {
      arguments = {},
      returns = { 'buffer', 'offset' }
    }
  },
  related = {
    'Pass:beginTally',
    'Pass:finishTally'
  }
}