lovr-indeck/lovr-api/graphics/Readback/wait.lua

return {
  summary = 'Wait for the Readback to finish.',
  description = 'Blocks the CPU until the Readback is finished on the GPU.',
  arguments = {},
  returns = {
    waited = {
      type = 'boolean',
      description = 'Whether the CPU had to be blocked for waiting.'
    }
  },
  variants = {
    {
      arguments = {},
      returns = { 'waited' }
    }
  },
  notes = [[
    If `lovr.graphics.submit` or `lovr.graphics.wait` has not been called since the readback was
    created, the readback has not been submitted yet, so no wait will occur and this function will
    return `false`.
  ]]
}