skybox.lua 777 B

123456789101112131415161718192021222324252627282930313233
  1. return {
  2. tag = 'drawing',
  3. summary = 'Draw a skybox.',
  4. description = 'Draws a skybox.',
  5. arguments = {
  6. skybox = {
  7. type = 'Texture',
  8. description = [[
  9. The skybox to render. Its `TextureType` can be `cube` to render as a cubemap, or `2d` to
  10. render as an equirectangular (spherical) 2D image.
  11. ]]
  12. }
  13. },
  14. returns = {},
  15. variants = {
  16. {
  17. arguments = { 'skybox' },
  18. returns = {}
  19. },
  20. {
  21. arguments = {},
  22. returns = {}
  23. }
  24. },
  25. notes = [[
  26. The skybox will be rotated based on the camera rotation.
  27. The skybox is drawn using a fullscreen triangle.
  28. The skybox uses a custom shader, so set the shader to `nil` before calling this function (unless
  29. explicitly using a custom shader).
  30. ]]
  31. }