getColorMask.lua 807 B

1234567891011121314151617181920212223242526272829303132
  1. return {
  2. tag = 'graphicsState',
  3. summary = 'Get the color mask.',
  4. description = [[
  5. Returns the active color channels. If a color channel is active, then drawing operations will
  6. affect that particular channel.
  7. ]],
  8. arguments = {},
  9. returns = {
  10. {
  11. name = 'r',
  12. type = 'boolean',
  13. description = 'Whether or not the red channel is enabled.'
  14. },
  15. {
  16. name = 'g',
  17. type = 'boolean',
  18. description = 'Whether or not the green channel is enabled.'
  19. },
  20. {
  21. name = 'b',
  22. type = 'boolean',
  23. description = 'Whether or not the blue channel is enabled.'
  24. },
  25. {
  26. name = 'a',
  27. type = 'boolean',
  28. description = 'Whether or not the alpha channel is enabled.'
  29. }
  30. },
  31. notes = 'Initially, all color channels are enabled.'
  32. }