getCanvas.lua 536 B

123456789101112131415161718192021
  1. return {
  2. tag = 'graphicsState',
  3. summary = 'Get the active Canvas.',
  4. description = [[
  5. Returns the active Canvas. Usually when you render something it will render directly to the
  6. headset. If a Canvas object is active, things will be rendered to the textures attached to the
  7. Canvas instead.
  8. ]],
  9. arguments = {},
  10. returns = {
  11. {
  12. name = 'canvas',
  13. type = 'Canvas',
  14. description = 'The active Canvas, or `nil` if no canvas is set.'
  15. }
  16. },
  17. related = {
  18. 'Canvas:renderTo',
  19. 'Canvas'
  20. }
  21. }