setDisplayFrequency.lua 673 B

12345678910111213141516171819202122232425262728
  1. return {
  2. deprecated = true,
  3. tag = 'headset',
  4. summary = 'Set the display refresh rate.',
  5. description = 'Sets the display refresh rate, in Hz.',
  6. arguments = {
  7. frequency = {
  8. type = 'number',
  9. description = 'The new refresh rate, in Hz.',
  10. }
  11. },
  12. returns = {
  13. success = {
  14. type = 'boolean',
  15. description = 'Whether the display refresh rate was successfully set.'
  16. }
  17. },
  18. variants = {
  19. {
  20. arguments = { 'frequency' },
  21. returns = { 'success' }
  22. }
  23. },
  24. notes = [[
  25. Changing the display refresh-rate also changes the frequency of lovr.update() and lovr.draw() as
  26. they depend on the display frequency.
  27. ]]
  28. }