getClipDistance.lua 858 B

12345678910111213141516171819202122232425262728293031
  1. return {
  2. tag = 'headset',
  3. summary = 'Get the near and far clipping planes of the headset.',
  4. description = [[
  5. Returns the near and far clipping planes used to render to the headset. Objects closer than the
  6. near clipping plane or further than the far clipping plane will be clipped out of view.
  7. ]],
  8. arguments = {},
  9. returns = {
  10. near = {
  11. type = 'number',
  12. description = 'The distance to the near clipping plane, in meters.'
  13. },
  14. far = {
  15. type = 'number',
  16. description = [[
  17. The distance to the far clipping plane, in meters, or 0 for an infinite far clipping plane
  18. with a reversed Z range.
  19. ]]
  20. }
  21. },
  22. variants = {
  23. {
  24. arguments = {},
  25. returns = { 'near', 'far' }
  26. }
  27. },
  28. notes = [[
  29. The default near and far clipping planes are 0.01 meters and 0.0 meters.
  30. ]]
  31. }