discard.lua 822 B

1234567891011121314151617181920212223242526272829303132
  1. return {
  2. tag = 'graphicsPrimitives',
  3. summary = 'Discard the current pixel values.',
  4. description = [[
  5. Discards pixel information in the active Canvas or display. This is mostly used as an
  6. optimization hint for the GPU, and is usually most helpful on mobile devices.
  7. ]],
  8. arguments = {
  9. {
  10. name = 'color',
  11. type = 'boolean',
  12. default = 'true',
  13. description = 'Whether or not to discard color information.'
  14. },
  15. {
  16. name = 'depth',
  17. type = 'boolean',
  18. default = 'true',
  19. description = 'Whether or not to discard depth information.'
  20. },
  21. {
  22. name = 'stencil',
  23. type = 'boolean',
  24. default = 'true',
  25. description = 'Whether or not to discard stencil information.'
  26. }
  27. },
  28. returns = {},
  29. related = {
  30. 'lovr.graphics.clear'
  31. }
  32. }