getBackgroundColor.lua 768 B

12345678910111213141516171819202122232425262728293031
  1. return {
  2. tag = 'graphicsState',
  3. summary = 'Get the background color.',
  4. description = [[
  5. Returns the current background color. Color components are from 0.0 to 1.0.
  6. ]],
  7. arguments = {},
  8. returns = {
  9. {
  10. name = 'r',
  11. type = 'number',
  12. description = 'The red component of the background color.'
  13. },
  14. {
  15. name = 'g',
  16. type = 'number',
  17. description = 'The green component of the background color.'
  18. },
  19. {
  20. name = 'b',
  21. type = 'number',
  22. description = 'The blue component of the background color.'
  23. },
  24. {
  25. name = 'a',
  26. type = 'number',
  27. description = 'The alpha component of the background color.'
  28. }
  29. },
  30. notes = 'The default background color is `(0.0, 0.0, 0.0, 1.0)`.'
  31. }